|
|
|
|
<!--
|
|
|
|
|
SPDX-FileCopyrightText: 2022 LEdoian <checklib@pokemon.ledoian.cz>
|
|
|
|
|
SPDX-License-Identifier: WTFPL
|
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
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](https://www.monitoring-plugins.org/doc/guidelines.html)
|
|
|
|
|
and in [Icinga 2
|
|
|
|
|
documentation](https://icinga.com/docs/icinga-2/latest/doc/05-service-monitoring/#plugin-api).
|
|
|
|
|
|
|
|
|
|
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](https://pypi.org/project/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](mailto: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](https://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 anyone would
|
|
|
|
|
like that, let me know, I might find a bit of time to set something up.)
|
|
|
|
|
|
|
|
|
|
Licence
|
|
|
|
|
----
|
|
|
|
|
|
|
|
|
|
See the respective SPDX comments. Most of the code is WTFPL, with
|
|
|
|
|
uncopyrightable config files being under CC0. (Currently the code is just dumb
|
|
|
|
|
implementation of the plugin spec, so there is little creative value.)
|
|
|
|
|
|
|
|
|
|
I might decide to change the licence 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 :-)).
|
