diff --git a/arednServicesGuide/_images/grafana.png b/arednServicesGuide/_images/grafana.png new file mode 100644 index 0000000..ff7b14b Binary files /dev/null and b/arednServicesGuide/_images/grafana.png differ diff --git a/arednServicesGuide/_images/prometheus-exporter.png b/arednServicesGuide/_images/prometheus-exporter.png new file mode 100644 index 0000000..2f854ce Binary files /dev/null and b/arednServicesGuide/_images/prometheus-exporter.png differ diff --git a/arednServicesGuide/network_tools.rst b/arednServicesGuide/network_tools.rst index b96121f..15c288c 100644 --- a/arednServicesGuide/network_tools.rst +++ b/arednServicesGuide/network_tools.rst @@ -1,6 +1,6 @@ -======================= -Network Discovery Tools -======================= +======================== +Network Management Tools +======================== There are several service programs that can assist in visualizing or mapping an AREDN |trade| network, as well as for viewing local RF conditions near your node. Some of these programs are discussed below. @@ -30,6 +30,35 @@ For additional information visit this link: `KN6PLV MeshMap `_ is an open-source monitoring and alerting toolkit which collects and stores metrics as time series data. At given intervals it can collect metrics from AREDN |trade| nodes having the ``prometheus-exporter`` package installed. Prometheus evaluates rule expressions, displays the results, and can trigger alerts when specified conditions are detected. + +AREDN |trade| metrics in the ``prometheus-exporter`` package include the following: + +- Node details (name, model, firmware, description, Lat/Lon, grid square, band, channel, width, frequency, SSID) +- Memory, storage, CPU, and networking metrics +- RF metrics (signal, noise, MSC rate, TX/RX packets/rates) +- LQM metrics +- OLSR link info + +In order for Prometheus to pull metrics from a node it will use the following target URL: ``http://.local.mesh/cgi-bin/metrics`` and metrics are returned by the node as standard *text/plain* content. Minimal node resources are required to support Prometheus data collection since the node only uses minimal resources whenever this URL is queried. + +.. image:: _images/prometheus-exporter.png + :alt: Prometheus Exporter metrics in text format + :align: center + +| + +The AREDN |trade| ``prometheus-exporter`` simply makes these metrics available for Prometheus to pull. For additional information about Prometheus itself, visit `their website here `_. The following image shows Prometheus metrics for an AREDN |trade| node being displayed by the `Grafana `_ visualization application. + +.. image:: _images/grafana.png + :alt: Prometheus Exporter metrics in Grafana + :align: center + +| + KN6PLV Network Waterfall Scanner --------------------------------