From 1b8fb3957945692e808388e700c3d04c46c55b8b Mon Sep 17 00:00:00 2001 From: Nicolas Vollmar Date: Mon, 16 Dec 2024 15:59:36 +0100 Subject: T973: reorganizes basic strucutre -adds documentation for prometheus exporter --- docs/configuration/service/monitoring.rst | 48 ++++++++++++++++++++++++++++++- 1 file changed, 47 insertions(+), 1 deletion(-) diff --git a/docs/configuration/service/monitoring.rst b/docs/configuration/service/monitoring.rst index 57334d7d..5c306903 100644 --- a/docs/configuration/service/monitoring.rst +++ b/docs/configuration/service/monitoring.rst @@ -55,7 +55,7 @@ Telegraf output plugin azure-data-explorer_. Prometheus client ================= -Telegraf output plugin prometheus-client_. +Telegraf output plugin prometheus-client_ This plugin allows export of Telegraf metrics to Prometheus, 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 .. _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 + + +********** +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
+ + Configure the address node_exporter is listening on. + +.. cfgcmd:: set service monitoring node-exporter port + + Configure the port number node_exporter is listening on. + +.. cfgcmd:: set service monitoring node-exporter vrf + + 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
+ + Configure the address frr_exporter is listening on. + +.. cfgcmd:: set service monitoring frr-exporter port + + Configure the port number frr_exporter is listening on. + +.. cfgcmd:: set service monitoring frr-exporter vrf + + 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 \ No newline at end of file -- cgit v1.2.3