summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicolas Vollmar <nvollmar@gmail.com>2024-12-26 12:37:22 +0100
committerNicolas Vollmar <nvollmar@gmail.com>2024-12-26 16:54:30 +0100
commit110e0817b83ec71b8c165907af77c0d4f37f5058 (patch)
tree1e1f4f238c66b723f93262d44ae25def2100b671
parent7c1e53ff68275253995c4aab2987771fd77e8170 (diff)
downloadvyos-documentation-110e0817b83ec71b8c165907af77c0d4f37f5058.tar.gz
vyos-documentation-110e0817b83ec71b8c165907af77c0d4f37f5058.zip
T6949: Adds blackbox exporter config example
-rw-r--r--docs/configuration/service/monitoring.rst20
1 files 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 <path>
+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