Class library for writing Nagios (Icinga) plugins
The nagiosplugin library
nagiosplugin is a Python class library which helps writing Nagios (or Icinga) compatible plugins easily in Python. It cares for much of the boilerplate code and default logic commonly found in Nagios checks, including:
- Nagios 3 Plugin API compliant parameters and output formatting
- Full Nagios range syntax support
- Automatic threshold checking
- Multiple independend measures
- Custom status line to communicate the main point quickly
- Long output and performance data
- Timeout handling
- Persistent “cookies” to retain state information between check runs
- Resume log file processing at the point where the last run left
- No dependencies beyond the Python standard library (except for Python 2.6).
nagiosplugin runs on POSIX and Windows systems. It is compatible with Python 3.4, Python 3.3, Python 3.2, and Python 2.7.
Feedback and Suggestions
nagiosplugin is primarily written and maintained by Christian Kauhaus <firstname.lastname@example.org>. Feel free to contact the author for bugs, suggestions and patches.
A public issue tracker can be found at https://bitbucket.org/flyingcircus/nagiosplugin/issues/.
The nagiosplugin package is released under the Zope Public License 2.1 (ZPL), a BSD-style Open Source license.
Getting the source
The source can be obtained via mercurial from https://bitbucket.org/gocept/nagiosplugin:
hg clone https://bitbucket.org/gocept/nagiosplugin
This package supports installation in a virtualenv using zc.buildout.
Creating a build with zc.buildout
First, create a virtualenv if not already present:
virtualenv -p python3.4 --no-setuptools .
zc.buildout will take care of all required dependencies:
bin/pip3.2 install -U zc.buildout bin/buildout
If you want to use another Python version like 2.7, just the same steps with the Python version substituted:
virtualenv -p python2.7 --no-setuptools . bin/pip2.7 install -U zc.buildout bin/buildout
When the buildout succeeds, run the unit test by invoking:
Our build server runs test against the trunk on a regular basis.
nagiosplugin also includes support for coverage reports. It aims at 100% test coverage where possible. The preferred way to get a coverate report is to use
to determine test coverage and open the report in a web browser. Alternatively, run
bin/coverage run bin/test
to get a purely text-based coverage report.
You may run the supplied examples with the local interpreter:
The documentation uses Sphinx. Build the documentation (buildout should have been running before to install Sphinx etc.):
make -C doc html
nagiosplugin has become what it is now with the help of many contributors from the community. We want to thank everyone who has invested time and energy to make nagiosplugin better:
- Wolfgang Schnerring <email@example.com> for thoughts on the design.
- Thomas Lotze <firstname.lastname@example.org> for improving the test infrastructure.
- Christian Theune <email@example.com> for comments and general feedback.
- Michael Howitz <firstname.lastname@example.org> and Andrei Chirila <email@example.com> for the Python 3 port.
- Birger Schmidt <firstname.lastname@example.org> for bug reports.
- Florian Lagg <LaggAt@lagg-asus1.lan> for Windows compatibility fixes
- Jeff Goldschrafe <email@example.com> for the Python 2.6 backport.
- José Manuel Fardello <firstname.lastname@example.org> for a logging fix.
- Jordan Metzmeier <email@example.com> for build fixes and Debian packaging.
- Andrey Panfilov <firstname.lastname@example.org> for a perfdata fix.
- Mihai Limbășan <email@example.com> for various output formatting fixes.
- Add optional keyword parameter verbose to Runtime.guarded(). This parameter allows to set verbose level in the early execution phase (#13).
- Allow Context.evaluate() return either a Result or ServiceState object. In case the latter is returned, it gets automatically wrapped in a Result object (#6).
- Fix bug that caused a UnicodeDecodeError when using non-ASCII characters in fmt_metric (#12).
- Print perfdata always on a single line (even in multi-line mode) to improve compatibility with various monitoring systems (#11).
- Mention that nagiosplugin also runs with Python 3.4 (no code changes necessary).
- Make name prefix in status output optional by allowing to assign None to Check.name.
- Accept bare metric as return value from Resource.probe().
- Fix bug where Context.describe() was not used to obtain metric description (#13162).
- Fix build failures with LANG=C (#13140).
- Remove length limitation of perfdata labels (#13214).
- Fix formatting of large integers as Metric values (#13287).
- Range: allow simple numerals as argument to Range() (#12658).
- Cookie: allow for empty state file specification (#12788).
- New Summary.empty method is called if there are no results present (#11593).
- Improve range violation wording (#11597).
- Ensure that nagiosplugin install correctly with current setuptools (#12660).
- Behave and do not attach anything to the root logger.
- Add debugging topic guide. Explain how to disable the timeout when using pdb (#11592).
- Identical to 1.1b1.
- Made compatible with Python 2.6 (#12297).
- Tutorial #3: check_users (#11539).
- Minor documentation improvements.
- LogTail returns lines as byte strings in Python 3 to avoid codec issues (#11564).
- LogTail gives a line-based iterator instead of a file object (#11564).
- Basic API docs for the most important classes (#11612).
- Made compatible with Python 2.7 (#11533).
- Made compatible with Python 3.3.
- Improve error reporting for missing contexts.
- Exit with code 3 if no metrics have been generated.
- Improve default Summary.verbose() to list all threshold violations.
- Move main source repository to https://bitbucket.org/gocept/nagiosplugin/ (#11561).
- API docs for the most important classes (#7939).
- Added two tutorials (#9425).
- Fix packaging issues.
- Completely reworked API. The new API is not compatible with the old 0.4 API so you must update your plugins.
- Python 3 support.
- The Cookie class is now basically a persistent dict and accepts key/value pairs. Cookie are stored as JSON files by default so they can be inspected by the system administrator (#9400).
- New LogTail class which provides convenient access to constantly growing log files which are eventually rotated.
- Windows port. nagiosplugin code now runs under pywin32 (#10899).
- Include examples in egg release (#9901).
Bugfix release to fix issues reported by users.
- Improve Mac OS X compatibility (#8755).
- Include examples in distribution (#8555).
- Change __str__ representation of large numbers to avoid scientific notation.
- Packaging issues.
- Fix distribution to install correctly.
- Documentation: tutorial and topic guides.
- Initial public release.