Jump to: navigation, search

Difference between revisions of "Telemetry"

m
Line 7: Line 7:
 
To reliably collect data on the utilization of the physical and virtual resources comprising deployed clouds, persist these data for subsequent retrieval and analysis, and trigger actions when defined criteria are met.
 
To reliably collect data on the utilization of the physical and virtual resources comprising deployed clouds, persist these data for subsequent retrieval and analysis, and trigger actions when defined criteria are met.
  
This functionality is split across multiple projects; each project designed to provide a discrete service in the telemetry space. The current set of projects are:
+
== Services ==
 +
The telemetry requirements of an OpenStack environment are vast and varied, they include use cases such as metering, monitoring, and alarming to name a few. The scope of these uses cases are diverse and beyond the scope of a single project and team. Currently, the telemetry project provides a set of functionality split across multiple projects; each project designed to provide a discrete service in the telemetry space.
 +
 
 +
=== Managed ===
 +
The current set of projects are managed by the telemetry team are:
 
* [https://github.com/openstack/aodh Aodh]  - an alarming service
 
* [https://github.com/openstack/aodh Aodh]  - an alarming service
 
* [https://github.com/openstack/ceilometer Ceilometer]  - a data collection service
 
* [https://github.com/openstack/ceilometer Ceilometer]  - a data collection service
 
* [https://github.com/openstack/gnocchi Gnocchi] - a time-series database and resource indexing service
 
* [https://github.com/openstack/gnocchi Gnocchi] - a time-series database and resource indexing service
  
== Aodh ==
+
{| border="1" cellpadding="2" cellspacing="0"
 +
| Specs
 +
| https://github.com/openstack/ceilometer-specs
 +
|-
 +
| Blueprints
 +
| https://blueprints.launchpad.net/ceilometer
 +
|-
 +
| Admin doc
 +
| http://docs.openstack.org/admin-guide-cloud/telemetry.html
 +
|-
 +
| Meetings
 +
| https://wiki.openstack.org/wiki/Meetings/Telemetry
 +
|}
 +
 
 +
Currently, a common spec repo and meeting time are shared between all managed projects
  
== Ceilometer ==  
+
==== Aodh ====
Ceilometer's goal is to handle the Telemetry requirements of an OpenStack environment; this includes use cases such as metering, monitoring, and alarming to name a few. The scope of these uses cases are diverse and beyond the scope of a single project and team. However, additional functionality can be found in external projects to enhance the Ceilometer experience. Some projects exist outside the management of the Ceilometer team but may be adopted in the future. The following are known extensions that supplement the capabilities of Ceilometer:
+
Aodh's goal is to enable the ability to trigger actions based on defined rules against against sample or event data collected by Ceilometer
  
 
{| border="1" cellpadding="2" cellspacing="0"
 
{| border="1" cellpadding="2" cellspacing="0"
 
| Source code  
 
| Source code  
| https://github.com/openstack/ceilometer
+
| https://github.com/openstack/aodh
 
|-
 
|-
 
| Bug tracker  
 
| Bug tracker  
| https://bugs.launchpad.net/ceilometer
+
| https://bugs.launchpad.net/aodh
 
|-
 
|-
| Specs
+
| Developer doc
| https://github.com/openstack/ceilometer-specs
+
| http://docs.openstack.org/developer/aodh/
 
|-
 
|-
| Blueprints
+
| Tarballs
| https://blueprints.launchpad.net/ceilometer
+
| http://tarballs.openstack.org/aodh/
 +
|}
 +
 
 +
==== Ceilometer ====
 +
Ceilometer's goal is to handle the Telemetry requirements of an OpenStack environment; this includes use cases such as metering, monitoring, and alarming to name a few. The scope of these uses cases are diverse and beyond the scope of a single project and team. However, additional functionality can be found in external projects to enhance the Ceilometer experience.
 +
 
 +
{| border="1" cellpadding="2" cellspacing="0"
 +
| Source code
 +
| https://github.com/openstack/ceilometer
 
|-
 
|-
| Admin doc
+
| Bug tracker
| http://docs.openstack.org/admin-guide-cloud/telemetry.html
+
| https://bugs.launchpad.net/ceilometer
 
|-
 
|-
 
| Developer doc  
 
| Developer doc  
 
| http://docs.openstack.org/developer/ceilometer/
 
| http://docs.openstack.org/developer/ceilometer/
|-
 
| FAQ
 
| https://ask.openstack.org/questions/scope:all/sort:activity-desc/tags:ceilometer/
 
 
|-
 
|-
 
| Tarballs  
 
| Tarballs  
 
| http://tarballs.openstack.org/ceilometer/
 
| http://tarballs.openstack.org/ceilometer/
|-
 
| Meetings
 
| https://wiki.openstack.org/wiki/Meetings/Ceilometer
 
 
|}
 
|}
  
 +
==== Gnocchi ====
 +
Gnocchi's goal is to provide a time-series resource indexing, metric storage service which enables users to capture OpenStack resources and the metrics associated with them. Using rolling aggregation set by user-defined archival policies, it's aim is to provide a scalable means of storing both short and long term data and provide a statistical view based on the input data (ie. Ceilometer)
  
== Road Map ==
+
{| border="1" cellpadding="2" cellspacing="0"
The future direction and plans of the project can be found [[Ceilometer/RoadMap|here]].
+
| Source code
 
+
| https://github.com/openstack/gnocchi
 
+
|-
 +
| Bug tracker
 +
| https://bugs.launchpad.net/gnocchi
 +
|-
 +
| Developer doc
 +
| http://docs.openstack.org/developer/gnocchi/
 +
|-
 +
| Tarballs
 +
| http://tarballs.openstack.org/gnocchi/
 +
|}
  
 
=== Externally Managed ===
 
=== Externally Managed ===
 
* [https://github.com/openstack/heat Heat] - Orchestration service which provides autoscaling capabilities using Ceilometer data
 
* [https://github.com/openstack/heat Heat] - Orchestration service which provides autoscaling capabilities using Ceilometer data
* [https://github.com/openstack/horizon Horizon] - UI service which provides visualisation of Ceilometer data
+
* [https://github.com/openstack/horizon Horizon] - UI service which allows interaction with Aodh data
 
* [https://github.com/stackforge/ceilometer-powervm PowerVM] - PowerVM pollster plugin
 
* [https://github.com/stackforge/ceilometer-powervm PowerVM] - PowerVM pollster plugin
 
* [https://github.com/stackforge/cloudkitty CloudKitty]  - OpenStack Rating as a Service component and usage reporting
 
* [https://github.com/stackforge/cloudkitty CloudKitty]  - OpenStack Rating as a Service component and usage reporting
Line 61: Line 92:
 
* [http://icclab.github.io/cyclops Cyclops] - Rating-Charging-Billing Solution for Cloud providers
 
* [http://icclab.github.io/cyclops Cyclops] - Rating-Charging-Billing Solution for Cloud providers
  
== Contributing to Ceilometer ==
+
== Road Map ==
The developer documentation is starting to take shape within the source and is also published at http://docs.openstack.org/developer/ceilometer/.
+
The future direction and plans of the project can be found [[Telemetry/RoadMap|here]]. Feel free to pick up a task if something interests you. Anyone is free to propose their own ideas in a spec as well.
  
The project team hangs out on Freenode in the #openstack-ceilometer channel, feel free to drop by and stay as long as you want. We use the [http://lists.openstack.org/pipermail/openstack-dev/ OpenStack Developers List] for our email discussions. If you want to make a post relevant to Ceilometer please tag the message subject with [Ceilometer].
+
== Contributing to Telemetry ==
 +
The developer documentation can be found in each projects respective documentation page.
  
The project team officially meets once a week, see [[Meetings/Ceilometer]].
+
The telemetry project team hangs out on Freenode in the #openstack-telemetry channel, feel free to drop by and stay as long as you want. We use the [http://lists.openstack.org/pipermail/openstack-dev/ OpenStack Developers List] for our email discussions. If you want to make a post relevant to multiple projects in telemetry space,
 +
please tag the subject with [telemetry]. If you have a post regarding a single project, please tag the subject with the appropriate tag: [aodh], [ceilometer] or [gnocchi].
  
More details can be found on possible contributions at [[Ceilometer/Contributing]] including:
+
The project team officially meets once a week, see [[Meetings/Telemetry]].
* Setting-up Ceilometer via devstack
 
* Possible tasks 
 
** Update documentation
 
** Close old fixed bugs
 
** Fix bugs
 
** Review patches
 
** Triage incoming bugs
 
* and more...
 
  
  [[Category:Ceilometer]]
+
  [[Category:Telemetry]]

Revision as of 20:04, 12 November 2015

OpenStack Telemetry

THIS IS A WORK IN PROGRESS

Project Mission

To reliably collect data on the utilization of the physical and virtual resources comprising deployed clouds, persist these data for subsequent retrieval and analysis, and trigger actions when defined criteria are met.

Services

The telemetry requirements of an OpenStack environment are vast and varied, they include use cases such as metering, monitoring, and alarming to name a few. The scope of these uses cases are diverse and beyond the scope of a single project and team. Currently, the telemetry project provides a set of functionality split across multiple projects; each project designed to provide a discrete service in the telemetry space.

Managed

The current set of projects are managed by the telemetry team are:

  • Aodh - an alarming service
  • Ceilometer - a data collection service
  • Gnocchi - a time-series database and resource indexing service
Specs https://github.com/openstack/ceilometer-specs
Blueprints https://blueprints.launchpad.net/ceilometer
Admin doc http://docs.openstack.org/admin-guide-cloud/telemetry.html
Meetings https://wiki.openstack.org/wiki/Meetings/Telemetry

Currently, a common spec repo and meeting time are shared between all managed projects

Aodh

Aodh's goal is to enable the ability to trigger actions based on defined rules against against sample or event data collected by Ceilometer

Source code https://github.com/openstack/aodh
Bug tracker https://bugs.launchpad.net/aodh
Developer doc http://docs.openstack.org/developer/aodh/
Tarballs http://tarballs.openstack.org/aodh/

Ceilometer

Ceilometer's goal is to handle the Telemetry requirements of an OpenStack environment; this includes use cases such as metering, monitoring, and alarming to name a few. The scope of these uses cases are diverse and beyond the scope of a single project and team. However, additional functionality can be found in external projects to enhance the Ceilometer experience.

Source code https://github.com/openstack/ceilometer
Bug tracker https://bugs.launchpad.net/ceilometer
Developer doc http://docs.openstack.org/developer/ceilometer/
Tarballs http://tarballs.openstack.org/ceilometer/

Gnocchi

Gnocchi's goal is to provide a time-series resource indexing, metric storage service which enables users to capture OpenStack resources and the metrics associated with them. Using rolling aggregation set by user-defined archival policies, it's aim is to provide a scalable means of storing both short and long term data and provide a statistical view based on the input data (ie. Ceilometer)

Source code https://github.com/openstack/gnocchi
Bug tracker https://bugs.launchpad.net/gnocchi
Developer doc http://docs.openstack.org/developer/gnocchi/
Tarballs http://tarballs.openstack.org/gnocchi/

Externally Managed

  • Heat - Orchestration service which provides autoscaling capabilities using Ceilometer data
  • Horizon - UI service which allows interaction with Aodh data
  • PowerVM - PowerVM pollster plugin
  • CloudKitty - OpenStack Rating as a Service component and usage reporting
  • Graphite Publisher - Ceilometer publisher to connect to Graphite.
  • Watcher - Resource optimization service
  • Cyclops - Rating-Charging-Billing Solution for Cloud providers

Road Map

The future direction and plans of the project can be found here. Feel free to pick up a task if something interests you. Anyone is free to propose their own ideas in a spec as well.

Contributing to Telemetry

The developer documentation can be found in each projects respective documentation page.

The telemetry project team hangs out on Freenode in the #openstack-telemetry channel, feel free to drop by and stay as long as you want. We use the OpenStack Developers List for our email discussions. If you want to make a post relevant to multiple projects in telemetry space, please tag the subject with [telemetry]. If you have a post regarding a single project, please tag the subject with the appropriate tag: [aodh], [ceilometer] or [gnocchi].

The project team officially meets once a week, see Meetings/Telemetry.