Merge pull request #4242 from nvollmar/T6953

T6953: merges node and frr exporter under prometheus section

4 files changed, 195 insertions, 202 deletions

diff --git a/src/conf_mode/service_monitoring_frr-exporter.py b/src/conf_mode/service_monitoring_frr-exporter.py
deleted file mode 100755
index 01527d579..000000000
--- a/src/conf_mode/service_monitoring_frr-exporter.py
+++ /dev/null
@@ -1,101 +0,0 @@
-#!/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()
-
-service_file = '/etc/systemd/system/frr_exporter.service'
-systemd_service = 'frr_exporter.service'
-
-
-def get_config(config=None):
-    if config:
-        conf = config
-    else:
-        conf = Config()
-    base = ['service', 'monitoring', 'frr-exporter']
-    if not conf.exists(base):
-        return None
-
-    config_data = conf.get_config_dict(
-        base, key_mangling=('-', '_'), get_first_key=True
-    )
-    config_data = conf.merge_defaults(config_data, recursive=True)
-
-    tmp = is_node_changed(conf, base + ['vrf'])
-    if tmp:
-        config_data.update({'restart_required': {}})
-
-    return config_data
-
-
-def verify(config_data):
-    # bail out early - looks like removal from running config
-    if not config_data:
-        return None
-
-    verify_vrf(config_data)
-    return None
-
-
-def generate(config_data):
-    if not config_data:
-        # Delete systemd files
-        if os.path.isfile(service_file):
-            os.unlink(service_file)
-        return None
-
-    # Render frr_exporter service_file
-    render(service_file, 'frr_exporter/frr_exporter.service.j2', config_data)
-    return None
-
-
-def apply(config_data):
-    # Reload systemd manager configuration
-    call('systemctl daemon-reload')
-    if not config_data:
-        call(f'systemctl stop {systemd_service}')
-        return
-
-    # we need to restart the service if e.g. the VRF name changed
-    systemd_action = 'reload-or-restart'
-    if 'restart_required' in config_data:
-        systemd_action = 'restart'
-
-    call(f'systemctl {systemd_action} {systemd_service}')
-
-
-if __name__ == '__main__':
-    try:
-        c = get_config()
-        verify(c)
-        generate(c)
-        apply(c)
-    except ConfigError as e:
-        print(e)
-        exit(1)
diff --git a/src/conf_mode/service_monitoring_node-exporter.py b/src/conf_mode/service_monitoring_node-exporter.py
deleted file mode 100755
index db34bb5d0..000000000
--- a/src/conf_mode/service_monitoring_node-exporter.py
+++ /dev/null
@@ -1,101 +0,0 @@
-#!/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()
-
-service_file = '/etc/systemd/system/node_exporter.service'
-systemd_service = 'node_exporter.service'
-
-
-def get_config(config=None):
-    if config:
-        conf = config
-    else:
-        conf = Config()
-    base = ['service', 'monitoring', 'node-exporter']
-    if not conf.exists(base):
-        return None
-
-    config_data = conf.get_config_dict(
-        base, key_mangling=('-', '_'), get_first_key=True
-    )
-    config_data = conf.merge_defaults(config_data, recursive=True)
-
-    tmp = is_node_changed(conf, base + ['vrf'])
-    if tmp:
-        config_data.update({'restart_required': {}})
-
-    return config_data
-
-
-def verify(config_data):
-    # bail out early - looks like removal from running config
-    if not config_data:
-        return None
-
-    verify_vrf(config_data)
-    return None
-
-
-def generate(config_data):
-    if not config_data:
-        # Delete systemd files
-        if os.path.isfile(service_file):
-            os.unlink(service_file)
-        return None
-
-    # Render node_exporter service_file
-    render(service_file, 'node_exporter/node_exporter.service.j2', config_data)
-    return None
-
-
-def apply(config_data):
-    # Reload systemd manager configuration
-    call('systemctl daemon-reload')
-    if not config_data:
-        call(f'systemctl stop {systemd_service}')
-        return
-
-    # we need to restart the service if e.g. the VRF name changed
-    systemd_action = 'reload-or-restart'
-    if 'restart_required' in config_data:
-        systemd_action = 'restart'
-
-    call(f'systemctl {systemd_action} {systemd_service}')
-
-
-if __name__ == '__main__':
-    try:
-        c = get_config()
-        verify(c)
-        generate(c)
-        apply(c)
-    except ConfigError as e:
-        print(e)
-        exit(1)
diff --git a/src/conf_mode/service_monitoring_prometheus.py b/src/conf_mode/service_monitoring_prometheus.py
new file mode 100755
index 000000000..e0a9fc4ef
--- /dev/null
+++ b/src/conf_mode/service_monitoring_prometheus.py
@@ -0,0 +1,145 @@
+#!/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'
+
+frr_exporter_service_file = '/etc/systemd/system/frr_exporter.service'
+frr_exporter_systemd_service = 'frr_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': {}})
+
+    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'])
+
+    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:
+        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 'frr_exporter' in monitoring:
+        # Render frr_exporter service_file
+        render(
+            frr_exporter_service_file,
+            'prometheus/frr_exporter.service.j2',
+            monitoring['frr_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:
+        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 __name__ == '__main__':
+    try:
+        c = get_config()
+        verify(c)
+        generate(c)
+        apply(c)
+    except ConfigError as e:
+        print(e)
+        exit(1)
diff --git a/src/migration-scripts/monitoring/1-to-2 b/src/migration-scripts/monitoring/1-to-2
new file mode 100644
index 000000000..8bdaebae9
--- /dev/null
+++ b/src/migration-scripts/monitoring/1-to-2
@@ -0,0 +1,50 @@
+# Copyright 2024 VyOS maintainers and contributors <maintainers@vyos.io>
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library 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
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this library.  If not, see <http://www.gnu.org/licenses/>.
+
+# T6953: merge node and frr exporter under prometheus section
+
+from vyos.configtree import ConfigTree
+
+old_base = ['service', 'monitoring']
+new_base = ['service', 'monitoring', 'prometheus']
+
+def migrate(config: ConfigTree) -> None:
+    if not config.exists(old_base):
+        # Nothing to do
+        return
+
+    if config.exists(old_base + ['node-exporter']):
+        if config.exists(old_base + ['node-exporter', 'listen-address']):
+          tmp = config.return_value(old_base + ['node-exporter', 'listen-address'])
+          config.set(new_base + ['node-exporter', 'listen-address'], value=tmp)
+        if config.exists(old_base + ['node-exporter', 'port']):
+          tmp = config.return_value(old_base + ['node-exporter', 'port'])
+          config.set(new_base + ['node-exporter', 'port'], value=tmp)
+        if config.exists(old_base + ['node-exporter', 'vrf']):
+          tmp = config.return_value(old_base + ['node-exporter', 'vrf'])
+          config.set(new_base + ['node-exporter', 'vrf'], value=tmp)
+        config.delete(old_base + ['node-exporter'])
+
+    if config.exists(old_base + ['frr-exporter']):
+        if config.exists(old_base + ['frr-exporter', 'listen-address']):
+          tmp = config.return_value(old_base + ['frr-exporter', 'listen-address'])
+          config.set(new_base + ['frr-exporter', 'listen-address'], value=tmp)
+        if config.exists(old_base + ['frr-exporter', 'port']):
+          tmp = config.return_value(old_base + ['frr-exporter', 'port'])
+          config.set(new_base + ['frr-exporter', 'port'], value=tmp)
+        if config.exists(old_base + ['frr-exporter', 'vrf']):
+          tmp = config.return_value(old_base + ['frr-exporter', 'vrf'])
+          config.set(new_base + ['frr-exporter', 'vrf'], value=tmp)
+        config.delete(old_base + ['frr-exporter'])