Metadata-Version: 2.1
Name: collectd-gnocchi
Version: 0.0.0
Summary: Gnocchi storage plugin for collectd
Home-page: http://github.com/gnocchixyz/collectd-gnocchi
Author: Julien Danjou
Author-email: julien@danjou.info
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: System :: Monitoring
License-File: LICENSE
Requires-Dist: gnocchiclient (>=4.0.0)
Requires-Dist: keystoneauth1

==================
 collectd-gnocchi
==================
.. image:: https://img.shields.io/pypi/v/collectd-gnocchi.svg
    :target: https://pypi.python.org/pypi/collectd-gnocchi

.. image:: https://img.shields.io/travis/gnocchixyz/collectd-gnocchi.svg
    :target: https://travis-ci.org/gnocchixyz/collectd-gnocchi

This is an output plugin for `collectd`_ that send metrics to `Gnocchi`_. It
will create a resource type named _collectd_ (by default) and a new resource
for each of the host monitored.

Each host will have a list of metrics created dynamically using the following
name convention:

  plugin-plugin_instance/type-type_instance-value_number

In order for the metric to be created correctly, be sure that you have matching
`archive policies rules`_.

.. _archive policies rules: http://gnocchi.xyz/rest.html#archive-policy-rule


Installation
============

This is a regular Python package that you can install via `PyPI`_ using::

  pip install collectd-gnocchi

Or from sources using::

  pip install .


In order to use this plugin you will need a server running the **Gnocchi 3.1**
or greater.

Configuration
=============
Once installed, you need to enable it in your `collectd.conf` file this way::

.. include:: collectd-gnocchi.conf

You can also copy the provided `collectd-gnocchi.conf` from this repository in
e.g. `/etc/collectd.d` if your distribution supports it.

.. _`collectd`: http://collectd.org
.. _`Gnocchi`: http://gnocchi.xyz
.. _`PyPI`: http://pypi.python.org

