From 7c1e53ff68275253995c4aab2987771fd77e8170 Mon Sep 17 00:00:00 2001 From: Nicolas Vollmar Date: Tue, 24 Dec 2024 12:41:46 +0100 Subject: T6949: Adds documentation for blackbox exporter --- docs/configuration/service/monitoring.rst | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/docs/configuration/service/monitoring.rst b/docs/configuration/service/monitoring.rst index 37dc6b43..4cf3ae3b 100644 --- a/docs/configuration/service/monitoring.rst +++ b/docs/configuration/service/monitoring.rst @@ -241,5 +241,28 @@ Prometheus frr_exporter_ which provides free range routing metrics. 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
+ + Configure the address blackbox_exporter is listening on. + +.. cfgcmd:: set service monitoring prometheus blackbox-exporter port + + Configure the port number blackbox_exporter is listening on. + +.. cfgcmd:: set service monitoring prometheus blackbox-exporter vrf + + Configure name of the :abbr:`VRF (Virtual Routing and Forwarding)` instance. + +.. cfgcmd:: set service monitoring prometheus blackbox-exporter config-file + + Configure a custom config file under `/config/prometheus_exporter/` + .. _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 -- cgit v1.2.3 From 110e0817b83ec71b8c165907af77c0d4f37f5058 Mon Sep 17 00:00:00 2001 From: Nicolas Vollmar Date: Thu, 26 Dec 2024 12:37:22 +0100 Subject: T6949: Adds blackbox exporter config example --- docs/configuration/service/monitoring.rst | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/docs/configuration/service/monitoring.rst b/docs/configuration/service/monitoring.rst index 4cf3ae3b..af62456c 100644 --- a/docs/configuration/service/monitoring.rst +++ b/docs/configuration/service/monitoring.rst @@ -259,9 +259,25 @@ HTTP, HTTPS, DNS, TCP, ICMP and gRPC . Configure name of the :abbr:`VRF (Virtual Routing and Forwarding)` instance. -.. cfgcmd:: set service monitoring prometheus blackbox-exporter config-file +Configuring modules +------------------- +Blackbox exporter can be configured with different modules for probing DNS or ICMP. - Configure a custom config file under `/config/prometheus_exporter/` +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 -- cgit v1.2.3