diff --git a/docs/community/software/index.mdx b/docs/community/software/index.mdx index 9a4865fd..0f5bdc1a 100644 --- a/docs/community/software/index.mdx +++ b/docs/community/software/index.mdx @@ -11,5 +11,7 @@ Current community projects: - [Meshtasticator (Simulator)](/docs/community/software/community-meshtasticator) - Meshtasticator is a discrete-event and interactive simulator that mimics the radio section of the device software. - [Meshtastic Web API](/docs/community/software/meshtastic-web-api) - Meshtastic Web API provides a RESTful interface to interact with a Meshtastic node via a serial connection. +- [Mesh-metrics](/docs/community/software/community-mesh-metrics) - Meshtastic repeater metrics scraper using meshtastic-cli to be ingested by node_exporter for use in Prometheus or Victoria Metrics Time series DB with a Grafana dashboard and sample alerting rules. Support for these projects should be sought from their respective authors. + diff --git a/docs/community/software/mesh-metrics.mdx b/docs/community/software/mesh-metrics.mdx new file mode 100644 index 00000000..fe1bd5bd --- /dev/null +++ b/docs/community/software/mesh-metrics.mdx @@ -0,0 +1,16 @@ +--- +id: community-mesh-metrics +title: Mesh-metrics +sidebar_label: Mesh-metrics +sidebar_position: 3 +--- + +:::note + +This is a community project maintained by @cordelster. +Development can be followed on [GitHub](https://github.com/cordelster/mesh-metrics). +Support should be sought from the respective authors. + +::: + +Mesh-metrics is a script that uses the meshtastic-cli and a device connected by usb to send metrics-requests from a list of devices and output the results in a format to be ingested by node_exporter to populate a Prometheus/Victoria Metrics Time series DB. Along with the script, a Grafana dashboard and some alert examples are included. Mesh-metrics was created and is maintained by cordel and more information on its use and setup can be found on the [Mesh-metrics Github page](https://github.com/cordelster/mesh-metrics)