e63e7cafab
README.rst: * Updated introductory paragraph to include gnocchi and aodh * Updated features list to include gnocchi and aodh features doc/source/GSG.rst: * Updates collectd installation instructions * Updates intro to configuring collectd as a service * Updates packages to be installed * Updates installation and configuration for plugins * Updates verification steps for ceilometer, aodh and gnocchi Change-Id: I43698ea898bb990f163efc938ef6bbbec1e16b58
74 lines
2.9 KiB
ReStructuredText
74 lines
2.9 KiB
ReStructuredText
..
|
|
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-ceilometer-plugin
|
|
==========================
|
|
|
|
Collectd plugins for publishing to OpenStack (Ceilometer, Gnocchi and Aodh).
|
|
|
|
This repositiory contains collectd plugins for publishing telemetry data
|
|
(metrics and events) gathered by collectd to Ceilometer, 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: http://git.openstack.org/cgit/openstack/collectd-ceilometer-plugin
|
|
* Installation:
|
|
http://git.openstack.org/cgit/openstack/collectd-ceilometer-plugin/tree/doc/source/installation.rst
|
|
* Bugs: http://bugs.launchpad.net/collectd-ceilometer-plugin
|
|
* Usage:
|
|
http://git.openstack.org/cgit/openstack/collectd-ceilometer-plugin/tree/doc/source/usage.rst
|
|
* Contact: E-mail the dev mailing list with the [collectd-ceilometer-plugin] tag
|
|
mailto:openstack-dev@lists.openstack.org?subject=[collectd-ceilometer-plugin]
|
|
|
|
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:
|
|
|
|
* An overview of Ceilometer and its architecture:
|
|
http://docs.openstack.org/developer/ceilometer/overview.html
|
|
http://docs.openstack.org/developer/ceilometer/architecture.html
|
|
* 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
|
|
--------
|
|
|
|
* Ceilometer plugin (for collectd)
|
|
** Converts from collectd data sources to Ceilometer format
|
|
** Adds units for Ceilometer
|
|
* 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
|