vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-12-16 10:32:02 +01:00
Code Issues Packages Projects Releases Wiki Activity

T973: reorganizes basic strucutre

Browse Source 
-adds documentation for prometheus exporter
This commit is contained in:
Nicolas Vollmar 2024-12-16 15:59:36 +01:00
parent 55afc49936
commit 1b8fb39579
1 changed files with 47 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
docs/configuration/service/monitoring.rst
View File

@ -55,7 +55,7 @@ Telegraf output plugin azure-data-explorer_.
Prometheus client Prometheus client
================= =================
Telegraf output plugin prometheus-client_. Telegraf output plugin prometheus-client_
This plugin allows export of Telegraf metrics to Prometheus, This plugin allows export of Telegraf metrics to Prometheus,
for Prometheus native metrics through exporters see section below. for Prometheus native metrics through exporters see section below.
@ -197,3 +197,49 @@ Telegraf can be used to send logs to loki_ using tags as labels.
.. _influxdb: https://github.com/influxdata/telegraf/tree/master/plugins/outputs/influxdb_v2 .. _influxdb: https://github.com/influxdata/telegraf/tree/master/plugins/outputs/influxdb_v2
.. _splunk: https://www.splunk.com/en_us/blog/it/splunk-metrics-via-telegraf.html .. _splunk: https://www.splunk.com/en_us/blog/it/splunk-metrics-via-telegraf.html
.. _loki: https://github.com/influxdata/telegraf/tree/master/plugins/outputs/loki .. _loki: https://github.com/influxdata/telegraf/tree/master/plugins/outputs/loki
**********
Prometheus
**********
The following Prometheus exporters are configurable to export metrics:
* Node Exporter
* FRR Exporter
Node Exporter
=============
Prometheus node_exporter_ which provides a wide range of hardware and OS metrics.
.. cfgcmd:: set service monitoring node-exporter listen-address <address>
Configure the address node_exporter is listening on.
.. cfgcmd:: set service monitoring node-exporter port <port>
Configure the port number node_exporter is listening on.
.. cfgcmd:: set service monitoring node-exporter vrf <name>
Configure name of the :abbr:`VRF (Virtual Routing and Forwarding)` instance.
FRR Exporter
============
Prometheus frr_exporter_ which provides free range routing metrics.
.. cfgcmd:: set service monitoring frr-exporter listen-address <address>
Configure the address frr_exporter is listening on.
.. cfgcmd:: set service monitoring frr-exporter port <port>
Configure the port number frr_exporter is listening on.
.. cfgcmd:: set service monitoring frr-exporter vrf <name>
Configure name of the :abbr:`VRF (Virtual Routing and Forwarding)` instance.
.. _node_exporter: https://github.com/prometheus/node_exporter
.. _frr_exporter: https://github.com/tynany/frr_exporter