PyPI - check_systemd - Versions diffs - 2.3.0__tar.gz → 2.3.1__tar.gz - Mend

check_systemd 2.3.0tar.gz → 2.3.1tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (13) hide show

{check_systemd-2.3.0 → check_systemd-2.3.1}/MANIFEST.in RENAMED Viewed

@@ -1,3 +1,2 @@
 include LICENSE
 prune test
-prune systemd_source_code

{check_systemd-2.3.0 → check_systemd-2.3.1}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: check_systemd
-Version: 2.3.0
+Version: 2.3.1
 Summary: Nagios / Icinga monitoring plugin to check systemd for failed units.
 Home-page: https://github.com/Josef-Friedrich/check_systemd
 Author: Josef Friedrich
@@ -11,16 +11,14 @@ Description: [![pypi.org](http://img.shields.io/pypi/v/check_systemd.svg)](https
         # check_systemd
-        `check_systemd` is a
-        [Nagios](https://www.nagios.org) / [Icinga](https://icinga.com)
-        monitoring plugin to check [systemd](https://systemd.io) for failed
-        units.
-        This Python script will report a degraded system to your monitoring solution.
-        It requires only the
-        [nagiosplugin](https://nagiosplugin.readthedocs.io/en/stable) library.
-        You can also test a single service with the `-u, --unit` parameter.
+        `check_systemd` is a [Nagios](https://www.nagios.org) /
+        [Icinga](https://icinga.com) monitoring plugin to check
+        [systemd](https://systemd.io). This Python script will report a degraded
+        system to your monitoring solution. It can also be used to monitor
+        individual systemd services (with the `-u, --unit` parameter) and timers
+        units (with the `-t, --dead-timers` parameter). The only dependency the
+        plugin needs is the Python library
+        [nagiosplugin](https://nagiosplugin.readthedocs.io/en/stable).
         ## Installation
@@ -28,13 +26,18 @@ Description: [![pypi.org](http://img.shields.io/pypi/v/check_systemd.svg)](https
         pip3 install check_systemd
         ```
+        ## Packages
+        * Debian ([package](https://ftp-master.debian.org/new/monitoring-plugins-systemd_2.3.0+ds-1.html), [source code](https://salsa.debian.org/python-team/packages/monitoring-plugins-systemd/-/tree/debian/master/debian)): work in progress
+        * NixOS ([package](https://search.nixos.org/packages?channel=unstable&query=check_systemd), [source code](https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/servers/monitoring/nagios/plugins/check_systemd.nix)): `nix-env -iA nixos.check_systemd`
         ## Command line interface
         ```
         usage: check_systemd [-h] [-u UNIT | -e UNIT] [-n] [-w SECONDS] [-c SECONDS]
                              [-t] [-W SECONDS] [-C SECONDS] [-i] [-v] [-V]
-        Copyright (c) 2014-18 Andrea Briganti a.k.a 'Kbyte' <kbytesys@gmail.com>
+        Copyright (c) 2014-18 Andrea Briganti <kbytesys@gmail.com>
         Copyright (c) 2019-21 Josef Friedrich <josef@friedrich.rocks>
         Nagios / Icinga monitoring plugin to check systemd.
@@ -97,9 +100,9 @@ Description: [![pypi.org](http://img.shields.io/pypi/v/check_systemd.svg)](https
         ## Project pages
-        * https://github.com/Josef-Friedrich/check_systemd
-        * https://exchange.icinga.com/joseffriedrich/check_systemd
-        * https://exchange.nagios.org/directory/Plugins/System-Metrics/Processes/check_systemd/details
+        * on [github.com](https://github.com/Josef-Friedrich/check_systemd)
+        * on [icinga.com](https://exchange.icinga.com/joseffriedrich/check_systemd)
+        * on [nagios.org](https://exchange.nagios.org/directory/Plugins/System-Metrics/Processes/check_systemd/details)
         ## Behind the scenes
@@ -127,6 +130,12 @@ Description: [![pypi.org](http://img.shields.io/pypi/v/check_systemd.svg)](https
         systemctl list-timers --all
         ```
+        To learn how `systemd` produces the text output on the command line, it
+        is worthwhile to take a look at  `systemd`’s source
+        code. Files relevant for text output are:
+        [basic/time-util.c](https://github.com/systemd/systemd/blob/main/src/basic/time-util.c),
+        [analyze/analyze.c](https://github.com/systemd/systemd/blob/main/src/analyze/analyze.c).
         ## Testing
         ```
@@ -139,10 +148,11 @@ Description: [![pypi.org](http://img.shields.io/pypi/v/check_systemd.svg)](https
         ## Deploying
-        Edit version number in check_systemd.py (without `v`)
+        Edit the version number in check_systemd.py (without `v`). Use the `-s`
+        option to sign the tag (required for the Debian package).
         ```
-        git tag v2.0.11
+        git tag -s v2.0.11
         git push --tags
         ```

{check_systemd-2.3.0 → check_systemd-2.3.1}/README.md RENAMED Viewed

@@ -3,16 +3,14 @@
 # check_systemd
-`check_systemd` is a
-[Nagios](https://www.nagios.org) / [Icinga](https://icinga.com)
-monitoring plugin to check [systemd](https://systemd.io) for failed
-units.
-This Python script will report a degraded system to your monitoring solution.
-It requires only the
-[nagiosplugin](https://nagiosplugin.readthedocs.io/en/stable) library.
-You can also test a single service with the `-u, --unit` parameter.
+`check_systemd` is a [Nagios](https://www.nagios.org) /
+[Icinga](https://icinga.com) monitoring plugin to check
+[systemd](https://systemd.io). This Python script will report a degraded
+system to your monitoring solution. It can also be used to monitor
+individual systemd services (with the `-u, --unit` parameter) and timers
+units (with the `-t, --dead-timers` parameter). The only dependency the
+plugin needs is the Python library
+[nagiosplugin](https://nagiosplugin.readthedocs.io/en/stable).
 ## Installation
@@ -20,13 +18,18 @@ You can also test a single service with the `-u, --unit` parameter.
 pip3 install check_systemd
 ```
+## Packages
+* Debian ([package](https://ftp-master.debian.org/new/monitoring-plugins-systemd_2.3.0+ds-1.html), [source code](https://salsa.debian.org/python-team/packages/monitoring-plugins-systemd/-/tree/debian/master/debian)): work in progress
+* NixOS ([package](https://search.nixos.org/packages?channel=unstable&query=check_systemd), [source code](https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/servers/monitoring/nagios/plugins/check_systemd.nix)): `nix-env -iA nixos.check_systemd`
 ## Command line interface
 ```
 usage: check_systemd [-h] [-u UNIT | -e UNIT] [-n] [-w SECONDS] [-c SECONDS]
                      [-t] [-W SECONDS] [-C SECONDS] [-i] [-v] [-V]
-Copyright (c) 2014-18 Andrea Briganti a.k.a 'Kbyte' <kbytesys@gmail.com>
+Copyright (c) 2014-18 Andrea Briganti <kbytesys@gmail.com>
 Copyright (c) 2019-21 Josef Friedrich <josef@friedrich.rocks>
 Nagios / Icinga monitoring plugin to check systemd.
@@ -89,9 +92,9 @@ Performance data:
 ## Project pages
-* https://github.com/Josef-Friedrich/check_systemd
-* https://exchange.icinga.com/joseffriedrich/check_systemd
-* https://exchange.nagios.org/directory/Plugins/System-Metrics/Processes/check_systemd/details
+* on [github.com](https://github.com/Josef-Friedrich/check_systemd)
+* on [icinga.com](https://exchange.icinga.com/joseffriedrich/check_systemd)
+* on [nagios.org](https://exchange.nagios.org/directory/Plugins/System-Metrics/Processes/check_systemd/details)
 ## Behind the scenes
@@ -119,6 +122,12 @@ To find dead timers this plugin launches:
 systemctl list-timers --all
 ```
+To learn how `systemd` produces the text output on the command line, it
+is worthwhile to take a look at  `systemd`’s source
+code. Files relevant for text output are:
+[basic/time-util.c](https://github.com/systemd/systemd/blob/main/src/basic/time-util.c),
+[analyze/analyze.c](https://github.com/systemd/systemd/blob/main/src/analyze/analyze.c).
 ## Testing
 ```
@@ -131,9 +140,10 @@ tox
 ## Deploying
-Edit version number in check_systemd.py (without `v`)
+Edit the version number in check_systemd.py (without `v`). Use the `-s`
+option to sign the tag (required for the Debian package).
 ```
-git tag v2.0.11
+git tag -s v2.0.11
 git push --tags
 ```

{check_systemd-2.3.0 → check_systemd-2.3.1}/check_systemd.egg-info/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: check-systemd
-Version: 2.3.0
+Version: 2.3.1
 Summary: Nagios / Icinga monitoring plugin to check systemd for failed units.
 Home-page: https://github.com/Josef-Friedrich/check_systemd
 Author: Josef Friedrich
@@ -11,16 +11,14 @@ Description: [![pypi.org](http://img.shields.io/pypi/v/check_systemd.svg)](https
         # check_systemd
-        `check_systemd` is a
-        [Nagios](https://www.nagios.org) / [Icinga](https://icinga.com)
-        monitoring plugin to check [systemd](https://systemd.io) for failed
-        units.
-        This Python script will report a degraded system to your monitoring solution.
-        It requires only the
-        [nagiosplugin](https://nagiosplugin.readthedocs.io/en/stable) library.
-        You can also test a single service with the `-u, --unit` parameter.
+        `check_systemd` is a [Nagios](https://www.nagios.org) /
+        [Icinga](https://icinga.com) monitoring plugin to check
+        [systemd](https://systemd.io). This Python script will report a degraded
+        system to your monitoring solution. It can also be used to monitor
+        individual systemd services (with the `-u, --unit` parameter) and timers
+        units (with the `-t, --dead-timers` parameter). The only dependency the
+        plugin needs is the Python library
+        [nagiosplugin](https://nagiosplugin.readthedocs.io/en/stable).
         ## Installation
@@ -28,13 +26,18 @@ Description: [![pypi.org](http://img.shields.io/pypi/v/check_systemd.svg)](https
         pip3 install check_systemd
         ```
+        ## Packages
+        * Debian ([package](https://ftp-master.debian.org/new/monitoring-plugins-systemd_2.3.0+ds-1.html), [source code](https://salsa.debian.org/python-team/packages/monitoring-plugins-systemd/-/tree/debian/master/debian)): work in progress
+        * NixOS ([package](https://search.nixos.org/packages?channel=unstable&query=check_systemd), [source code](https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/servers/monitoring/nagios/plugins/check_systemd.nix)): `nix-env -iA nixos.check_systemd`
         ## Command line interface
         ```
         usage: check_systemd [-h] [-u UNIT | -e UNIT] [-n] [-w SECONDS] [-c SECONDS]
                              [-t] [-W SECONDS] [-C SECONDS] [-i] [-v] [-V]
-        Copyright (c) 2014-18 Andrea Briganti a.k.a 'Kbyte' <kbytesys@gmail.com>
+        Copyright (c) 2014-18 Andrea Briganti <kbytesys@gmail.com>
         Copyright (c) 2019-21 Josef Friedrich <josef@friedrich.rocks>
         Nagios / Icinga monitoring plugin to check systemd.
@@ -97,9 +100,9 @@ Description: [![pypi.org](http://img.shields.io/pypi/v/check_systemd.svg)](https
         ## Project pages
-        * https://github.com/Josef-Friedrich/check_systemd
-        * https://exchange.icinga.com/joseffriedrich/check_systemd
-        * https://exchange.nagios.org/directory/Plugins/System-Metrics/Processes/check_systemd/details
+        * on [github.com](https://github.com/Josef-Friedrich/check_systemd)
+        * on [icinga.com](https://exchange.icinga.com/joseffriedrich/check_systemd)
+        * on [nagios.org](https://exchange.nagios.org/directory/Plugins/System-Metrics/Processes/check_systemd/details)
         ## Behind the scenes
@@ -127,6 +130,12 @@ Description: [![pypi.org](http://img.shields.io/pypi/v/check_systemd.svg)](https
         systemctl list-timers --all
         ```
+        To learn how `systemd` produces the text output on the command line, it
+        is worthwhile to take a look at  `systemd`’s source
+        code. Files relevant for text output are:
+        [basic/time-util.c](https://github.com/systemd/systemd/blob/main/src/basic/time-util.c),
+        [analyze/analyze.c](https://github.com/systemd/systemd/blob/main/src/analyze/analyze.c).
         ## Testing
         ```
@@ -139,10 +148,11 @@ Description: [![pypi.org](http://img.shields.io/pypi/v/check_systemd.svg)](https
         ## Deploying
-        Edit version number in check_systemd.py (without `v`)
+        Edit the version number in check_systemd.py (without `v`). Use the `-s`
+        option to sign the tag (required for the Debian package).
         ```
-        git tag v2.0.11
+        git tag -s v2.0.11
         git push --tags
         ```

{check_systemd-2.3.0 → check_systemd-2.3.1}/check_systemd.py RENAMED Viewed

@@ -1,11 +1,18 @@
 #!/usr/bin/env python3
 """
-``check_system`` is a Nagios / Icinga monitoring plugin to check systemd.
+``check_system`` is a `Nagios <https://www.nagios.org>`_ / `Icinga
+<https://icinga.com>`_ monitoring plugin to check systemd. This Python script
+will report a degraded system to your monitoring solution. It can also be used
+to monitor individual systemd services (with the ``-u, --unit`` parameter) and
+timers units (with the ``-t, --dead-timers`` parameter).
+To lern more about the project, please visit the repository on `Github
+<https://github.com/Josef-Friedrich/check_systemd>`_.
 This plugin is based on a Python package named `nagiosplugin
 <https://pypi.org/project/nagiosplugin/>`_. ``nagiosplugin`` has a fine-grained
-class model to separate concerns. A Nagios / Icinga plugin need to perform
+class model to separate concerns. A Nagios / Icinga plugin must perform these
 three steps: data `acquisition`, `evaluation` and `presentation`.
 ``nagiosplugin`` provides for this three steps three classes: ``Resource``,
 ``Context``, ``Summary``. ``check_systemd`` extends this three model classes in
@@ -39,7 +46,7 @@ import re
 import nagiosplugin
 from nagiosplugin import Metric
-__version__ = '2.3.0'
+__version__ = '2.3.1'
 class SystemctlListUnitsResource(nagiosplugin.Resource):
@@ -418,6 +425,7 @@ class UnitContext(nagiosplugin.Context):
         :param metric: associated metric that is to be evaluated
         :param resource: resource that produced the associated metric
             (may optionally be consulted)
         :returns: :class:`~.result.Result`
         """
         if metric.value:
@@ -450,6 +458,7 @@ class DeadTimersContext(nagiosplugin.Context):
         :param metric: associated metric that is to be evaluated
         :param resource: resource that produced the associated metric
             (may optionally be consulted)
         :returns: :class:`~.result.Result`
         """
         return self.result_cls(metric.value, metric=metric, hint=metric.name)
@@ -474,6 +483,9 @@ class PerformanceDataContext(nagiosplugin.Context):
 class SystemdSummary(nagiosplugin.Summary):
+    """Format the different status lines. A subclass of `nagiosplugin.Summary
+    <https://github.com/mpounsett/nagiosplugin/blob/master/nagiosplugin/summary.py>`_.
+    """
     def ok(self, results):
         """Formats status line when overall state is ok.
@@ -490,6 +502,7 @@ class SystemdSummary(nagiosplugin.Summary):
         """Formats status line when overall state is not ok.
         :param results: :class:`~.result.Results` container
         :returns: status line
         """
         summary = []
@@ -502,6 +515,7 @@ class SystemdSummary(nagiosplugin.Summary):
         """Provides extra lines if verbose plugin execution is requested.
         :param results: :class:`~.result.Results` container
         :returns: list of strings
         """
         summary = []
@@ -516,7 +530,7 @@ def get_argparser():
         prog='check_systemd',  # To get the right command name in the README.
         formatter_class=lambda prog: argparse.RawDescriptionHelpFormatter(prog, width=80),  # noqa: E501
         description=  # noqa: E251
-        'Copyright (c) 2014-18 Andrea Briganti a.k.a \'Kbyte\' <kbytesys@gmail.com>\n'  # noqa: E501
+        'Copyright (c) 2014-18 Andrea Briganti <kbytesys@gmail.com>\n'
         'Copyright (c) 2019-21 Josef Friedrich <josef@friedrich.rocks>\n'
         '\n'
         'Nagios / Icinga monitoring plugin to check systemd.\n',  # noqa: E501
@@ -638,13 +652,25 @@ def get_argparser():
 def main():
-    """The main function"""
+    """The main entry point of the monitoring plugin. First the command line
+    arguments are read into the variable ``args``. The configuration of this
+    ``args`` object decides which instances of the `Resource
+    <https://github.com/mpounsett/nagiosplugin/blob/master/nagiosplugin/resource.py>`_,
+    `Context
+    <https://github.com/mpounsett/nagiosplugin/blob/master/nagiosplugin/context.py>`_
+    and `Summary
+    <https://github.com/mpounsett/nagiosplugin/blob/master/nagiosplugin/summary.py>`_
+    subclasses are assembled in a list called ``tasks``. This list is passed
+    the main class of the ``nagiosplugin`` library: the `Check
+    <https://nagiosplugin.readthedocs.io/en/stable/api/core.html#nagiosplugin-check>`_
+    class.
+    """
     args = get_argparser().parse_args()
-    objects = []
+    tasks = []
     if args.dead_timers:
-        objects += [
+        tasks += [
             SystemctlListTimersResource(
                 excludes=args.exclude,
                 warning=args.dead_timers_warning,
@@ -654,9 +680,9 @@ def main():
         ]
     if args.unit:
-        objects.append(SystemctlIsActiveResource(unit=args.unit))
+        tasks.append(SystemctlIsActiveResource(unit=args.unit))
     else:
-        objects += [
+        tasks += [
             SystemctlListUnitsResource(excludes=args.exclude),
             PerformanceDataContext(),
         ]
@@ -668,15 +694,15 @@ def main():
         )
         # systemd-analyze: boot not finshed exits with 1
         if analyse.returncode == 0:
-            objects.append(SystemdAnalyseResource())
+            tasks.append(SystemdAnalyseResource())
-    objects += [
+    tasks += [
         UnitContext(args),
         SystemdSummary()
     ]
     if not args.no_startup_time:
-        objects.append(
+        tasks.append(
             nagiosplugin.ScalarContext(
                 name='startup_time',
                 warning=args.warning,
@@ -684,13 +710,13 @@ def main():
             )
         )
     else:
-        objects.append(
+        tasks.append(
             nagiosplugin.ScalarContext(
                 name='startup_time'
             )
         )
-    check = nagiosplugin.Check(*objects)
+    check = nagiosplugin.Check(*tasks)
     check.main(args.verbose)