A simple wrapper to make implementing Nagios/Icinga checks in Python simple
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
LEdoian d0e881d2f9 Add links to README (and few tweaks) 2 years ago
README.md Add links to README (and few tweaks) 2 years ago
TODO Add a README and a TODO 2 years ago
checklib.py [WIP] Initial version 2 years ago
example.py [WIP] Initial version 2 years ago

README.md

CheckLib: A simple wrapper to make implementing Nagios/Icinga checks in Python simple

TODO: Write a reasonable Readme :-)

Documentation

Probably only as a part of source code. Currently it is short and aimed at Python developers anyway.

The primary target are plugins for Icinga 2.

The plugin API is documented at monitoring-plugins.org and in Icinga 2 documentation.

Project goals (and non-goals)

The aim is to make writing simple Python checks really easy, and also to be lightweight. Therefore, only basic and common features will likely be implemented. (And last but not least, it mainly depends on my time :-))

If you need a fully-featured library, feel free to use Nagiosplugin.

I would like to keep this as a pure vanilla Python code. It lowers the barrier to code inspection and contribution and does not add dependencies, so that this can be used in very limited environments.

The exact scope is currently not rigorously defined, feel free to contact me if you are not sure.

Bugs, feedback, ideas, patches, contact &c.

Please send anything you have on your mind to checklib@pokemon.ledoian.cz.

I currently want to know if anyone else has tried to use the code :-)

For patches you can use git send-email. For more info, see git-send-email.io (or put "git send-email" into your favourite search engine).

(Emails sent there are currently not public, because I'm lazy. If any

Licence

Currently the code is just dumb implementation of the plugin spec, so there is little creative value. So WTFPL it is for now.

I might decide to change it later. Also, if any contributor comes by, they can steer the direction. I want to keep this as Free Software, though (wrote I when this project was marked as private :-)).

(TODO: Proper licencing, SPDX info, REUSE compliance)