Metadata-Version: 2.1
Name: nagios-check-supervisord
Version: 2.1.1
Summary: Check supervisord programs status Nagios plugin
Home-page: https://github.com/vint21h/nagios-check-supervisord/
Author: Alexei Andrushievich
Author-email: vint21h@vint21h.pp.ua
License: GPLv3+
Download-URL: https://github.com/vint21h/nagios-check-supervisord/archive/2.1.1.tar.gz
Keywords: nagios,supervisord,check-supervisord,plugin,check-supervisord-plugin
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Environment :: Plugins
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: System :: Monitoring
Classifier: Topic :: Utilities
Requires-Python: >=2.7
Description-Content-Type: text/x-rst
Provides-Extra: test
Requires-Dist: attrs (==20.3.0) ; extra == 'test'
Requires-Dist: bandit (==1.7.0) ; extra == 'test'
Requires-Dist: black (==20.8b1) ; extra == 'test'
Requires-Dist: check-manifest (==0.46) ; extra == 'test'
Requires-Dist: check-wheel-contents (==0.2.0) ; extra == 'test'
Requires-Dist: contextlib2 (==0.6.0.post1) ; extra == 'test'
Requires-Dist: coverage (==5.5) ; extra == 'test'
Requires-Dist: coveralls (==3.0.1) ; extra == 'test'
Requires-Dist: darglint (==1.7.0) ; extra == 'test'
Requires-Dist: dodgy (==0.2.1) ; extra == 'test'
Requires-Dist: dotenv-linter (==0.2.0) ; extra == 'test'
Requires-Dist: flake8-annotations-complexity (==0.0.6) ; extra == 'test'
Requires-Dist: flake8-annotations-coverage (==0.0.5) ; extra == 'test'
Requires-Dist: flake8-bugbear (==21.3.2) ; extra == 'test'
Requires-Dist: flake8-comprehensions (==3.3.1) ; extra == 'test'
Requires-Dist: flake8-docstrings (==1.5.0) ; extra == 'test'
Requires-Dist: flake8-fixme (==1.1.1) ; extra == 'test'
Requires-Dist: flake8 (==3.9.0) ; extra == 'test'
Requires-Dist: interrogate (==1.3.2) ; extra == 'test'
Requires-Dist: isort (==5.7.0) ; extra == 'test'
Requires-Dist: mypy (==0.812) ; extra == 'test'
Requires-Dist: pep8-naming (==0.11.1) ; extra == 'test'
Requires-Dist: pre-commit-hooks (==3.4.0) ; extra == 'test'
Requires-Dist: pre-commit (==2.11.1) ; extra == 'test'
Requires-Dist: pygments (==2.8.1) ; extra == 'test'
Requires-Dist: pylint (==2.7.2) ; extra == 'test'
Requires-Dist: pyroma (==3.1) ; extra == 'test'
Requires-Dist: pytest-cov (==2.11.1) ; extra == 'test'
Requires-Dist: pytest-mock (==3.5.1) ; extra == 'test'
Requires-Dist: pytest-tldr (==0.2.4) ; extra == 'test'
Requires-Dist: pytest (==6.2.2) ; extra == 'test'
Requires-Dist: readme-renderer (==29.0) ; extra == 'test'
Requires-Dist: removestar (==1.2.2) ; extra == 'test'
Requires-Dist: seed-isort-config (==2.2.0) ; extra == 'test'
Requires-Dist: tabulate (==0.8.9) ; extra == 'test'
Requires-Dist: tox-gh-actions (==2.4.0) ; extra == 'test'
Requires-Dist: tox-pyenv (==1.1.0) ; extra == 'test'
Requires-Dist: tox (==3.23.0) ; extra == 'test'
Requires-Dist: twine (==3.4.0) ; extra == 'test'
Requires-Dist: yesqa (==1.2.2) ; extra == 'test'
Provides-Extra: test-old-python
Requires-Dist: check-manifest (==0.41) ; extra == 'test-old-python'
Requires-Dist: contextlib2 (==0.6.0.post1) ; extra == 'test-old-python'
Requires-Dist: coverage (==5.5) ; extra == 'test-old-python'
Requires-Dist: coveralls (==1.11.1) ; extra == 'test-old-python'
Requires-Dist: pygments (==2.5.2) ; extra == 'test-old-python'
Requires-Dist: pytest-cov (==2.11.1) ; extra == 'test-old-python'
Requires-Dist: pytest-mock (==2.0.0) ; extra == 'test-old-python'
Requires-Dist: pytest (==4.6.9) ; extra == 'test-old-python'
Requires-Dist: readme-renderer (==29.0) ; extra == 'test-old-python'
Requires-Dist: tox-pyenv (==1.1.0) ; extra == 'test-old-python'
Requires-Dist: tox-gh-actions (==2.4.0) ; extra == 'test-old-python'
Requires-Dist: tox (==3.23.0) ; extra == 'test-old-python'
Requires-Dist: twine (==1.15.0) ; extra == 'test-old-python'
Provides-Extra: unix-socket-support
Requires-Dist: supervisor ; extra == 'unix-socket-support'

.. nagios-check-supervisord
.. README.rst

A nagios-check-supervisord documentation
========================================

|GitHub|_ |Coveralls|_ |pypi-license|_ |pypi-version|_ |pypi-python-version|_ |pypi-format|_ |pypi-wheel|_ |pypi-status|_

    *nagios-check-supervisord is a Nagios-plugin that check supervisord (http://supervisord.org/) programs status*

.. contents::

Installation
------------
* Obtain your copy of source code from the git repository: ``$ git clone https://github.com/vint21h/nagios-check-supervisord.git``. Or download the latest release from https://github.com/vint21h/nagios-check-supervisord/tags/.
* Run ``$ python ./setup.py install`` from the repository source tree or unpacked archive. Or use pip: ``$ pip install nagios-check-supervisord``.

Configuration
-------------
* Read and understand Nagios documentation.
* Create Nagios command and service definitions like this:

.. code-block::

    # "check_supervisord" command
    define command
    {
        command_name check_supervisord
        command_line $USER1$/check_supervisord -s $ARG1$ -p $ARG2$ -P $ARG3$ -u $ARG4$ -S $ARG5$
    }

    # "check_supervisord" service for "myprog" program
    define service
    {
        use                 local-service
        host_name           localhost
        service_description My program state
        check_command       check_supervisord!127.0.0.1!9001!myprog!username!password
    }

Without ``--programs`` option script check all programs from supervisord response and return priority-based global status:

* critical
* warning
* unknown
* ok

Also, ``--programs`` option can take a comma-separated list of programs to check.

``--stopped-state-exit-code`` option allows set Nagios status for stopped programs.

``--starting-state-exit-code`` option allows set Nagios status for starting programs.

``--network-errors-exit-code`` option allows set Nagios status for checks network errors.

``--no-programs-defined-exit-code`` option allows set Nagios status for not configured/found programs in supervisord response.

nagios-check-supervisord support connection to supervisord XML-RPC interface through HTTP and Unix Domain Socket.
To install nagios-check-supervisord with Unix Domain Socket: ``$ pip install nagios-check-supervisord[unix-socket-support]``

Licensing
---------
nagios-check-supervisord is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
For complete license text see COPYING file.

Contacts
--------
**Project Website**: https://github.com/vint21h/nagios-check-supervisord/

**Author**: Alexei Andrushievich <vint21h@vint21h.pp.ua>

For other authors list see AUTHORS file.


.. |GitHub| image:: https://github.com/vint21h/nagios-check-supervisord/workflows/build/badge.svg
    :alt: GitHub
.. |Coveralls| image:: https://coveralls.io/repos/github/vint21h/nagios-check-supervisord/badge.svg?branch=master
    :alt: Coveralls
.. |pypi-license| image:: https://img.shields.io/pypi/l/nagios-check-supervisord
    :alt: License
.. |pypi-version| image:: https://img.shields.io/pypi/v/nagios-check-supervisord
    :alt: Version
.. |pypi-python-version| image:: https://img.shields.io/pypi/pyversions/nagios-check-supervisord
    :alt: Supported Python version
.. |pypi-format| image:: https://img.shields.io/pypi/format/nagios-check-supervisord
    :alt: Package format
.. |pypi-wheel| image:: https://img.shields.io/pypi/wheel/nagios-check-supervisord
    :alt: Python wheel support
.. |pypi-status| image:: https://img.shields.io/pypi/status/nagios-check-supervisord
    :alt: Package status
.. _GitHub: https://github.com/vint21h/nagios-check-supervisord/actions/
.. _Coveralls: https://coveralls.io/github/vint21h/nagios-check-supervisord?branch=master
.. _pypi-license: https://pypi.org/project/nagios-check-supervisord/
.. _pypi-version: https://pypi.org/project/nagios-check-supervisord/
.. _pypi-python-version: https://pypi.org/project/nagios-check-supervisord/
.. _pypi-format: https://pypi.org/project/nagios-check-supervisord/
.. _pypi-wheel: https://pypi.org/project/nagios-check-supervisord/
.. _pypi-status: https://pypi.org/project/nagios-check-supervisord/


