Skip to content

Spoolman

Module: spoolman (optional) API Endpoint: POST /server/spoolman/proxyGET /v1/spoolSpoolman is a filament spool manager that Moonraker can proxy. This module exposes metrics for each spool tracked in Spoolman, including remaining and used filament weight and length, as well as Spoolman connection status and active spool tracking.

Spool data is fetched through Moonraker's Spoolman proxy using the v2 response format with use_v2_response: true. Connection status and active spool info are fetched from the /server/spoolman/status endpoint.

Status Metrics

MetricTypeDescription
klipper_spoolman_connectedGaugeSpoolman connection status (1=connected, 0=disconnected)
klipper_spoolman_active_spool_idGaugeCurrently active spool ID (-1 if no spool is active)
klipper_spoolman_pending_reportsGaugeNumber of pending filament usage reports not yet sent to Spoolman

Per-Spool Metrics

MetricTypeLabelsDescription
klipper_spoolman_spool_infoGauge=1spool_id, filament_name, material, color, vendorSpool information (always 1)
klipper_spoolman_remaining_weightGaugespool_idRemaining filament weight on the spool (grams)
klipper_spoolman_used_weightGaugespool_idUsed filament weight from the spool (grams)
klipper_spoolman_remaining_lengthGaugespool_idRemaining filament length on the spool (mm)
klipper_spoolman_used_lengthGaugespool_idUsed filament length from the spool (mm)

Example PromQL

promql
# Show all spools with their filament names
klipper_spoolman_spool_info

# Remaining weight for a specific spool
klipper_spoolman_remaining_weight{spool_id="1"}

# Spools with less than 100g remaining
klipper_spoolman_remaining_weight < 100

Released under the MIT License.