Metadata-Version: 2.1
Name: monitoring-utils
Version: 2.2.0.post2
Summary: Utilities for monitoring scripts, plugins and other
Home-page: https://github.com/f-froehlich/monitoring-utils
Author: Fabian Fröhlich
Author-email: mail@confgen.org
License: AGPLv3
Download-URL: https://pypi.org/project/monitoring-utils/
Keywords: icinga,icinga2,icinga2-plugin,monitoring,check,nagios,nagios-plugin,nrpe,healthcheck,serverstatus,security,security-tools
Platform: UNKNOWN
Description-Content-Type: text/markdown

Monitoring utils
================
Monitoring utils are the background magic for my plugins, scripts and more

Copyright (c) 2020 Fabian Fröhlich <mail@confgen.org> [https://icinga2.confgen.org](https://icinga2.confgen.org)

Full License Information see  [LICENSE](https://github.com/f-froehlich/monitoring-utils/blob/master/LICENSE) file in root directory of this source code and License section of this File.

***NOTE:*** This is only an utility tool and the background magic of our [monitoring plugins](https://github.com/f-froehlich/monitoring-utils) and [monitoring scripts](https://github.com/f-froehlich/monitoring-scripts).

# Donate
This project needs donations. Please check out [https://icinga2.confgen.org/Donate](https://icinga2.confgen.org/Donate) for details.


# Quick setup
See our [documentation](https://icinga2.confgen.org) for details.

## Required
* install python 3.7 (other versions may also work)
* install python3-pip
* `pip3 install monitoring-utils`


# License
This section contains the additional terms of the AGPLv3 license agreement, a copy of the AGPLv3 is included in the [LICENSE](https://github.com/f-froehlich/monitoring-utils/blob/master/LICENSE) file.

1. Adaptation of the [README.md](https://github.com/f-froehlich/monitoring-utils/blob/master/REDME.md) is prohibited. The file must also be included with each copy without any modification. 

2. Adjustments of any kind must be listed in the attached [CHANGELOG.md](https://github.com/f-froehlich/monitoring-utils/blob/master/CHANGELOG.md) file. It is sufficient to name the change and the reason for the change here and to give appropriate references to the processing in the source code at the appropriate place.

3. All edited copies must be made available on [github](https://github.com). You have to fork the original repository or use a fork from the original repository.

4. You have to place the following link on your Homepage in a suitable place, if you using this software ***not*** only for your own Servers, Applications, ...:

    ```html
    We using monitoring tools from <a href="https://icinga2.confgen.org">Fabian Fr&ouml;hlich</a>
   ```

    The wording is decisive here, so another language may be used. Attributes of the link may also be adjusted, but the link must be followable by web crawlers (e.g. Googlebot).

    Furthermore, the imprint has to include a clear reference to the original github repository [https://github.com/f-froehlich/monitoring-utils](https://github.com/f-froehlich/monitoring-utils) as well as the link mentioned above in the body text.

5. You are not allowed to earn money with this tool.


Contributors
============

| Name | email | info |
|------|-------|------|
| Fabian Fröhlich | mail@confgen.org | Main contributor and code owner |


Changelog
=========

# 1.0.0
* Adding some check plugins
    * SSHD security
    * UFW status
    * Existing users
    * Group members
    * Page content

# 2.0.0
* Add signals, logging and debugging
* Create status builder with multiline outputs
* Add base plugin
* Add base notification and service notification
* Add web and cli executor
* Add logging to all scripts
* replace exit status with status builder
* Use executors
* Update package structure
* Refactoring checks
* Add Telegram notification

# 2.1.0
* Add some DNS functionality
* Add [Nmap Scan](https://github.com/f-froehlich/nmap-scan) functionality
* Add Nmap script execution functionality
* Checks added:
    * check_ciphers
    * check_open_ports
    * check_dnssec_status
    * check_reboot_required
    * check_spf

# 2.1.0
* Checks added:
    * DS18B20

# 2.2.0
* Checks modified:
    * check reboot required now has an option to succeed if reboot is scheduled
* Webserver checks added:
    * check apache proxy requests
* SNMP Checks added:
    * UPS
        * Bad battery packs
        * Battery capacity
        * Battery packs attached
        * Remaining runtime
        * Battery replacement needed
        * Battery status
        * Battery temperature
        * Diagnostic test result
        * Last diagnostic test result time
    * Synology
        * CPU-fan status
        * Disk temperature
        * GPU info
        * Power status
        * RAID status
        * Service running
        * Service used
        * SMART
        * Space IO
        * Storage IO
        * System status
        * Temperature
        * Upgrade
    * Disk load
    * CPU Load
    * Memory Load



