openstack/ceilometer
Code Issues Proposed changes

Merge "cleanup data-pipelines admin guide"

Browse Source
This commit is contained in:
Zuul 2018-01-04 15:46:22 +00:00 committed by Gerrit Code Review
commit 222a46568c
1 changed files with 14 additions and 16 deletions

30
doc/source/admin/telemetry-data-pipelines.rst

@ -30,15 +30,14 @@ unit conversion, or aggregating, before publishing_.
Pipeline configuration
~~~~~~~~~~~~~~~~~~~~~~
The pipeline configuration is, by default stored in separate configuration
files called ``pipeline.yaml`` and ``event_pipeline.yaml`` next to
the ``ceilometer.conf`` file. The meter pipeline and event pipeline
configuration files can be set by the ``pipeline_cfg_file`` and
``event_pipeline_cfg_file`` options listed in the `Description of
configuration options for api table
<https://docs.openstack.org/ocata/config-reference/telemetry/telemetry-config-options.html>`__
section in the OpenStack Configuration Reference respectively. Multiple
pipelines can be defined in one pipeline configuration file.
The notification agent supports two pipelines: one that handles samples and
another that handles events. The pipelines can be enabled and disabled by
setting `pipelines` option in the `[notifications]` section.
The actual configuration of each pipelines is, by default, stored in separate
configuration files: ``pipeline.yaml`` and ``event_pipeline.yaml``. The
location of the configuration files can be set by the ``pipeline_cfg_file`` and
``event_pipeline_cfg_file`` options listed in :ref:`configuring`
The meter pipeline definition looks like:
@ -146,6 +145,12 @@ The event filter uses the same filtering logic as the meter pipeline.
Transformers
------------
.. note::
Transformers maintain data in memory and therefore do not guarantee
durability in certain scenarios. A more durable and efficient solution
may be achieved post-storage using solutions like Gnocchi.
The definition of transformers can contain the following fields:
name
@ -378,13 +383,6 @@ be configured for each data point within the Telemetry service, allowing
the same technical meter or event to be published multiple times to
multiple destinations, each potentially using a different transport.
Publishers are specified in the ``publishers`` section for each
pipeline that is defined in the `pipeline.yaml
<https://git.openstack.org/cgit/openstack/ceilometer/plain/ceilometer/pipeline/data/pipeline.yaml>`__
and the `event_pipeline.yaml
<https://git.openstack.org/cgit/openstack/ceilometer/plain/ceilometer/pipeline/data/event_pipeline.yaml>`__
files.
The following publisher types are supported:
gnocchi (default)