diff --git a/data/templates/prometheus/node_exporter.service.j2 b/data/templates/prometheus/node_exporter.service.j2
index 62e7e6774..135439bd6 100644
--- a/data/templates/prometheus/node_exporter.service.j2
+++ b/data/templates/prometheus/node_exporter.service.j2
@@ -1,20 +1,25 @@
{% set vrf_command = 'ip vrf exec ' ~ vrf ~ ' runuser -u node_exporter -- ' if vrf is vyos_defined else '' %}
[Unit]
Description=Node Exporter
Documentation=https://github.com/prometheus/node_exporter
After=network.target
[Service]
{% if vrf is not vyos_defined %}
User=node_exporter
{% endif %}
ExecStart={{ vrf_command }}/usr/sbin/node_exporter \
{% if listen_address is vyos_defined %}
{% for address in listen_address %}
--web.listen-address={{ address }}:{{ port }}
{% endfor %}
{% else %}
--web.listen-address=:{{ port }}
{% endif %}
+{% if collectors is vyos_defined %}
+{% if collectors.textfile is vyos_defined %}
+ --collector.textfile.directory=/run/node_exporter/collector
+{% endif %}
+{% endif %}
[Install]
WantedBy=multi-user.target
diff --git a/interface-definitions/service_monitoring_prometheus.xml.in b/interface-definitions/service_monitoring_prometheus.xml.in
index 740900f1f..8bcebf5f3 100644
--- a/interface-definitions/service_monitoring_prometheus.xml.in
+++ b/interface-definitions/service_monitoring_prometheus.xml.in
@@ -1,121 +1,134 @@
<?xml version="1.0"?>
<interfaceDefinition>
<node name="service">
<children>
<node name="monitoring">
<children>
<node name="prometheus" owner="${vyos_conf_scripts_dir}/service_monitoring_prometheus.py">
<properties>
<help>Prometheus metric exporter</help>
<priority>1280</priority>
</properties>
<children>
<node name="node-exporter">
<properties>
<help>Prometheus exporter for hardware and operating system metrics</help>
</properties>
<children>
#include <include/listen-address.xml.i>
#include <include/port-number.xml.i>
<leafNode name="port">
<defaultValue>9100</defaultValue>
</leafNode>
#include <include/interface/vrf.xml.i>
+ <node name="collectors">
+ <properties>
+ <help>Collectors specific configuration</help>
+ </properties>
+ <children>
+ <leafNode name="textfile">
+ <properties>
+ <help>Enables textfile collector to read from /run/node_exporter/collector</help>
+ <valueless/>
+ </properties>
+ </leafNode>
+ </children>
+ </node>
</children>
</node>
<node name="frr-exporter">
<properties>
<help>Prometheus exporter for FRR metrics</help>
</properties>
<children>
#include <include/listen-address.xml.i>
#include <include/port-number.xml.i>
<leafNode name="port">
<defaultValue>9342</defaultValue>
</leafNode>
#include <include/interface/vrf.xml.i>
</children>
</node>
<node name="blackbox-exporter">
<properties>
<help>Prometheus exporter for probing endpoints</help>
</properties>
<children>
#include <include/listen-address.xml.i>
#include <include/port-number.xml.i>
<leafNode name="port">
<defaultValue>9115</defaultValue>
</leafNode>
#include <include/interface/vrf.xml.i>
<node name="modules">
<properties>
<help>Configure blackbox exporter modules</help>
</properties>
<children>
<node name="dns">
<properties>
<help>Configure dns module</help>
</properties>
<children>
<tagNode name="name">
<properties>
<help>Name of the dns module</help>
</properties>
<children>
<leafNode name="query-name">
<properties>
<help>Name to be queried</help>
<constraint>
<validator name="fqdn"/>
</constraint>
</properties>
</leafNode>
<leafNode name="query-type">
<properties>
<help>DNS query type</help>
<valueHelp>
<format>ANY</format>
<description>Query any DNS record</description>
</valueHelp>
<valueHelp>
<format>A</format>
<description>Query IPv4 address record</description>
</valueHelp>
<valueHelp>
<format>AAAA</format>
<description>Query IPv6 address record</description>
</valueHelp>
</properties>
<defaultValue>ANY</defaultValue>
</leafNode>
#include <include/monitoring/blackbox-exporter-module-commons.xml.i>
</children>
</tagNode>
</children>
</node>
<node name="icmp">
<properties>
<help>Configure icmp module</help>
</properties>
<children>
<tagNode name="name">
<properties>
<help>Name of the icmp module</help>
</properties>
<children>
#include <include/monitoring/blackbox-exporter-module-commons.xml.i>
</children>
</tagNode>
</children>
</node>
</children>
</node>
</children>
</node>
</children>
</node>
</children>
</node>
</children>
</node>
</interfaceDefinition>
diff --git a/smoketest/scripts/cli/test_service_monitoring_prometheus.py b/smoketest/scripts/cli/test_service_monitoring_prometheus.py
index df737f840..6e7f8c808 100755
--- a/smoketest/scripts/cli/test_service_monitoring_prometheus.py
+++ b/smoketest/scripts/cli/test_service_monitoring_prometheus.py
@@ -1,154 +1,161 @@
#!/usr/bin/env python3
#
# Copyright (C) 2024 VyOS maintainers and contributors
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 or later as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
+import os
import unittest
from base_vyostest_shim import VyOSUnitTestSHIM
from vyos.utils.process import process_named_running
from vyos.utils.file import read_file
NODE_EXPORTER_PROCESS_NAME = 'node_exporter'
FRR_EXPORTER_PROCESS_NAME = 'frr_exporter'
BLACKBOX_EXPORTER_PROCESS_NAME = 'blackbox_exporter'
base_path = ['service', 'monitoring', 'prometheus']
listen_if = 'dum3421'
listen_ip = '192.0.2.1'
node_exporter_service_file = '/etc/systemd/system/node_exporter.service'
frr_exporter_service_file = '/etc/systemd/system/frr_exporter.service'
blackbox_exporter_service_file = '/etc/systemd/system/blackbox_exporter.service'
class TestMonitoringPrometheus(VyOSUnitTestSHIM.TestCase):
@classmethod
def setUpClass(cls):
# call base-classes classmethod
super(TestMonitoringPrometheus, cls).setUpClass()
# create a test interfaces
cls.cli_set(
cls, ['interfaces', 'dummy', listen_if, 'address', listen_ip + '/32']
)
@classmethod
def tearDownClass(cls):
cls.cli_delete(cls, ['interfaces', 'dummy', listen_if])
super(TestMonitoringPrometheus, cls).tearDownClass()
def tearDown(self):
self.cli_delete(base_path)
self.cli_commit()
self.assertFalse(process_named_running(NODE_EXPORTER_PROCESS_NAME))
self.assertFalse(process_named_running(FRR_EXPORTER_PROCESS_NAME))
def test_01_node_exporter(self):
self.cli_set(base_path + ['node-exporter', 'listen-address', listen_ip])
+ self.cli_set(base_path + ['node-exporter', 'collectors', 'textfile'])
# commit changes
self.cli_commit()
file_content = read_file(node_exporter_service_file)
self.assertIn(f'{listen_ip}:9100', file_content)
+ self.assertTrue(os.path.isdir('/run/node_exporter/collector'))
+ self.assertIn(
+ '--collector.textfile.directory=/run/node_exporter/collector', file_content
+ )
+
# Check for running process
self.assertTrue(process_named_running(NODE_EXPORTER_PROCESS_NAME))
def test_02_frr_exporter(self):
self.cli_set(base_path + ['frr-exporter', 'listen-address', listen_ip])
# commit changes
self.cli_commit()
file_content = read_file(frr_exporter_service_file)
self.assertIn(f'{listen_ip}:9342', file_content)
# Check for running process
self.assertTrue(process_named_running(FRR_EXPORTER_PROCESS_NAME))
def test_03_blackbox_exporter(self):
self.cli_set(base_path + ['blackbox-exporter', 'listen-address', listen_ip])
# commit changes
self.cli_commit()
file_content = read_file(blackbox_exporter_service_file)
self.assertIn(f'{listen_ip}:9115', file_content)
# Check for running process
self.assertTrue(process_named_running(BLACKBOX_EXPORTER_PROCESS_NAME))
def test_04_blackbox_exporter_with_config(self):
self.cli_set(base_path + ['blackbox-exporter', 'listen-address', listen_ip])
self.cli_set(
base_path
+ [
'blackbox-exporter',
'modules',
'dns',
'name',
'dns_ip4',
'preferred-ip-protocol',
'ipv4',
]
)
self.cli_set(
base_path
+ [
'blackbox-exporter',
'modules',
'dns',
'name',
'dns_ip4',
'query-name',
'vyos.io',
]
)
self.cli_set(
base_path
+ [
'blackbox-exporter',
'modules',
'dns',
'name',
'dns_ip4',
'query-type',
'A',
]
)
self.cli_set(
base_path
+ [
'blackbox-exporter',
'modules',
'icmp',
'name',
'icmp_ip6',
'preferred-ip-protocol',
'ipv6',
]
)
# commit changes
self.cli_commit()
file_content = read_file(blackbox_exporter_service_file)
self.assertIn(f'{listen_ip}:9115', file_content)
# Check for running process
self.assertTrue(process_named_running(BLACKBOX_EXPORTER_PROCESS_NAME))
if __name__ == '__main__':
unittest.main(verbosity=2)
diff --git a/src/conf_mode/service_monitoring_prometheus.py b/src/conf_mode/service_monitoring_prometheus.py
index 42628b05c..9a07d8593 100755
--- a/src/conf_mode/service_monitoring_prometheus.py
+++ b/src/conf_mode/service_monitoring_prometheus.py
@@ -1,199 +1,206 @@
#!/usr/bin/env python3
#
# Copyright (C) 2024 VyOS maintainers and contributors
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 or later as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
import os
from sys import exit
from vyos.config import Config
from vyos.configdict import is_node_changed
from vyos.configverify import verify_vrf
from vyos.template import render
from vyos.utils.process import call
from vyos import ConfigError
from vyos import airbag
-
airbag.enable()
node_exporter_service_file = '/etc/systemd/system/node_exporter.service'
node_exporter_systemd_service = 'node_exporter.service'
+node_exporter_collector_path = '/run/node_exporter/collector'
frr_exporter_service_file = '/etc/systemd/system/frr_exporter.service'
frr_exporter_systemd_service = 'frr_exporter.service'
blackbox_exporter_service_file = '/etc/systemd/system/blackbox_exporter.service'
blackbox_exporter_systemd_service = 'blackbox_exporter.service'
def get_config(config=None):
if config:
conf = config
else:
conf = Config()
base = ['service', 'monitoring', 'prometheus']
if not conf.exists(base):
return None
monitoring = conf.get_config_dict(
base, key_mangling=('-', '_'), get_first_key=True, with_recursive_defaults=True
)
tmp = is_node_changed(conf, base + ['node-exporter', 'vrf'])
if tmp:
monitoring.update({'node_exporter_restart_required': {}})
tmp = is_node_changed(conf, base + ['frr-exporter', 'vrf'])
if tmp:
monitoring.update({'frr_exporter_restart_required': {}})
tmp = False
for node in ['vrf', 'config-file']:
tmp = tmp or is_node_changed(conf, base + ['blackbox-exporter', node])
if tmp:
monitoring.update({'blackbox_exporter_restart_required': {}})
return monitoring
def verify(monitoring):
if not monitoring:
return None
if 'node_exporter' in monitoring:
verify_vrf(monitoring['node_exporter'])
if 'frr_exporter' in monitoring:
verify_vrf(monitoring['frr_exporter'])
if 'blackbox_exporter' in monitoring:
verify_vrf(monitoring['blackbox_exporter'])
if (
'modules' in monitoring['blackbox_exporter']
and 'dns' in monitoring['blackbox_exporter']['modules']
and 'name' in monitoring['blackbox_exporter']['modules']['dns']
):
for mod_name, mod_config in monitoring['blackbox_exporter']['modules'][
'dns'
]['name'].items():
if 'query_name' not in mod_config:
raise ConfigError(
f'query name not specified in dns module {mod_name}'
)
return None
def generate(monitoring):
if not monitoring or 'node_exporter' not in monitoring:
# Delete systemd files
if os.path.isfile(node_exporter_service_file):
os.unlink(node_exporter_service_file)
if not monitoring or 'frr_exporter' not in monitoring:
# Delete systemd files
if os.path.isfile(frr_exporter_service_file):
os.unlink(frr_exporter_service_file)
if not monitoring or 'blackbox_exporter' not in monitoring:
# Delete systemd files
if os.path.isfile(blackbox_exporter_service_file):
os.unlink(blackbox_exporter_service_file)
if not monitoring:
return None
if 'node_exporter' in monitoring:
# Render node_exporter node_exporter_service_file
render(
node_exporter_service_file,
'prometheus/node_exporter.service.j2',
monitoring['node_exporter'],
)
+ if (
+ 'collectors' in monitoring['node_exporter']
+ and 'textfile' in monitoring['node_exporter']['collectors']
+ ):
+ # Create textcollector folder
+ if not os.path.isdir(node_exporter_collector_path):
+ os.makedirs(node_exporter_collector_path)
if 'frr_exporter' in monitoring:
# Render frr_exporter service_file
render(
frr_exporter_service_file,
'prometheus/frr_exporter.service.j2',
monitoring['frr_exporter'],
)
if 'blackbox_exporter' in monitoring:
# Render blackbox_exporter service_file
render(
blackbox_exporter_service_file,
'prometheus/blackbox_exporter.service.j2',
monitoring['blackbox_exporter'],
)
# Render blackbox_exporter config file
render(
'/run/blackbox_exporter/config.yml',
'prometheus/blackbox_exporter.yml.j2',
monitoring['blackbox_exporter'],
)
return None
def apply(monitoring):
# Reload systemd manager configuration
call('systemctl daemon-reload')
if not monitoring or 'node_exporter' not in monitoring:
call(f'systemctl stop {node_exporter_systemd_service}')
if not monitoring or 'frr_exporter' not in monitoring:
call(f'systemctl stop {frr_exporter_systemd_service}')
if not monitoring or 'blackbox_exporter' not in monitoring:
call(f'systemctl stop {blackbox_exporter_systemd_service}')
if not monitoring:
return
if 'node_exporter' in monitoring:
# we need to restart the service if e.g. the VRF name changed
systemd_action = 'reload-or-restart'
if 'node_exporter_restart_required' in monitoring:
systemd_action = 'restart'
call(f'systemctl {systemd_action} {node_exporter_systemd_service}')
if 'frr_exporter' in monitoring:
# we need to restart the service if e.g. the VRF name changed
systemd_action = 'reload-or-restart'
if 'frr_exporter_restart_required' in monitoring:
systemd_action = 'restart'
call(f'systemctl {systemd_action} {frr_exporter_systemd_service}')
if 'blackbox_exporter' in monitoring:
# we need to restart the service if e.g. the VRF name changed
systemd_action = 'reload-or-restart'
if 'blackbox_exporter_restart_required' in monitoring:
systemd_action = 'restart'
call(f'systemctl {systemd_action} {blackbox_exporter_systemd_service}')
if __name__ == '__main__':
try:
c = get_config()
verify(c)
generate(c)
apply(c)
except ConfigError as e:
print(e)
exit(1)