diff options
| author | Daniil Baturin <daniil@vyos.io> | 2025-01-08 13:04:23 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-01-08 13:04:23 +0000 |
| commit | a7826a7862169ef6651437fdcc7e5ab3e346fa9f (patch) | |
| tree | f726035168facf349105e5d19c21886111d4972a | |
| parent | e1c6051cc5222def6ed5e97901f3a2b8d17b1880 (diff) | |
| parent | 110e0817b83ec71b8c165907af77c0d4f37f5058 (diff) | |
| download | vyos-documentation-a7826a7862169ef6651437fdcc7e5ab3e346fa9f.tar.gz vyos-documentation-a7826a7862169ef6651437fdcc7e5ab3e346fa9f.zip | |
Merge pull request #1582 from nvollmar/T6949
T6949: Adds documentation for blackbox exporter
| -rw-r--r-- | docs/configuration/service/monitoring.rst | 41 |
1 files changed, 40 insertions, 1 deletions
diff --git a/docs/configuration/service/monitoring.rst b/docs/configuration/service/monitoring.rst index 61f39d8d..0e4ddc61 100644 --- a/docs/configuration/service/monitoring.rst +++ b/docs/configuration/service/monitoring.rst @@ -246,5 +246,44 @@ 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 <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 |