diff --git a/doc/admin-guide-cloud/telemetry/section_telemetry-data-collection.xml b/doc/admin-guide-cloud/telemetry/section_telemetry-data-collection.xml index 60092c0830..f27e253588 100644 --- a/doc/admin-guide-cloud/telemetry/section_telemetry-data-collection.xml +++ b/doc/admin-guide-cloud/telemetry/section_telemetry-data-collection.xml @@ -490,16 +490,17 @@ .
Pipeline configuration - Pipeline configuration by default, is stored in a separate configuration - file, called pipeline.yaml, next to the - ceilometer.conf file. The pipeline - configuration file can be set in the - parameter listed in the Pipeline configuration by default, is 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 + and parameters listed in the Description of configuration options for api table section in the - OpenStack Configuration Reference. Multiple chains + OpenStack Configuration Reference respectively. Multiple pipelines can be defined in one pipeline configuration file. - The chain definition looks like the following: + The meter pipeline definition looks like the following: --- sources: - name: 'source name' @@ -610,9 +611,22 @@ sinks: unit_conversion - + The publishers section contains the list of publishers, where the samples data should be sent after the possible transformations. + Similarly, the event pipeline definition looks like the following: + --- +sources: + - name: 'source name' + events: + - 'event filter' + sinks + - 'sink name' +sinks: + - name: 'sink name' + publishers: + - 'list of publishers' + The event filter uses the same filtering logic as the meter pipeline.
Transformers The definition of transformers can contain the following fields: diff --git a/doc/config-reference/telemetry/section_telemetry-sample-configuration-files.xml b/doc/config-reference/telemetry/section_telemetry-sample-configuration-files.xml index 6f0358cf2d..7f39662bb6 100644 --- a/doc/config-reference/telemetry/section_telemetry-sample-configuration-files.xml +++ b/doc/config-reference/telemetry/section_telemetry-sample-configuration-files.xml @@ -36,7 +36,15 @@ samples generated by the Telemetry module
- +
+ event_pipeline.yaml + Event pipelines describe a coupling between notification event_types + and the corresponding sinks for publication of the event data. They are + defined in the event_pipeline.yaml file. + This file can be modified to adjust which notifications to capture and the + and where to publish the events. + +
policy.json The policy.json file defines additional