diff options
Diffstat (limited to 'docs/configuration/service/monitoring.rst')
| -rw-r--r-- | docs/configuration/service/monitoring.rst | 58 |
1 files changed, 51 insertions, 7 deletions
diff --git a/docs/configuration/service/monitoring.rst b/docs/configuration/service/monitoring.rst index 5c306903..0e4ddc61 100644 --- a/docs/configuration/service/monitoring.rst +++ b/docs/configuration/service/monitoring.rst @@ -212,34 +212,78 @@ Node Exporter ============= Prometheus node_exporter_ which provides a wide range of hardware and OS metrics. -.. cfgcmd:: set service monitoring node-exporter listen-address <address> +.. cfgcmd:: set service monitoring prometheus node-exporter listen-address <address> Configure the address node_exporter is listening on. -.. cfgcmd:: set service monitoring node-exporter port <port> +.. cfgcmd:: set service monitoring prometheus node-exporter port <port> Configure the port number node_exporter is listening on. -.. cfgcmd:: set service monitoring node-exporter vrf <name> +.. cfgcmd:: set service monitoring prometheus node-exporter vrf <name> Configure name of the :abbr:`VRF (Virtual Routing and Forwarding)` instance. +.. cfgcmd:: set service monitoring prometheus node-exporter collectors textfile + + Configure textfile collector to export custom metrics read from + `/run/node_exporter/collector` + FRR Exporter ============ Prometheus frr_exporter_ which provides free range routing metrics. -.. cfgcmd:: set service monitoring frr-exporter listen-address <address> +.. cfgcmd:: set service monitoring prometheus frr-exporter listen-address <address> Configure the address frr_exporter is listening on. -.. cfgcmd:: set service monitoring frr-exporter port <port> +.. cfgcmd:: set service monitoring prometheus frr-exporter port <port> Configure the port number frr_exporter is listening on. -.. cfgcmd:: set service monitoring frr-exporter vrf <name> +.. cfgcmd:: set service monitoring prometheus frr-exporter vrf <name> Configure name of the :abbr:`VRF (Virtual Routing and Forwarding)` instance. + +Blackbox Exporter +================= +Prometheus blackbox_exporter_ which allows probing of endpoints over +HTTP, HTTPS, DNS, TCP, ICMP and gRPC . + +.. cfgcmd:: set service monitoring prometheus blackbox-exporter listen-address <address> + + Configure the address blackbox_exporter is listening on. + +.. cfgcmd:: set service monitoring prometheus blackbox-exporter port <port> + + Configure the port number blackbox_exporter is listening on. + +.. cfgcmd:: set service monitoring prometheus blackbox-exporter vrf <name> + + Configure name of the :abbr:`VRF (Virtual Routing and Forwarding)` instance. + +Configuring modules +------------------- +Blackbox exporter can be configured with different modules for probing DNS or ICMP. + +DNS module example: + +.. code-block:: none + + set service monitoring prometheus blackbox-exporter modules dns name dns4 preferred-ip-protocol ip4 + set service monitoring prometheus blackbox-exporter modules dns name dns4 query-name vyos.io + set service monitoring prometheus blackbox-exporter modules dns name dns4 query-type A + +ICMP module example: + +.. code-block:: none + + set service monitoring prometheus blackbox-exporter modules icmp name ping6 preferred-ip-protocol ip6 + set service monitoring prometheus blackbox-exporter modules icmp name ping6 ip-protocol-fallback + set service monitoring prometheus blackbox-exporter modules icmp name ping6 timeout 3 + .. _node_exporter: https://github.com/prometheus/node_exporter -.. _frr_exporter: https://github.com/tynany/frr_exporter
\ No newline at end of file +.. _frr_exporter: https://github.com/tynany/frr_exporter +.. _blackbox_exporter: https://github.com/prometheus/blackbox_exporter |