From ac73200e4f0cf4020dfcd0a11e6004bca479253f Mon Sep 17 00:00:00 2001 From: zsdc Date: Tue, 7 Dec 2021 22:41:27 +0200 Subject: logs: T3774: Added CLI options to control atop logs rotation Added CLI options to generate logrotate configuration file for atop logs --- data/templates/logs/logrotate/vyos-atop.tmpl | 20 ++++++ interface-definitions/system-logs.xml.in | 57 +++++++++++++++++ smoketest/scripts/cli/test_system_logs.py | 91 ++++++++++++++++++++++++++++ src/conf_mode/system-logs.py | 76 +++++++++++++++++++++++ 4 files changed, 244 insertions(+) create mode 100644 data/templates/logs/logrotate/vyos-atop.tmpl create mode 100644 interface-definitions/system-logs.xml.in create mode 100755 smoketest/scripts/cli/test_system_logs.py create mode 100755 src/conf_mode/system-logs.py diff --git a/data/templates/logs/logrotate/vyos-atop.tmpl b/data/templates/logs/logrotate/vyos-atop.tmpl new file mode 100644 index 000000000..797bf237f --- /dev/null +++ b/data/templates/logs/logrotate/vyos-atop.tmpl @@ -0,0 +1,20 @@ +/var/log/atop/atop.log { + daily + dateext + dateformat _%Y-%m-%d_%H-%M-%S + maxsize {{ maxsize|default('10') }}M + missingok + nocompress + nocreate + nomail + rotate {{ rotate|default('10') }} + prerotate + # stop the service + systemctl stop atop.service + endscript + postrotate + # start atop service again + systemctl start atop.service + endscript +} + diff --git a/interface-definitions/system-logs.xml.in b/interface-definitions/system-logs.xml.in new file mode 100644 index 000000000..677f476ff --- /dev/null +++ b/interface-definitions/system-logs.xml.in @@ -0,0 +1,57 @@ + + + + + + + Logging options + 9999 + + + + + Logrotate options + + + + + Atop logs options + + + + + Size of a single log file that triggers rotation + + u32:1-1024 + Size in MB + + + + + The size must be between 1 and 1024 MB + + 10 + + + + Count of rotations before old logs will be deleted + + u32:1-100 + Rotations + + + + + The count must be between 1 and 100 + + 10 + + + + + + + + + + diff --git a/smoketest/scripts/cli/test_system_logs.py b/smoketest/scripts/cli/test_system_logs.py new file mode 100755 index 000000000..bb23dcb1d --- /dev/null +++ b/smoketest/scripts/cli/test_system_logs.py @@ -0,0 +1,91 @@ +#!/usr/bin/env python3 +# +# Copyright (C) 2021 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 . + +import re +import unittest +from base_vyostest_shim import VyOSUnitTestSHIM +from vyos.util import read_file + +# path to logrotate config for atop +logrotate_atop_file = '/etc/logrotate.d/vyos-atop' +# default values +default_atop_maxsize = '10M' +default_atop_rotate = '10' + +base_path = ['system', 'logs'] + + +def logrotate_config_parse(file_path): + # read the file + logrotate_config = read_file(file_path) + # create regex for parsing options + regex_options = re.compile( + r'(^\s+(?Ppostrotate|prerotate|firstaction|lastaction|preremove)\n(?P((?!endscript).)*)\n\s+endscript\n)|(^\s+(?P[\S]+)([ \t]+(?P\S+))*$)', + re.M | re.S) + # create empty dict for config + logrotate_config_dict = {} + # fill dictionary with actual config + for option in regex_options.finditer(logrotate_config): + option_name = option.group('option_name') + option_value = option.group('option_value') + option_name_script = option.group('option_name_script') + option_value_script = option.group('option_value_script') + if option_name: + logrotate_config_dict[option_name] = option_value + if option_name_script: + logrotate_config_dict[option_name_script] = option_value_script + + # return config dictionary + return (logrotate_config_dict) + + +class TestSystemLogs(VyOSUnitTestSHIM.TestCase): + + def tearDown(self): + self.cli_delete(base_path) + self.cli_commit() + + def test_logs_defaults(self): + # test with empty section for default values + self.cli_set(base_path) + self.cli_commit() + + # read the config file and check content + logrotate_config = logrotate_config_parse(logrotate_atop_file) + self.assertEqual(logrotate_config['maxsize'], default_atop_maxsize) + self.assertEqual(logrotate_config['rotate'], default_atop_rotate) + + def test_logs_atop_maxsize(self): + # test for maxsize option + self.cli_set(base_path + ['logrotate', 'atop', 'maxsize', '50']) + self.cli_commit() + + # read the config file and check content + logrotate_config = logrotate_config_parse(logrotate_atop_file) + self.assertEqual(logrotate_config['maxsize'], '50M') + + def test_logs_atop_rotate(self): + # test for rotate option + self.cli_set(base_path + ['logrotate', 'atop', 'rotate', '50']) + self.cli_commit() + + # read the config file and check content + logrotate_config = logrotate_config_parse(logrotate_atop_file) + self.assertEqual(logrotate_config['rotate'], '50') + + +if __name__ == '__main__': + unittest.main(verbosity=2, failfast=True) diff --git a/src/conf_mode/system-logs.py b/src/conf_mode/system-logs.py new file mode 100755 index 000000000..8eb95e543 --- /dev/null +++ b/src/conf_mode/system-logs.py @@ -0,0 +1,76 @@ +#!/usr/bin/env python3 +# +# Copyright (C) 2021 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 . + +from sys import exit + +from vyos import ConfigError +from vyos import airbag +from vyos.config import Config +from vyos.logger import syslog +from vyos.template import render_to_string +from vyos.util import read_file, write_file +airbag.enable() + +# path to logrotate config for atop +logrotate_atop_file = '/etc/logrotate.d/vyos-atop' + + +def get_config(config=None): + if config: + conf = config + else: + conf = Config() + + base = ['system', 'logs'] + logs_config = conf.get_config_dict(base) + + return logs_config + + +def verify(logs_config): + # Nothing to verify here + pass + + +def generate(logs_config): + # get configuration for logrotate atop + logrotate_atop = logs_config.get('logs', {}).get('logrotate', + {}).get('atop', {}) + # read current config file for atop + logrotate_atop_current = read_file(logrotate_atop_file) + # generate new config file for atop + logrotate_atop_new = render_to_string('logs/logrotate/vyos-atop.tmpl', + logrotate_atop) + # update configuration files if this is necessary + if logrotate_atop_new != logrotate_atop_current: + syslog.debug('Adding logrotate config for atop') + write_file(logrotate_atop_file, logrotate_atop_new) + + +def apply(logs_config): + # No further actions needed + pass + + +if __name__ == '__main__': + try: + c = get_config() + verify(c) + generate(c) + apply(c) + except ConfigError as e: + print(e) + exit(1) -- cgit v1.2.3