artiommocrenco/meshtastic-prometheus-exporter

Monitor your meshtastic network with Meshtastic Prometheus exporter

meshtastic-prometheus-exporter

Supported metrics

See SUPPORTED_METRICS.md for a list of supported metrics

Usage

1. find an MQTT server you want to use or use the public Meshtastic MQTT server (mqtt.meshtastic.org)
2. for your meshtastic node (you should be using firmware version 2.3.7.30fbcab), configure and enable MQTT module for uplink
3. download (preferably) latest release, uncompress it and navigate to the directory with the docker-compose.yml file
4. edit the docker-compose.yml file and specify connection details to the MQTT server there too
5. in your terminal, run docker-compose up --build --force-recreate (for this, you need docker installed)
6. in your web browser, navigate to http://localhost:3000/dashboards and authenticate using default Grafana credentials (username admin, password admin)

Within a few minutes, data should begin populating on the dashboards. At first, you are likely to see most packets as if they come from "unknown" sources. Wait several hours to allow Redis to be populated with node information (nodes rarely send information about themselves, usually every 3 hours). After the wait, all data should be visible on the dashboards.

This has been tested with:

• Prometheus pull scheme as in docker-compose.yml
• Scaleway Cockpit & Grafana Mimir remote write api

Known limitations

• All nodes serving as MQTT uplinks SHOULD have firmware version specified above
• Running two exporters for the same meshtastic network that write to the same Prometheus is not supported
• While mostly reporting useful information, Grafana dashboards do contain mistakes in some of the visualizations
• Using TLS for MQTT on meshtastic side may be problematic for performance and reliability (third-party issue)
• Exception handling & code quality need improvement
• Inefficient usage of main thread (does not use asyncio)

Contributing

Please feel free to contribute

meshtastic-prometheus-exporter's Issues

Implement MeshPacket.delayed metrics & panels

Add GhA workflow

Trunk based development (without automated tests for now)

Based on tags

Complete versioning scheme: <meshtastic_version>-<exporter version>

<exporter_version> is MAJOR.MINOR

• Code style test
• Build & Tag docker image
• Push docker image
• Generate changelog
• Create Github release

How to install probe

I am a new meshtastic fan.
Looking for a way to monitor nodes, i found your project.

Can it be used on a computer through USB serial connection to "Heltec v3" ?
Does it need MQTT server relay ?

Could you give detail on how you use it ?

Implement StoreAndForward metrics & panels

Rename `node` labels to `source`

Add prometheus & grafana to docker-compose.yml

Switch to meshtastic v2.3.0.5f47ca1

meshtastic_mesh_packet_count_total should start at 0

increase() relies on counters starting with 0, not 1

we should have a function that initializes meshtastic_mesh_packet_count_total for different labels

Implement collecting data over wired serial/USB connection

Neighbor Info Support

Visualizing neighbor info would be helpful to improve the performance of a network

Implement Position metrics & panels

Remove MeshPacket.priority metrics & panels

Because priority is not sent over radio link

Rename metrics in accordance with Prometheus best practices

https://prometheus.io/docs/practices/naming/

Allow for processing of MQTT data from more than one meshtastic node

Implement MeshPacket.hop_limit metrics & panels

Add support for OpenTelemetry PrometheusMetricReader (Prometheus pull metrics)

Implement MeshPacket.rx_rssi metrics & panels

Use logger everywhere instead of print()