Jump to: navigation, search

Difference between revisions of "Telemetry"

m (Managed)
(Contributing to Telemetry: no panko)
 
(24 intermediate revisions by 4 users not shown)
Line 6: Line 6:
  
 
== Services ==
 
== 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.
+
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 is 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 ===
 
=== Managed ===
Line 12: Line 12:
 
* [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
 
  
 
{| border="1" cellpadding="2" cellspacing="0"
 
{| border="1" cellpadding="2" cellspacing="0"
Line 22: Line 21:
 
|-
 
|-
 
| Meetings  
 
| Meetings  
| https://wiki.openstack.org/wiki/Meetings/Telemetry
+
| https://etherpad.openstack.org/p/telemetry-meeting-agenda
 
|}
 
|}
  
Currently, a common spec repo and meeting time are shared between all managed projects
+
 
  
 
==== Aodh ====
 
==== Aodh ====
* team lead - Liusheng (liusheng)
+
 
 
Aodh's goal is to enable the ability to trigger actions based on defined rules against sample or event data collected by Ceilometer
 
Aodh's goal is to enable the ability to trigger actions based on defined rules against sample or event data collected by Ceilometer
  
Line 34: Line 33:
 
| Source code  
 
| Source code  
 
| https://github.com/openstack/aodh
 
| https://github.com/openstack/aodh
|-
 
| Blueprints
 
| https://blueprints.launchpad.net/aodh
 
 
|-
 
|-
 
| Bug tracker  
 
| Bug tracker  
 
| https://bugs.launchpad.net/aodh
 
| https://bugs.launchpad.net/aodh
 
|-
 
|-
| Developer doc
+
| Docs
| http://docs.openstack.org/developer/aodh/
+
| https://docs.openstack.org/aodh/latest/
 
|-
 
|-
 
| Tarballs  
 
| Tarballs  
Line 49: Line 45:
  
 
==== Ceilometer ====
 
==== Ceilometer ====
* team lead - Gordon Chung (gordc)
+
 
Ceilometer's goal is to efficiently collect, normalise and transform data produced by OpenStack services. The data it collects is intended to be used to create different views and help solve various telemetry use cases. Aodh and Gnocchi are two examples of services extending Ceilometer data.
+
Ceilometer's goal is to efficiently collect, normalize and transform data produced by OpenStack services. The data it collects is intended to be used to create different views and help solve various telemetry use cases. Aodh and Gnocchi are two examples of services extending Ceilometer data.
  
 
{| 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/ceilometer
|-
 
| Blueprints
 
| https://blueprints.launchpad.net/ceilometer
 
 
|-
 
|-
 
| Bug tracker  
 
| Bug tracker  
 
| https://bugs.launchpad.net/ceilometer
 
| https://bugs.launchpad.net/ceilometer
 
|-
 
|-
| Developer doc
+
| Docs
| http://docs.openstack.org/developer/ceilometer/
+
| https://docs.openstack.org/ceilometer/latest/
 
|-
 
|-
 
| Tarballs  
 
| Tarballs  
Line 69: Line 62:
 
|}
 
|}
  
 +
=== Externally Managed (Non-OpenStack) ===
 
==== Gnocchi ====
 
==== Gnocchi ====
* team lead - Julien Danjou (jd__)
+
 
 
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)
 
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)
  
 
{| border="1" cellpadding="2" cellspacing="0"
 
{| border="1" cellpadding="2" cellspacing="0"
 
| Source code  
 
| Source code  
| https://github.com/openstack/gnocchi
+
| https://github.com/gnocchixyz/gnocchi
 
|-
 
|-
 
| Bug tracker  
 
| Bug tracker  
| https://bugs.launchpad.net/gnocchi
+
| https://github.com/gnocchixyz/gnocchi/issues
 
|-
 
|-
| Developer doc
+
| Docs
| http://docs.openstack.org/developer/gnocchi/
+
| http://gnocchi.xyz
 
|-
 
|-
 
| Tarballs  
 
| Tarballs  
| http://tarballs.openstack.org/gnocchi/
+
| https://pypi.python.org/pypi/gnocchi
 
|}
 
|}
  
Line 95: Line 89:
 
* [https://github.com/openstack/watcher Watcher] - Resource optimization service.
 
* [https://github.com/openstack/watcher Watcher] - Resource optimization service.
 
* [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.
* [https://github.com/openstack/collectd-ceilometer-plugin Collectd] - A Collectd writer plugin to publish telemetry to Ceilometer.
+
* [https://github.com/openstack/collectd-openstack-plugins Collectd-openstack-plugins] - A Collectd writer plugin to publish telemetry to Ceilometer, Aodh and Gnocchi.
 +
* [https://github.com/gnocchixyz/collectd-gnocchi Collectd-gnocchi] - A Collectd writer plugin to publish telemetry to Gnocchi.
  
 
== Road Map ==
 
== Road Map ==
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 future direction and plans of the project can be found https://etherpad.openstack.org/p/telemetry-train-roadmap. Feel free to pick up a task if something interests you. Anyone is free to propose their own ideas in a patch as well.
  
 
== Contributing to Telemetry ==
 
== Contributing to Telemetry ==
 
The developer documentation can be found in each projects respective documentation page.
 
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 [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,
+
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-discuss/ 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].
+
please tag the subject with [telemetry]. If you have a post regarding a single project, please tag the subject with the appropriate tag: [aodh] or [ceilometer].
 +
 
 +
== Contact ==
 +
 
 +
Ping one of the contributors listed here on the IRC #openstack-telemetry channel on OFTC or email the openstack-discuss@lists.openstack.org mailing list with the prefix [telemetry]
 +
 
 +
* Matthias Runge, mrunge on IRC, <mrunge@redhat.com> - PTL
 +
* Lingxian Kong (lxkong) - core reviewer
 +
* Rong Zhu (zhurong) - core reviewer
 +
 
 +
 
 +
Contributors:
  
The project team officially meets once a week, see [[Meetings/Telemetry]].
+
* Adrian Turjak (adriant)
 +
* Florian Engelmann (engel75)
 +
* Joseph Davis (joadavis)
 +
* Rafael Weingärtner (rafaelweingartne)
 +
* Shaoman Zhang (shaoman)
  
 
  [[Category:Telemetry]]
 
  [[Category:Telemetry]]

Latest revision as of 09:10, 15 June 2021

OpenStack Telemetry

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 is 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:

Specs https://github.com/openstack/ceilometer-specs
Admin doc http://docs.openstack.org/admin-guide-cloud/telemetry.html
Meetings https://etherpad.openstack.org/p/telemetry-meeting-agenda


Aodh

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

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

Ceilometer

Ceilometer's goal is to efficiently collect, normalize and transform data produced by OpenStack services. The data it collects is intended to be used to create different views and help solve various telemetry use cases. Aodh and Gnocchi are two examples of services extending Ceilometer data.

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

Externally Managed (Non-OpenStack)

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/gnocchixyz/gnocchi
Bug tracker https://github.com/gnocchixyz/gnocchi/issues
Docs http://gnocchi.xyz
Tarballs https://pypi.python.org/pypi/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. Owners: thorst and efried. IRC: #openstack-powervm
  • 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.
  • Collectd-openstack-plugins - A Collectd writer plugin to publish telemetry to Ceilometer, Aodh and Gnocchi.
  • Collectd-gnocchi - A Collectd writer plugin to publish telemetry to Gnocchi.

Road Map

The future direction and plans of the project can be found https://etherpad.openstack.org/p/telemetry-train-roadmap. Feel free to pick up a task if something interests you. Anyone is free to propose their own ideas in a patch 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] or [ceilometer].

Contact

Ping one of the contributors listed here on the IRC #openstack-telemetry channel on OFTC or email the openstack-discuss@lists.openstack.org mailing list with the prefix [telemetry]

  • Matthias Runge, mrunge on IRC, <mrunge@redhat.com> - PTL
  • Lingxian Kong (lxkong) - core reviewer
  • Rong Zhu (zhurong) - core reviewer


Contributors:

  • Adrian Turjak (adriant)
  • Florian Engelmann (engel75)
  • Joseph Davis (joadavis)
  • Rafael Weingärtner (rafaelweingartne)
  • Shaoman Zhang (shaoman)