T6949: adds blackbox exporter (#4255)

* T6949: adds blackbox exporter

* T6949: adds basic config generation

* T6949: extract shared module config options

* T6949: switch to ipv4/6 literals

* T6949: moves config file to /run

* T6949: adds dns query name option

* T6949: adds dns query type values

* T6949: adds blackbox exporter to debian/control

2 files changed, 44 insertions, 0 deletions

diff --git a/data/templates/prometheus/blackbox_exporter.service.j2 b/data/templates/prometheus/blackbox_exporter.service.j2
new file mode 100644
index 000000000..e93030246
--- /dev/null
+++ b/data/templates/prometheus/blackbox_exporter.service.j2
@@ -0,0 +1,21 @@
+{% set vrf_command = 'ip vrf exec ' ~ vrf ~ ' runuser -u node_exporter -- ' if vrf is vyos_defined else '' %}
+[Unit]
+Description=Blackbox Exporter
+Documentation=https://github.com/prometheus/blackbox_exporter
+After=network.target
+
+[Service]
+{% if vrf is not vyos_defined %}
+User=node_exporter
+{% endif %}
+ExecStart={{ vrf_command }}/usr/sbin/blackbox_exporter \
+{% if listen_address is vyos_defined %}
+{%     for address in listen_address %}
+        --web.listen-address={{ address }}:{{ port }} \
+{%     endfor %}
+{% else %}
+        --web.listen-address=:{{ port }} \
+{% endif %}
+        --config.file=/run/blackbox_exporter/config.yml
+[Install]
+WantedBy=multi-user.target
diff --git a/data/templates/prometheus/blackbox_exporter.yml.j2 b/data/templates/prometheus/blackbox_exporter.yml.j2
new file mode 100644
index 000000000..ba2eecd77
--- /dev/null
+++ b/data/templates/prometheus/blackbox_exporter.yml.j2
@@ -0,0 +1,23 @@
+modules:
+{% if modules is defined and modules.dns is defined and modules.dns.name is defined %}
+{%     for module_name, module_config in modules.dns.name.items() %}
+  {{ module_name }}:
+    prober: dns
+    timeout: {{ module_config.timeout }}s
+    dns:
+      query_name: "{{ module_config.query_name }}"
+      query_type: "{{ module_config.query_type }}"
+      preferred_ip_protocol: "{{ module_config.preferred_ip_protocol | replace('v', '') }}"
+      ip_protocol_fallback: {{ 'true' if module_config.ip_protocol_fallback is vyos_defined else 'false' }}
+{%     endfor %}
+{% endif %}
+{% if modules is defined and modules.icmp is vyos_defined and modules.icmp.name is vyos_defined %}
+{%     for module_name, module_config in modules.icmp.name.items() %}
+  {{ module_name }}:
+    prober: icmp
+    timeout: {{ module_config.timeout }}s
+    icmp:
+      preferred_ip_protocol: "{{ module_config.preferred_ip_protocol | replace('v', '') }}"
+      ip_protocol_fallback: {{ 'true' if module_config.ip_protocol_fallback is vyos_defined else 'false' }}
+{%     endfor %}
+{% endif %}
\ No newline at end of file