vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-10-26 08:41:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1582 from nvollmar/T6949

Browse Source 
T6949: Adds documentation for blackbox exporter
This commit is contained in:
Daniil Baturin 2025-01-08 13:04:23 +00:00 committed by GitHub
commit a7826a7862
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 40 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
docs/configuration/service/monitoring.rst
View File

@ -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
.. _frr_exporter: https://github.com/tynany/frr_exporter
.. _blackbox_exporter: https://github.com/prometheus/blackbox_exporter