Metrics Reference
This page provides a summary of all metrics exported by the Prometheus Klipper Exporter. Each metric module links to a detailed reference page.
Modules Overview
| Module | Default | API Endpoint | Metrics |
|---|---|---|---|
cfs | /printer/objects/query | 15 | |
device_power | ✓ | /machine/device_power | 3 |
directory_info | /server/files/directory | 3 | |
history | /server/history/totals | 10 | |
job_queue | ✓ | /server/job_queue/status | 2 |
mmu | /printer/objects/query | 50+ | |
network_stats | /machine/proc_stats | 9 | |
printer_objects | /printer/objects/query | 96+ | |
process_stats | ✓ | /machine/proc_stats | 11 |
query_endstops | ✓ | /printer/query_endstops | 1 |
server_info | ✓ | /server/info | 6 |
spoolman | /server/spoolman/status, POST /server/spoolman/proxy → GET /v1/spool | 8 | |
system_info | ✓ | /machine/system_info | 4 |
Default Modules
When no modules are specified in the Prometheus configuration, the following default modules are enabled: server_info, process_stats, job_queue, system_info, query_endstops, device_power.
All Metrics by Module
process_stats
| Metric | Type | Labels |
|---|---|---|
klipper_moonraker_cpu_usage | Gauge | |
klipper_moonraker_memory_kb | Gauge | |
klipper_moonraker_websocket_connections | Gauge | |
klipper_system_cpu | Gauge | |
klipper_system_cpu_temp | Gauge | |
klipper_system_memory_available | Gauge | |
klipper_system_memory_total | Gauge | |
klipper_system_memory_used | Gauge | |
klipper_system_uptime | Counter | |
klipper_system_throttled_bits | Gauge | |
klipper_system_throttled_flag_info | Gauge=1 | flag |
server_info
| Metric | Type | Labels |
|---|---|---|
klipper_klippy_connected | Gauge | |
klipper_klippy_state_info | Gauge=1 | state |
klipper_component_info | Gauge=1 | component |
klipper_component_failed_info | Gauge=1 | failed_component |
klipper_moonraker_version_info | Gauge=1 | version |
klipper_api_version_info | Gauge=1 | version |
network_stats
| Metric | Type | Labels |
|---|---|---|
klipper_network_rx_bytes | Counter | interface |
klipper_network_tx_bytes | Counter | interface |
klipper_network_rx_packets | Counter | interface |
klipper_network_tx_packets | Counter | interface |
klipper_network_rx_errs | Counter | interface |
klipper_network_tx_errs | Counter | interface |
klipper_network_rx_drop | Counter | interface |
klipper_network_tx_drop | Counter | interface |
klipper_network_bandwidth | Gauge | interface |
device_power
| Metric | Type | Labels |
|---|---|---|
klipper_power_device_info | Gauge=1 | device, type |
klipper_power_device_status | Gauge | device |
klipper_power_device_state_info | Gauge=1 | device, state |
spoolman
| Metric | Type | Labels |
|---|---|---|
klipper_spoolman_connected | Gauge | |
klipper_spoolman_active_spool_id | Gauge | |
klipper_spoolman_pending_reports | Gauge | |
klipper_spoolman_spool_info | Gauge=1 | spool_id, filament_name, material, color, vendor |
klipper_spoolman_remaining_weight | Gauge | spool_id |
klipper_spoolman_used_weight | Gauge | spool_id |
klipper_spoolman_remaining_length | Gauge | spool_id |
klipper_spoolman_used_length | Gauge | spool_id |
system_info
| Metric | Type | Labels |
|---|---|---|
klipper_system_cpu_count | Gauge | |
klipper_service_available | Gauge=1 | service |
klipper_service_state_info | Gauge=1 | service, state |
klipper_service_sub_state_info | Gauge=1 | service, sub_state |
job_queue
| Metric | Type | Labels |
|---|---|---|
klipper_job_queue_length | Gauge | |
klipper_job_queue_state_info | Gauge=1 | state |
directory_info
| Metric | Type | Labels |
|---|---|---|
klipper_disk_usage_available | Gauge | |
klipper_disk_usage_total | Gauge | |
klipper_disk_usage_used | Gauge |
history
| Metric | Type | Labels |
|---|---|---|
klipper_total_jobs | Gauge | |
klipper_total_time | Gauge | |
klipper_total_print_time | Gauge | |
klipper_total_filament_used | Gauge | |
klipper_longest_job | Gauge | |
klipper_longest_print | Gauge | |
klipper_current_print_first_layer_height | Gauge | |
klipper_current_print_layer_height | Gauge | |
klipper_current_print_object_height | Gauge | |
klipper_current_print_total_duration | Gauge |
printer_objects
| Object | Metrics | Labels |
|---|---|---|
controller_fan | klipper_controller_fan_rpm, klipper_controller_fan_speed | fan |
display_status | klipper_print_gcode_progress | |
extruder | klipper_extruder_power, klipper_extruder_pressure_advance, klipper_extruder_smooth_time, klipper_extruder_target, klipper_extruder_temperature | |
fan | klipper_fan_rpm, klipper_fan_speed | |
filament_sensor | klipper_filament_sensor_detected, klipper_filament_sensor_enabled | sensor |
gcode | klipper_gcode_extrude_factor, klipper_gcode_position_e, klipper_gcode_position_x, klipper_gcode_position_y, klipper_gcode_position_z, klipper_gcode_speed_factor, klipper_gcode_speed | |
generic_fan | klipper_generic_fan_rpm, klipper_generic_fan_speed | fan |
heater_bed | klipper_heater_bed_power, klipper_heater_bed_target, klipper_heater_bed_temperature | |
heater_fan | klipper_heater_fan_rpm, klipper_heater_fan_speed | fan |
heater_generic | klipper_generic_heater_power, klipper_generic_heater_target, klipper_generic_heater_temperature | heater |
idle_timeout | klipper_printing_time | |
input_shaper | klipper_input_shaper_damping_ratio_x, klipper_input_shaper_damping_ratio_y, klipper_input_shaper_frequency_x, klipper_input_shaper_frequency_y, klipper_input_shaper_type_info{axis="...",type="..."} | |
firmware_retraction | klipper_firmware_retract_length, klipper_firmware_retract_speed, klipper_firmware_unretract_extra_length, klipper_firmware_unretract_speed | |
mcu | klipper_mcu_awake, klipper_mcu_task_avg, klipper_mcu_task_stddev, klipper_mcu_clock_frequency, klipper_mcu_invalid_bytes, klipper_mcu_read_bytes, klipper_mcu_ready_bytes, klipper_mcu_receive_seq, klipper_mcu_retransmit_bytes, klipper_mcu_retransmit_seq, klipper_mcu_rto, klipper_mcu_rttvar, klipper_mcu_send_seq, klipper_mcu_stalled_bytes, klipper_mcu_srtt, klipper_mcu_write_bytes | mcu |
output_pin | klipper_output_pin_value | pin |
print_stats | klipper_print_filament_used, klipper_print_total_duration, klipper_print_state_info{state="..."}, klipper_printing | |
query_endstops | klipper_endstop_triggered | endstop |
temperature_fan | klipper_temperature_fan_speed, klipper_temperature_fan_temperature, klipper_temperature_fan_target, klipper_temperature_fan_rpm | fan |
temperature_probe | klipper_temperature_probe_temperature, klipper_temperature_probe_measured_max_temp, klipper_temperature_probe_measured_min_temp, klipper_temperature_probe_estimated_expansion | probe |
temperature_sensor | klipper_temperature_sensor_temperature, klipper_temperature_sensor_measured_max_temp, klipper_temperature_sensor_measured_min_temp | sensor |
tmc_sensor | klipper_tmc_sensor_enabled, klipper_tmc_sensor_run_current, klipper_tmc_sensor_temperature | sensor |
toolhead | klipper_toolhead_estimated_print_time, klipper_toolhead_homed_axes_info, klipper_toolhead_max_accel, klipper_toolhead_max_accel_to_decel, klipper_toolhead_max_velocity, klipper_toolhead_print_time, klipper_toolhead_square_corner_velocity, klipper_toolhead_stalls_total | |
virtual_sdcard | klipper_print_file_position, klipper_print_file_progress |
mmu
MMU (Multi-Material Unit) metrics for Happy Hare. 50+ metrics covering:
| Category | Metrics |
|---|---|
| Basic state | klipper_mmu_enabled, klipper_mmu_homed, klipper_mmu_num_gates, klipper_mmu_has_bypass, klipper_mmu_current_unit, klipper_mmu_current_tool, klipper_mmu_current_gate |
| Print state | klipper_mmu_print_state_info{state="..."} |
| Action/Operation | klipper_mmu_action_info{action="..."}, klipper_mmu_operation_info{operation="..."} |
| Filament | klipper_mmu_filament_loaded, klipper_mmu_filament_position_mm, klipper_mmu_filament_direction |
| Toolchange | klipper_mmu_toolchanges_total, klipper_mmu_last_tool, klipper_mmu_next_tool |
| Encoder | klipper_mmu_encoder_position_mm, klipper_mmu_encoder_headroom_mm, klipper_mmu_encoder_flow_rate_percent |
| Per-gate | klipper_mmu_gate_status{gate="..."}, klipper_mmu_gate_info{gate="...",material="...",color="..."} |
| Sensors | klipper_mmu_pre_gate_sensor_detected{gate="..."} |
| Machine info | klipper_mmu_machine_info{name="...",vendor="..."} |
| Active filament | klipper_mmu_active_filament_info{name="...",material="...",color="..."} |
| Sync drive | klipper_mmu_sync_drive_enabled, klipper_mmu_sync_feedback_state_info{state="..."} |
cfs
Creality Filament System (CFS) metrics for K2-class printers (native box and filament_rack objects). Use this instead of mmu on Creality hardware. 15 metrics covering:
| Category | Metrics |
|---|---|
| Box state | klipper_cfs_enabled, klipper_cfs_auto_refill_enabled, klipper_cfs_state_info{state="..."}, klipper_cfs_active_unit |
| Active slot | klipper_cfs_active_slot{unit="..."}, klipper_cfs_active_slot_info{unit="...",slot="...",material="...",color="..."} |
| Per-unit | klipper_cfs_unit_temperature_celsius{unit="..."}, klipper_cfs_unit_humidity_percent{unit="..."}, klipper_cfs_unit_info{...} |
| Per-slot | klipper_cfs_slot_info{unit="...",slot="...",material="...",color="...",vendor="..."}, klipper_cfs_slot_remaining{unit="...",slot="..."} |
| Filament rack | klipper_cfs_rack_loaded_info{material="...",color="..."}, klipper_cfs_rack_velocity |
query_endstops
| Metric | Type | Labels |
|---|---|---|
klipper_endstop_triggered | Gauge | endstop |
Prometheus Metric Types
- Gauge: An instantaneous value that can go up or down (temperature, fan speed, queue length)
- Counter: A monotonically increasing value (uptime, total jobs)
- Gauge=1 (Info): A gauge with value 1 and a label carrying the state value (e.g.
klipper_print_state_info{state="printing"} 1)