summaryrefslogtreecommitdiff
path: root/README.rst
blob: 7c708d916d8b02dd79d6278727a5d30324074c6b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
.. image:: doc/source/monitorstack-text.png
    :alt: monitorstack text

.. list-table::
    :stub-columns: 1

    * - Status:
      - | |travis| |codecov|

.. |travis| image:: https://img.shields.io/travis/major/monitorstack.svg
    :alt: Travis-CI Build Status
.. |codecov| image:: https://img.shields.io/codecov/c/github/major/monitorstack.svg
    :alt: Coverage Status

The monitorstack project provides a framework for writing monitoring plugins
that output data in various formats for different monitoring systems.
Developers can quickly add new monitoring plugins (along with tests) without
worrying about how to format the data.

For more details, including how to install/configure, a usage guide, and a
developer guide, review the `monitorstack documentation`_.

.. _monitorstack documentation: https://docs.openstack.org/developer/monitorstack/

Requirements
------------

Python 2.7 or higher is required for monitorstack.

Each commit is tested against Python 2.7, 3.3, 3.4, 3.5, and pypy.

License
-------

Apache 2.0

Community
---------

The monitorstack project is managed by the `OpenStack-Ansible community`_, but
it can be used with or without OpenStack-Ansible.

Contact information:

* ``#openstack-ansible`` on Freenode IRC

* `Launchpad Bugs`_

* Send email to ``openstack-dev@lists.openstack.org`` with
  ``[openstack-ansible][monitorstack]`` in the subject line.

.. _OpenStack-Ansible community: https://wiki.openstack.org/wiki/OpenStackAnsible
.. _Launchpad Bugs: https://bugs.launchpad.net/openstack-ansible