mirror of
https://github.com/tcivie/meshtastic-metrics-exporter.git
synced 2024-12-26 22:19:46 -08:00
Update README.md
This commit is contained in:
Gleb Tcivie
GitHub
parent
77496d9b75
commit
d72f4b744d
117
README.md
117
README.md
|
|
@ -14,65 +14,72 @@ start creating dashboards immediately.
|
|||
|
||||
## Exported Metrics
|
||||
|
||||
🏷️ Common Labels: `node_id, short_name, long_name, hardware_model, role`
|
||||
|
||||
Label Notation:
|
||||
- 🏷️: Indicates that all common labels are used.
|
||||
- 🏷️ (source): Indicates that all common labels are used, prefixed with "source_" (e.g., source_node_id, source_short_name, etc.).
|
||||
- 🏷️ (destination): Indicates that all common labels are used, prefixed with "destination_" (e.g., destination_node_id, destination_short_name, etc.).
|
||||
|
||||
The following is a list of metrics exported by the `meshtastic-metrics-exporter`:
|
||||
|
||||
| Metric Name | Description | Type | Labels |
|
||||
|-----------------------------------|------------------------------------------------------------------------------|-----------|--------------------------------------|
|
||||
| text_message_app_length | Length of text messages processed by the app | Histogram | node_id |
|
||||
| device_latitude | Device latitude | Gauge | node_id |
|
||||
| device_longitude | Device longitude | Gauge | node_id |
|
||||
| device_altitude | Device altitude | Gauge | node_id |
|
||||
| device_position_precision | Device position precision | Gauge | node_id |
|
||||
| telemetry_app_ch1_voltage | Voltage measured by the device on channel 1 | Gauge | node_id |
|
||||
| telemetry_app_ch1_current | Current measured by the device on channel 1 | Gauge | node_id |
|
||||
| telemetry_app_ch2_voltage | Voltage measured by the device on channel 2 | Gauge | node_id |
|
||||
| telemetry_app_ch2_current | Current measured by the device on channel 2 | Gauge | node_id |
|
||||
| telemetry_app_ch3_voltage | Voltage measured by the device on channel 3 | Gauge | node_id |
|
||||
| telemetry_app_ch3_current | Current measured by the device on channel 3 | Gauge | node_id |
|
||||
| telemetry_app_pm10_standard | Concentration Units Standard PM1.0 | Gauge | node_id |
|
||||
| telemetry_app_pm25_standard | Concentration Units Standard PM2.5 | Gauge | node_id |
|
||||
| telemetry_app_pm100_standard | Concentration Units Standard PM10.0 | Gauge | node_id |
|
||||
| telemetry_app_pm10_environmental | Concentration Units Environmental PM1.0 | Gauge | node_id |
|
||||
| telemetry_app_pm25_environmental | Concentration Units Environmental PM2.5 | Gauge | node_id |
|
||||
| telemetry_app_pm100_environmental | Concentration Units Environmental PM10.0 | Gauge | node_id |
|
||||
| telemetry_app_particles_03um | 0.3um Particle Count | Gauge | node_id |
|
||||
| telemetry_app_particles_05um | 0.5um Particle Count | Gauge | node_id |
|
||||
| telemetry_app_particles_10um | 1.0um Particle Count | Gauge | node_id |
|
||||
| telemetry_app_particles_25um | 2.5um Particle Count | Gauge | node_id |
|
||||
| telemetry_app_particles_50um | 5.0um Particle Count | Gauge | node_id |
|
||||
| telemetry_app_particles_100um | 10.0um Particle Count | Gauge | node_id |
|
||||
| telemetry_app_temperature | Temperature measured by the device | Gauge | node_id |
|
||||
| telemetry_app_relative_humidity | Relative humidity percent measured by the device | Gauge | node_id |
|
||||
| telemetry_app_barometric_pressure | Barometric pressure in hPA measured by the device | Gauge | node_id |
|
||||
| telemetry_app_gas_resistance | Gas resistance in MOhm measured by the device | Gauge | node_id |
|
||||
| telemetry_app_iaq | IAQ value measured by the device (0-500) | Gauge | node_id |
|
||||
| telemetry_app_distance | Distance measured by the device in mm | Gauge | node_id |
|
||||
| telemetry_app_lux | Ambient light measured by the device in Lux | Gauge | node_id |
|
||||
| telemetry_app_white_lux | White light measured by the device in Lux | Gauge | node_id |
|
||||
| telemetry_app_ir_lux | Infrared light measured by the device in Lux | Gauge | node_id |
|
||||
| telemetry_app_uv_lux | Ultraviolet light measured by the device in Lux | Gauge | node_id |
|
||||
| telemetry_app_wind_direction | Wind direction in degrees measured by the device | Gauge | node_id |
|
||||
| telemetry_app_wind_speed | Wind speed in m/s measured by the device | Gauge | node_id |
|
||||
| telemetry_app_weight | Weight in KG measured by the device | Gauge | node_id |
|
||||
| telemetry_app_battery_level | Battery level of the device (0-100, >100 means powered) | Gauge | node_id |
|
||||
| telemetry_app_voltage | Voltage measured by the device | Gauge | node_id |
|
||||
| telemetry_app_channel_utilization | Utilization for the current channel, including well-formed TX, RX, and noise | Gauge | node_id |
|
||||
| telemetry_app_air_util_tx | Percent of airtime for transmission used within the last hour | Gauge | node_id |
|
||||
| telemetry_app_uptime_seconds | How long the device has been running since the last reboot (in seconds) | Counter | node_id |
|
||||
| route_length | Number of nodes in the route | Counter | node_id |
|
||||
| route_response | Number of responses to route discovery | Counter | node_id, response_type |
|
||||
| mesh_packet_source_types | Types of mesh packets processed by source | Counter | source_id, portnum |
|
||||
| mesh_packet_destination_types | Types of mesh packets processed by destination | Counter | destination_id, portnum |
|
||||
| mesh_packet_total | Total number of mesh packets processed | Counter | source_id, destination_id |
|
||||
| mesh_packet_rx_time | Receive time of mesh packets (seconds since 1970) | Histogram | source_id, destination_id |
|
||||
| mesh_packet_rx_snr | Receive SNR of mesh packets | Gauge | source_id, destination_id |
|
||||
| mesh_packet_hop_limit | Hop limit of mesh packets | Counter | source_id, destination_id |
|
||||
| mesh_packet_want_ack | Occurrences of want ACK for mesh packets | Counter | source_id, destination_id |
|
||||
| mesh_packet_via_mqtt | Occurrences of mesh packets sent via MQTT | Counter | source_id, destination_id |
|
||||
| mesh_packet_hop_start | Hop start of mesh packets | Gauge | source_id, destination_id |
|
||||
| mesh_packet_ids | Unique IDs for mesh packets | Counter | source_id, destination_id, packet_id |
|
||||
| mesh_packet_channel | Channel used for mesh packets | Counter | source_id, destination_id, channel |
|
||||
| mesh_packet_rx_rssi | Receive RSSI of mesh packets | Gauge | source_id, destination_id |
|
||||
| text_message_app_length | Length of text messages processed by the app | Histogram | 🏷️ |
|
||||
| device_latitude | Device latitude | Gauge | 🏷️ |
|
||||
| device_longitude | Device longitude | Gauge | 🏷️ |
|
||||
| device_altitude | Device altitude | Gauge | 🏷️ |
|
||||
| device_position_precision | Device position precision | Gauge | 🏷️ |
|
||||
| telemetry_app_ch1_voltage | Voltage measured by the device on channel 1 | Gauge | 🏷️ |
|
||||
| telemetry_app_ch1_current | Current measured by the device on channel 1 | Gauge | 🏷️ |
|
||||
| telemetry_app_ch2_voltage | Voltage measured by the device on channel 2 | Gauge | 🏷️ |
|
||||
| telemetry_app_ch2_current | Current measured by the device on channel 2 | Gauge | 🏷️ |
|
||||
| telemetry_app_ch3_voltage | Voltage measured by the device on channel 3 | Gauge | 🏷️ |
|
||||
| telemetry_app_ch3_current | Current measured by the device on channel 3 | Gauge | 🏷️ |
|
||||
| telemetry_app_pm10_standard | Concentration Units Standard PM1.0 | Gauge | 🏷️ |
|
||||
| telemetry_app_pm25_standard | Concentration Units Standard PM2.5 | Gauge | 🏷️ |
|
||||
| telemetry_app_pm100_standard | Concentration Units Standard PM10.0 | Gauge | 🏷️ |
|
||||
| telemetry_app_pm10_environmental | Concentration Units Environmental PM1.0 | Gauge | 🏷️ |
|
||||
| telemetry_app_pm25_environmental | Concentration Units Environmental PM2.5 | Gauge | 🏷️ |
|
||||
| telemetry_app_pm100_environmental | Concentration Units Environmental PM10.0 | Gauge | 🏷️ |
|
||||
| telemetry_app_particles_03um | 0.3um Particle Count | Gauge | 🏷️ |
|
||||
| telemetry_app_particles_05um | 0.5um Particle Count | Gauge | 🏷️ |
|
||||
| telemetry_app_particles_10um | 1.0um Particle Count | Gauge | 🏷️ |
|
||||
| telemetry_app_particles_25um | 2.5um Particle Count | Gauge | 🏷️ |
|
||||
| telemetry_app_particles_50um | 5.0um Particle Count | Gauge | 🏷️ |
|
||||
| telemetry_app_particles_100um | 10.0um Particle Count | Gauge | 🏷️ |
|
||||
| telemetry_app_temperature | Temperature measured by the device | Gauge | 🏷️ |
|
||||
| telemetry_app_relative_humidity | Relative humidity percent measured by the device | Gauge | 🏷️ |
|
||||
| telemetry_app_barometric_pressure | Barometric pressure in hPA measured by the device | Gauge | 🏷️ |
|
||||
| telemetry_app_gas_resistance | Gas resistance in MOhm measured by the device | Gauge | 🏷️ |
|
||||
| telemetry_app_iaq | IAQ value measured by the device (0-500) | Gauge | 🏷️ |
|
||||
| telemetry_app_distance | Distance measured by the device in mm | Gauge | 🏷️ |
|
||||
| telemetry_app_lux | Ambient light measured by the device in Lux | Gauge | 🏷️ |
|
||||
| telemetry_app_white_lux | White light measured by the device in Lux | Gauge | 🏷️ |
|
||||
| telemetry_app_ir_lux | Infrared light measured by the device in Lux | Gauge | 🏷️ |
|
||||
| telemetry_app_uv_lux | Ultraviolet light measured by the device in Lux | Gauge | 🏷️ |
|
||||
| telemetry_app_wind_direction | Wind direction in degrees measured by the device | Gauge | 🏷️ |
|
||||
| telemetry_app_wind_speed | Wind speed in m/s measured by the device | Gauge | 🏷️ |
|
||||
| telemetry_app_weight | Weight in KG measured by the device | Gauge | 🏷️ |
|
||||
| telemetry_app_battery_level | Battery level of the device (0-100, >100 means powered) | Gauge | 🏷️ |
|
||||
| telemetry_app_voltage | Voltage measured by the device | Gauge | 🏷️ |
|
||||
| telemetry_app_channel_utilization | Utilization for the current channel, including well-formed TX, RX, and noise | Gauge | 🏷️ |
|
||||
| telemetry_app_air_util_tx | Percent of airtime for transmission used within the last hour | Gauge | 🏷️ |
|
||||
| telemetry_app_uptime_seconds | How long the device has been running since the last reboot (in seconds) | Counter | 🏷️ |
|
||||
| route_length | Number of nodes in the route | Counter | 🏷️ |
|
||||
| route_response | Number of responses to route discovery | Counter | 🏷️, response_type |
|
||||
| mesh_packet_source_types | Types of mesh packets processed by source | Counter | 🏷️ (source), portnum |
|
||||
| mesh_packet_destination_types | Types of mesh packets processed by destination | Counter | 🏷️ (destination), portnum |
|
||||
| mesh_packet_total | Total number of mesh packets processed | Counter | 🏷️ (source), 🏷️ (destination) |
|
||||
| mesh_packet_rx_time | Receive time of mesh packets (seconds since 1970) | Histogram | 🏷️ (source), 🏷️ (destination) |
|
||||
| mesh_packet_rx_snr | Receive SNR of mesh packets | Gauge | 🏷️ (source), 🏷️ (destination) |
|
||||
| mesh_packet_hop_limit | Hop limit of mesh packets | Counter | 🏷️ (source), 🏷️ (destination) |
|
||||
| mesh_packet_want_ack | Occurrences of want ACK for mesh packets | Counter | 🏷️ (source), 🏷️ (destination) |
|
||||
| mesh_packet_via_mqtt | Occurrences of mesh packets sent via MQTT | Counter | 🏷️ (source), 🏷️ (destination) |
|
||||
| mesh_packet_hop_start | Hop start of mesh packets | Gauge | 🏷️ (source), 🏷️ (destination) |
|
||||
| mesh_packet_ids | Unique IDs for mesh packets | Counter | 🏷️ (source), 🏷️ (destination), packet_id |
|
||||
| mesh_packet_channel | Channel used for mesh packets | Counter | 🏷️ (source), 🏷️ (destination), channel |
|
||||
| mesh_packet_rx_rssi | Receive RSSI of mesh packets | Gauge | 🏷️ (source), 🏷️ (destination) |
|
||||
|
||||
## Configuration
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue