refactor: convert .format() string formatting to f-strings across all plugins

Author: markuslf

CHANGELOG.md

@@ -75,6 +75,7 @@ Grafana:
 
 Monitoring Plugins:
 
+* all plugins: convert `.format()` string formatting to f-strings
 * all plugins: ignore unknown arguments instead of generating an error (this helps with updating Icinga and Nagios service definitions considerably)
 * by-ssh, by-winrm, disk-usage, example, file-ownership, fs-ro, infomaniak-events, journald-query, logfile, matomo-reporting, mysql-logfile, php-status, pip-updates, systemd-unit: fix `append` parameters so that user-specified values replace defaults instead of being appended to them ([#540](https://github.com/Linuxfabrik/monitoring-plugins/issues/540))
 * cpu-usage: remove `--top` parameter (the top N processes by CPU time are now reported by the procs check via `--top`)

check-plugins/about-me/about-me

@@ -24,7 +24,7 @@ from lib.globals import (STATE_CRIT, STATE_OK,  # pylint: disable=C0413
                           STATE_UNKNOWN, STATE_WARN)
 
 __author__ = 'Linuxfabrik GmbH, Zurich/Switzerland'
-__version__ = '2025100601'
+__version__ = '2026040801'
 
 DESCRIPTION = 'Checks how well an Apache httpd server is performing.'
 
@@ -44,7 +44,7 @@ def parse_args():
     parser.add_argument(
         '-V', '--version',
         action='version',
-        version='%(prog)s: v{} by {}'.format(__version__, __author__)
+        version=f'%(prog)s: v{__version__} by {__author__}'
     )
 
     parser.add_argument(
@@ -242,14 +242,14 @@ def main():
     # If ExtendedStatus is off:
     if 'Uptime' not in apache:
         # "ExtendedStatus off" just reports BusyWorkers, IdleWorkers and Scoreboard
-        msg = '{}/{} workers busy ({}%{}; {} "G"), {} idle, {} free'.format(
-            apache['BusyWorkers'],
-            apache['TotalWorkers'],
-            apache['WorkerUsagePercentage'],
-            lib.base.state2str(state, prefix=' '),
-            workers['finishing'],
-            apache['IdleWorkers'],
-            workers['free'],
+        msg = (
+            f'{apache["BusyWorkers"]}/{apache["TotalWorkers"]}'
+            f' workers busy'
+            f' ({apache["WorkerUsagePercentage"]}%'
+            f'{lib.base.state2str(state, prefix=" ")}'
+            f'; {workers["finishing"]} "G")'
+            f', {apache["IdleWorkers"]} idle'
+            f', {workers["free"]} free'
         )
 
         # over and out
@@ -262,31 +262,31 @@ def main():
 
     # get previous values
     prev_uptime = lib.cache.get(
-        'apache-httpd-status-{}-uptime'.format(args.URL),
+        f'apache-httpd-status-{args.URL}-uptime',
         filename='linuxfabrik-monitoring-plugins-apache-httpd-status.db',
     )
     prev_count = lib.cache.get(
-        'apache-httpd-status-{}-total-accesses'.format(args.URL),
+        f'apache-httpd-status-{args.URL}-total-accesses',
         filename='linuxfabrik-monitoring-plugins-apache-httpd-status.db',
     )
     prev_bcount = lib.cache.get(
-        'apache-httpd-status-{}-total-bytes'.format(args.URL),
+        f'apache-httpd-status-{args.URL}-total-bytes',
         filename='linuxfabrik-monitoring-plugins-apache-httpd-status.db',
     )
 
     # save current values
     lib.cache.set(
-        'apache-httpd-status-{}-uptime'.format(args.URL),
+        f'apache-httpd-status-{args.URL}-uptime',
         apache['Uptime'],
         filename='linuxfabrik-monitoring-plugins-apache-httpd-status.db',
     )
     lib.cache.set(
-        'apache-httpd-status-{}-total-accesses'.format(args.URL),
+        f'apache-httpd-status-{args.URL}-total-accesses',
         apache['Total Accesses'],
         filename='linuxfabrik-monitoring-plugins-apache-httpd-status.db',
     )
     lib.cache.set(
-        'apache-httpd-status-{}-total-bytes'.format(args.URL),
+        f'apache-httpd-status-{args.URL}-total-bytes',
         apache['Total Bytes'],
         filename='linuxfabrik-monitoring-plugins-apache-httpd-status.db',
     )
@@ -306,17 +306,17 @@ def main():
     perfdata += lib.base.get_perfdata('Uptime', apache['Uptime'], 's', None, None, 0, None) # pylint: disable=C0301
 
     if 'Total Duration' not in apache:
-        msg = '{}/{} workers busy ({}%{}; {} "G"), {} idle, {} free; {} accesses, {} traffic; Up {}'.format(
-            apache['BusyWorkers'],
-            apache['TotalWorkers'],
-            apache['WorkerUsagePercentage'],
-            lib.base.state2str(state, prefix=' '),
-            workers['finishing'],
-            apache['IdleWorkers'],
-            workers['free'],
-            lib.human.number2human(apache['Total Accesses']),
-            lib.human.bytes2human(apache['Total Bytes']),
-            lib.human.seconds2human(apache['Uptime']),
+        msg = (
+            f'{apache["BusyWorkers"]}/{apache["TotalWorkers"]}'
+            f' workers busy'
+            f' ({apache["WorkerUsagePercentage"]}%'
+            f'{lib.base.state2str(state, prefix=" ")}'
+            f'; {workers["finishing"]} "G")'
+            f', {apache["IdleWorkers"]} idle'
+            f', {workers["free"]} free'
+            f'; {lib.human.number2human(apache["Total Accesses"])} accesses'
+            f', {lib.human.bytes2human(apache["Total Bytes"])} traffic'
+            f'; Up {lib.human.seconds2human(apache["Uptime"])}'
         )
 
         # over and out
@@ -327,11 +327,11 @@ def main():
     # Some more variables in newer versions of mod_status
 
     prev_duration_global = lib.cache.get(
-        'apache-httpd-status-{}-total-duration'.format(args.URL),
+        f'apache-httpd-status-{args.URL}-total-duration',
         filename='linuxfabrik-monitoring-plugins-apache-httpd-status.db',
     )
     lib.cache.set(
-        'apache-httpd-status-{}-total-duration'.format(args.URL),
+        f'apache-httpd-status-{args.URL}-total-duration',
         apache['Total Duration'],
         filename='linuxfabrik-monitoring-plugins-apache-httpd-status.db',
     )
@@ -356,18 +356,18 @@ def main():
     perfdata += lib.base.get_perfdata('Stopping', apache['Stopping'], None, None, None, 0, None) if 'Stopping' in apache else '' # pylint: disable=C0301
     perfdata += lib.base.get_perfdata('Total Duration', duration_diff, 's', None, None, 0, None) if 'Total Duration' in apache else '' # pylint: disable=C0301
 
-    msg = '{}: {}/{} workers busy ({}%{}; {} "G"), {} idle, {} free; {} accesses, {} traffic; Up {}'.format(
-        apache['ServerName'],
-        apache['BusyWorkers'],
-        apache['TotalWorkers'],
-        apache['WorkerUsagePercentage'],
-        lib.base.state2str(state, prefix=' '),
-        workers['finishing'],
-        apache['IdleWorkers'],
-        workers['free'],
-        lib.human.number2human(apache['Total Accesses']),
-        lib.human.bytes2human(apache['Total Bytes']),
-        lib.human.seconds2human(apache['Uptime']),
+    msg = (
+        f'{apache["ServerName"]}:'
+        f' {apache["BusyWorkers"]}/{apache["TotalWorkers"]}'
+        f' workers busy'
+        f' ({apache["WorkerUsagePercentage"]}%'
+        f'{lib.base.state2str(state, prefix=" ")}'
+        f'; {workers["finishing"]} "G")'
+        f', {apache["IdleWorkers"]} idle'
+        f', {workers["free"]} free'
+        f'; {lib.human.number2human(apache["Total Accesses"])} accesses'
+        f', {lib.human.bytes2human(apache["Total Bytes"])} traffic'
+        f'; Up {lib.human.seconds2human(apache["Uptime"])}'
     )
 
     table_values = []

check-plugins/apache-httpd-status/apache-httpd-status

@@ -21,7 +21,7 @@ import lib.version  # pylint: disable=C0413
 from lib.globals import (STATE_UNKNOWN) # pylint: disable=C0413
 
 __author__ = 'Linuxfabrik GmbH, Zurich/Switzerland'
-__version__ = '2025100601'
+__version__ = '2026040801'
 
 DESCRIPTION = 'Tracks if Apache httpd is EOL.'
 
@@ -42,7 +42,7 @@ def parse_args():
     parser.add_argument(
         '-V', '--version',
         action='version',
-        version='%(prog)s: v{} by {}'.format(__version__, __author__)
+        version=f'%(prog)s: v{__version__} by {__author__}'
     )
 
     parser.add_argument(
@@ -170,7 +170,7 @@ def main():
 
     # over and out
     lib.base.oao(
-        'Apache httpd v{} ({})'.format(installed_version, msg),
+        f'Apache httpd v{installed_version} ({msg})',
         state,
         lib.base.get_perfdata(
             'apache-httpd-version',

check-plugins/apache-httpd-version/apache-httpd-version

@@ -21,7 +21,7 @@ import lib.version  # pylint: disable=C0413
 from lib.globals import (STATE_UNKNOWN) # pylint: disable=C0413
 
 __author__ = 'Linuxfabrik GmbH, Zurich/Switzerland'
-__version__ = '2025100601'
+__version__ = '2026040801'
 
 DESCRIPTION = 'Tracks if Apache Solr is EOL.'
 
@@ -43,7 +43,7 @@ def parse_args():
     parser.add_argument(
         '-V', '--version',
         action='version',
-        version='%(prog)s: v{} by {}'.format(__version__, __author__)
+        version=f'%(prog)s: v{__version__} by {__author__}'
     )
 
     parser.add_argument(
@@ -136,7 +136,7 @@ def parse_args():
 
 
 def get_installed_version(path):
-    success, result = lib.shell.shell_exec('{} version'.format(path))
+    success, result = lib.shell.shell_exec(f'{path} version')
     if not success:
         return ''
     stdout = result[0].strip()
@@ -164,7 +164,7 @@ def main():
     # fetch data
     installed_version = get_installed_version(args.PATH)
     if not installed_version:
-        lib.base.cu('Apache Solr `{}` not found.'.format(args.PATH))
+        lib.base.cu(f'Apache Solr `{args.PATH}` not found.')
     state, msg = lib.version.check_eol(
         'https://endoflife.date/api/solr.json',
         installed_version,
@@ -179,7 +179,7 @@ def main():
 
     # over and out
     lib.base.oao(
-        'Apache Solr v{} ({})'.format(installed_version, msg),
+        f'Apache Solr v{installed_version} ({msg})',
         state,
         lib.base.get_perfdata(
             'apache-solr-version',

check-plugins/apache-solr-version/apache-solr-version

@@ -23,7 +23,7 @@ from lib.globals import (STATE_CRIT, STATE_OK,  # pylint: disable=C0413
                           STATE_UNKNOWN, STATE_WARN)
 
 __author__ = 'Linuxfabrik GmbH, Zurich/Switzerland'
-__version__ = '2025100601'
+__version__ = '2026040801'
 
 DESCRIPTION = 'With this plugin you can track some values of the Axenita application.'
 
@@ -39,7 +39,7 @@ def parse_args():
     parser.add_argument(
         '-V', '--version',
         action='version',
-        version='%(prog)s: v{} by {}'.format(__version__, __author__)
+        version=f'%(prog)s: v{__version__} by {__author__}'
     )
 
     parser.add_argument(
@@ -165,45 +165,45 @@ def main():
     if achilles_maintenance:
         if achilles_maintenance['state'].upper() != 'SUCCESS':
             state = lib.base.get_worst(STATE_WARN, state)
-            msg = '{}/api/login/maintenance-state-active, state: {}{}'.format(args.URL, achilles_maintenance['state'], lib.base.state2str(state))
+            msg = f"{args.URL}/api/login/maintenance-state-active, state: {achilles_maintenance['state']}{lib.base.state2str(state)}"
             lib.base.oao(msg, state, perfdata, always_ok=args.ALWAYS_OK)
         if achilles_maintenance['data'] is not False:
             state = lib.base.get_worst(STATE_WARN, state)
-            msg += 'Axenita/Achilles is in maintenance mode {}, '.format(lib.base.state2str(state))
+            msg += f'Axenita/Achilles is in maintenance mode {lib.base.state2str(state)}, '
             perfdata += lib.base.get_perfdata('maintenance', 1, None, None, None, 0, 1)
         else:
             perfdata += lib.base.get_perfdata('maintenance', 0, None, None, None, 0, 1)
 
     if achilles_readmodel:
         if achilles_readmodel['state'].upper() != 'SUCCESS':
             state = lib.base.get_worst(STATE_WARN, state)
-            msg = '{}/api/admin/readmodel/state, state: {}{}'.format(args.URL, achilles_readmodel['state'], lib.base.state2str(state))
+            msg = f"{args.URL}/api/admin/readmodel/state, state: {achilles_readmodel['state']}{lib.base.state2str(state)}"
             lib.base.oao(msg, state, perfdata, always_ok=args.ALWAYS_OK)
         if achilles_readmodel['data']['readModelState'].upper() != 'DONE':
             state = lib.base.get_worst(STATE_WARN, state)
-            msg = '{}/api/admin/readmodel/state, data.readModelState: {}{}'.format(args.URL, achilles_readmodel['data']['readModelState'], lib.base.state2str(state))
+            msg = f"{args.URL}/api/admin/readmodel/state, data.readModelState: {achilles_readmodel['data']['readModelState']}{lib.base.state2str(state)}"
             lib.base.oao(msg, state, perfdata, always_ok=args.ALWAYS_OK)
-        msg += 'ReadModel: {}, '.format(achilles_readmodel['data']['message'])
+        msg += f"ReadModel: {achilles_readmodel['data']['message']}, "
         perfdata += lib.base.get_perfdata('currentInitRmStep', achilles_readmodel['data']['currentInitRmStep'], None, None, None, 0, None)
         perfdata += lib.base.get_perfdata('totalInitRmSteps', achilles_readmodel['data']['totalInitRmSteps'], None, None, None, 0, None)
         perfdata += lib.base.get_perfdata('totalDurationInitRm', achilles_readmodel['data']['totalDurationInitRm'], None, None, None, 0, None)
 
     if achilles_userinfo:
         if achilles_userinfo['state'].upper() != 'SUCCESS':
             state = lib.base.get_worst(STATE_WARN, state)
-            msg = '{}/api/admin/user-info/number-of-current-sessions, state: {}{}'.format(args.URL, achilles_userinfo['state'], lib.base.state2str(state))
+            msg = f"{args.URL}/api/admin/user-info/number-of-current-sessions, state: {achilles_userinfo['state']}{lib.base.state2str(state)}"
             lib.base.oao(msg, state, perfdata, always_ok=args.ALWAYS_OK)
-        msg += '{} users logged in, {} active sessions, '.format(achilles_userinfo['data']['loggedInUsers'], achilles_userinfo['data']['currentActiveSessions'])
+        msg += f"{achilles_userinfo['data']['loggedInUsers']} users logged in, {achilles_userinfo['data']['currentActiveSessions']} active sessions, "
         perfdata += lib.base.get_perfdata('loggedInUsers', achilles_userinfo['data']['loggedInUsers'], None, None, None, 0, None)
         perfdata += lib.base.get_perfdata('currentActiveSessions', achilles_userinfo['data']['currentActiveSessions'], None, None, None, 0, None)
 
     if achilles_buildinfo:
         if achilles_buildinfo['state'].upper() != 'SUCCESS':
             state = lib.base.get_worst(STATE_WARN, state)
-            msg = '{}/api/build-info, state: {}{}'.format(args.URL, achilles_buildinfo['state'], lib.base.state2str(state))
+            msg = f"{args.URL}/api/build-info, state: {achilles_buildinfo['state']}{lib.base.state2str(state)}"
             lib.base.oao(msg, state, perfdata, always_ok=args.ALWAYS_OK)
         axenita_ver = achilles_buildinfo['data']['version']
-        msg += '{} (timestamp {}), '.format(axenita_ver, achilles_buildinfo['data']['timestamp'])
+        msg += f"{axenita_ver} (timestamp {achilles_buildinfo['data']['timestamp']}), "
         axenita_ver = axenita_ver[8:8+axenita_ver.find('-')-1].replace('.', '')
         perfdata += lib.base.get_perfdata('axenita-version', axenita_ver, None, None, None, 0, None)
 

check-plugins/axenita-stats/axenita-stats

@@ -22,7 +22,7 @@ from lib.globals import (STATE_CRIT, STATE_OK,  # pylint: disable=C0413
                           STATE_UNKNOWN, STATE_WARN)
 
 __author__ = 'Linuxfabrik GmbH, Zurich/Switzerland'
-__version__ = '2025100601'
+__version__ = '2026040801'
 
 DESCRIPTION = 'Checks the date and return code of the last borgbackup, according to the logfile.'
 
@@ -38,7 +38,7 @@ def parse_args():
     parser.add_argument(
         '-V', '--version',
         action='version',
-        version='{0}: v{1} by {2}'.format('%(prog)s', __version__, __author__)
+        version=f'%(prog)s: v{__version__} by {__author__}'
     )
 
     parser.add_argument(
@@ -85,7 +85,7 @@ def main():
         # end: 2020-04-08 23:00:13
 
     if os.path.exists(path) <= 0 and not os.path.isfile(path):
-        lib.base.cu('Logfile {} not found or empty.'.format(path))
+        lib.base.cu(f'Logfile {path} not found or empty.')
 
     mount_lines = ''
     with open('/proc/mounts') as mountlist:
@@ -94,7 +94,7 @@ def main():
                 mount_lines += '* ' + line
 
     if mount_lines:
-        lib.base.oao('There are active borg mounts.\n\n{}'.format(mount_lines), STATE_WARN)
+        lib.base.oao(f'There are active borg mounts.\n\n{mount_lines}', STATE_WARN)
 
 
     logfile = open(path, 'r')
@@ -140,14 +140,14 @@ def main():
     duration = lib.time.timestrdiff(endtime, starttime)     # in seconds
     perfdata += lib.base.get_perfdata('duration', duration, 's', None, None, 0, None)
 
-    msg = 'Last Backup started {}, ended {}, took {}.\n'.format(starttime, endtime, lib.human.seconds2human(duration))
+    msg = f'Last Backup started {starttime}, ended {endtime}, took {lib.human.seconds2human(duration)}.\n'
     if state != STATE_OK:
         if last_starttime_state != STATE_OK:
             msg = 'Last backup is too long ago. ' + msg
         else:
             msg = 'One or more errors. ' + msg
-    msg += '* Create retc: {}, State: {}\n'.format(create_retc, lib.base.state2str(create_retc_state))
-    msg += '* Prune retc: {}, State: {}'.format(prune_retc, lib.base.state2str(prune_retc_state))
+    msg += f'* Create retc: {create_retc}, State: {lib.base.state2str(create_retc_state)}\n'
+    msg += f'* Prune retc: {prune_retc}, State: {lib.base.state2str(prune_retc_state)}'
 
     # over and out
     lib.base.oao(msg, state, perfdata)