/sol1-monitoring-plugins-lib

A python library for monitoring plugins from Sol1

Primary LanguagePythonMIT LicenseMIT

Sol1 Monitoring Plugins Library

Sol1 Monitoring Plugins Library are tools to assist in the creation of monitoring checks for Icinga2 and Nagios.

MonitoringPlugin

from sol1_monitoring_plugins_lib import MonitoringPlugin

The MonitoringPlugin class manages the state, output message and performance data of your check as well as returning this data and exiting the script.

It has been designed so you can add multiple tests and the class will intelligently manage the state and output for you.

Documentation You can find documentation in the docs folder. Code usage examples can be found in the examples folder.

Maturity: Stable.

Logging

from sol1_monitoring_plugins_lib import initLogging, initLoggingArgparse, DEFAULT_LOG_LEVELS

The Logging functions setup loguru based logging for monitoring plugins with settings that allow for simple debugging during development and a short history for production usage by default.

Documentation You can find documentation in the docs folder. Code usage examples can be found in the examples folder.

Maturity: Stable.

Development

Contributions are welcome, changes need to be backwards compatible.

Setup

python3 -m pip install --upgrade pip setuptools wheel twine pytest
python3 -m pip install -r requirements.txt

Build

python3 .\setup.py sdist bdist_wheel

Tests

Install build package to current directory

python3 -m pip install -e .

Run tests

python3 -m pytest tests/