diff options
| author | Nicolas Vollmar <nvo@scaling.ch> | 2024-12-24 12:41:46 +0100 |
|---|---|---|
| committer | Nicolas Vollmar <nvo@scaling.ch> | 2024-12-24 12:41:46 +0100 |
| commit | 7c1e53ff68275253995c4aab2987771fd77e8170 (patch) | |
| tree | 0e3120b2fddb19549a432c7bf4c3f8ce64bdade7 | |
| parent | 9605788b615668818483bad5781c5b714536f3e6 (diff) | |
| download | vyos-documentation-7c1e53ff68275253995c4aab2987771fd77e8170.tar.gz vyos-documentation-7c1e53ff68275253995c4aab2987771fd77e8170.zip | |
T6949: Adds documentation for blackbox exporter
| -rw-r--r-- | docs/configuration/service/monitoring.rst | 25 |
1 files changed, 24 insertions, 1 deletions
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 <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. + +.. cfgcmd:: set service monitoring prometheus blackbox-exporter config-file <path> + + 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 |