Merge "update data-retrieval page"

This commit is contained in:
Jenkins 2015-03-02 06:06:55 +00:00 committed by Gerrit Code Review
commit 8ddcd18451
2 changed files with 20 additions and 20 deletions

View File

@ -439,6 +439,16 @@
<para>Each source configuration encapsulates name matching, polling <para>Each source configuration encapsulates name matching, polling
interval determination, optional resource enumeration or discovery, and interval determination, optional resource enumeration or discovery, and
mapping to one or more sinks for publication.</para> mapping to one or more sinks for publication.</para>
<para>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.</para>
<warning>
<para>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.</para>
</warning>
<para>A sink on the other hand is a consumer of data, providing logic <para>A sink on the other hand is a consumer of data, providing logic
for the transformation and publication of data emitted from related for the transformation and publication of data emitted from related
sources</para> sources</para>

View File

@ -9,7 +9,7 @@
the persisted data can be accessed. As described in the persisted data can be accessed. As described in
<xref linkend="section_telemetry-system-architecture"/> and in <xref linkend="section_telemetry-system-architecture"/> and in
<xref linkend="section_telemetry-data-collection"/> the collected <xref linkend="section_telemetry-data-collection"/> 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.</para> are hidden by the Telemetry RESTful API.</para>
<note> <note>
<para>It is highly recommended not to access directly the <para>It is highly recommended not to access directly the
@ -418,19 +418,8 @@
</section> </section>
<section xml:id="section_telemetry-publishers"> <section xml:id="section_telemetry-publishers">
<title>Publishers</title> <title>Publishers</title>
<para>Publishing meters for different uses is a two dimensional problem. <para>The Telemetry module provides several transport methods to forward
The first variable is the frequency of publication. Typically a meter that is the data collected to the <systemitem class="service">
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.</para>
<note>
<para>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.</para>
</note>
<para>The second variable is the transport. The Telemetry module provides several
transport methods to forward the data collected to the <systemitem class="service">
ceilometer-collector</systemitem> service or to an external system. The ceilometer-collector</systemitem> service or to an external system. The
consumers of this data are widely different, like monitoring systems, for which consumers of this data are widely different, like monitoring systems, for which
data loss is acceptable and billing systems, which require reliable data 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. through the message bus or to send it to one or more external consumers.
One chain can contain multiple publishers.</para> One chain can contain multiple publishers.</para>
<para>To solve the above mentioned problem, the notion of multi-publisher can <para>To solve the above mentioned problem, the notion of multi-publisher can
be configured for each meter within the Telemetry module, allowing the same be configured for each datapoint within the Telemetry module, allowing the same
technical meter to be published multiple times to multiple destinations, each technical meter or event to be published multiple times to multiple destinations, each
potentially using a different transport and frequency of publication.</para> potentially using a different transport.</para>
<para>Publishers can be specified in the <literal>publishers</literal> section <para>Publishers can be specified in the <literal>publishers</literal> section
for each pipeline (for further details about pipelines see for each pipeline (for further details about pipelines see
<xref linkend="section_telemetry-data-collection-processing"/>) that is defined <xref linkend="section_telemetry-data-collection-processing"/>) that is defined
@ -455,8 +444,9 @@
<term>notifier</term> <term>notifier</term>
<listitem> <listitem>
<para>It can be specified in the form of <para>It can be specified in the form of
<literal>notifier://?option1=value1&amp;option2=value2</literal>. It emits metering <literal>notifier://?option1=value1&amp;option2=value2</literal>. It emits
data over AMQP using oslo.messaging.</para> data over AMQP using oslo.messaging. This is the recommended method of
publishing.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -464,7 +454,7 @@
<listitem> <listitem>
<para>It can be specified in the form of <para>It can be specified in the form of
<literal>rpc://?option1=value1&amp;option2=value2</literal>. It emits metering data <literal>rpc://?option1=value1&amp;option2=value2</literal>. It emits metering data
over lossy AMQP.</para> over lossy AMQP. This method is synchronous and may experience performance issues.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>