..
      Licensed under the Apache License, Version 2.0 (the "License"); you may
      not use this file except in compliance with the License. You may obtain
      a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
      WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
      License for the specific language governing permissions and limitations
      under the License.
      Convention for heading levels in collectd-ceilometer-plugin documentation:

      =======  Heading 0 (reserved for the title in a document)
      -------  Heading 1
      ~~~~~~~  Heading 2
      +++++++  Heading 3
      '''''''  Heading 4

      Avoid deeper levels because they do not render well.

==========================
collectd-openstack-plugins
==========================

Collectd plugins for publishing to OpenStack (gnocchi and aodh).

This repositiory contains collectd plugins for publishing telemetry data
(metrics and events) gathered by collectd to gnocchi and aodh.
This allows a more comprehensive set of platform telemetry to be made available
to OpenStack which enables service assurance, fault management and  monitoring.

* Free software: Apache license
* Source: https://git.openstack.org/cgit/openstack/collectd-openstack-plugins
* Getting Started Guide:
   https://git.openstack.org/cgit/openstack/collectd-openstack-plugins/tree/doc/source/GSG.rst
* Installing collectd-openstack-plugins with DevStack:
   https://git.openstack.org/cgit/openstack/collectd-openstack-plugins/tree/doc/source/devstackGSG.rst
* Bugs: https://bugs.launchpad.net/collectd-ceilometer-plugin
* Usage:
   https://git.openstack.org/cgit/openstack/collectd-openstack-plugins/tree/doc/source/usage.rst
* Contact: E-mail the dev mailing list with the [collectd-openstack-plugins] tag
   mailto:openstack-dev@lists.openstack.org?subject=[collectd-openstack-plugins]

Collateral
----------

The following are links to background information, collateral and references
to provide a clearer view on the need for this plugin, what it does and how it
works:

* Official collectd website:
   https://collectd.org/
* Information on how collectd is enabled for Openstack:
   https://01.org/openstack/blogs/emmalfoley/2016/collectd-enabling-openstack
* Presentation on how collectd, ceilometer and DPDK work together:
   https://www.youtube.com/watch?v=BdebhsBFEJs

Features
--------

* Gnocchi plugin (for collectd)
  ** Store collectd metrics in gnocchi
* Aodh plugin (for collectd)
  ** Forward collectd notifications to aodh
* Devstack plugin (for deploying the contents of this repo)
  ** Configure and deploy plugins
  ** Build collectd from source