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 0f9d538a46..a9b5dad4a7 100644 --- a/doc/admin-guide-cloud/telemetry/section_telemetry-data-collection.xml +++ b/doc/admin-guide-cloud/telemetry/section_telemetry-data-collection.xml @@ -439,6 +439,16 @@ Each source configuration encapsulates name matching, polling interval determination, optional resource enumeration or discovery, and mapping to one or more sinks for publication. + Data gathered can be used for different purposes, which can impact how frequently + it needs to be published. Typically, a meter published for billing purposes + needs to be updated every 30 minutes while the same meter may be needed for + performance tuning every minute. + + Rapid polling cadences should be avoided, as it results in a huge + amount of data in a short time frame, which may negatively affect the performance + of both Telemetry and the underlying database back end. We therefore strongly + recommend you do not use small granularity values like 10 seconds. + A sink on the other hand is a consumer of data, providing logic for the transformation and publication of data emitted from related sources diff --git a/doc/admin-guide-cloud/telemetry/section_telemetry-data-retrieval.xml b/doc/admin-guide-cloud/telemetry/section_telemetry-data-retrieval.xml index fe1e8743ba..ea1a996c74 100644 --- a/doc/admin-guide-cloud/telemetry/section_telemetry-data-retrieval.xml +++ b/doc/admin-guide-cloud/telemetry/section_telemetry-data-retrieval.xml @@ -9,7 +9,7 @@ the persisted data can be accessed. As described in and in the collected - information is stored in one or more database backends, which + information can be stored in one or more database backends, which are hidden by the Telemetry RESTful API. It is highly recommended not to access directly the @@ -418,19 +418,8 @@
Publishers - Publishing meters for different uses is a two dimensional problem. - The first variable is the frequency of publication. Typically a meter that is - published for billing purposes will need to be updated every 30 min while the same - meter can be needed for performance tuning in every minute. - - The use of rapid cadence should be avoided, as it results in a huge amount - of data in a short time frame, which may affect the performance of - both Telemetry and the underlying database backend as it would be filled up - rapidly. Therefore the use of small granularity value like 10 seconds is - highly not recommended. - - The second variable is the transport. The Telemetry module provides several - transport methods to forward the data collected to the + The Telemetry module provides several transport methods to forward + the data collected to the ceilometer-collector service or to an external system. The consumers of this data are widely different, like monitoring systems, for which data loss is acceptable and billing systems, which require reliable data @@ -440,9 +429,9 @@ through the message bus or to send it to one or more external consumers. One chain can contain multiple publishers. To solve the above mentioned problem, the notion of multi-publisher can - be configured for each meter within the Telemetry module, allowing the same - technical meter to be published multiple times to multiple destinations, each - potentially using a different transport and frequency of publication. + be configured for each datapoint within the Telemetry module, allowing the same + technical meter or event to be published multiple times to multiple destinations, each + potentially using a different transport. Publishers can be specified in the publishers section for each pipeline (for further details about pipelines see ) that is defined @@ -455,8 +444,9 @@ notifier It can be specified in the form of - notifier://?option1=value1&option2=value2. It emits metering - data over AMQP using oslo.messaging. + notifier://?option1=value1&option2=value2. It emits + data over AMQP using oslo.messaging. This is the recommended method of + publishing. @@ -464,7 +454,7 @@ It can be specified in the form of rpc://?option1=value1&option2=value2. It emits metering data - over lossy AMQP. + over lossy AMQP. This method is synchronous and may experience performance issues.