openstack-manuals/doc/common/section_getstart_telemetry.xml
gordon chung 530f6bfb8c update ceilometer install guide and external service configuration
- change notification_driver option to use messagingv2.
*.openstack.common.* is pre-icehouse option.
- add note to configure swift metrics using new ceilometermiddleware
- update telemetry get_started guide:
  - generalise supported functions
  - fix notification agent and collector service purpose

Closes-Bug: #1425713
Co-Authored-By: Matt Kassawara <mkassawara@gmail.com>
backport: juno
Change-Id: I90dff1b5c2a7dd2943cfa7ff25bb63c08eb7986d
2015-03-12 13:56:49 -05:00

81 lines
3.8 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="metering-service">
<title>Telemetry module</title>
<para>The Telemetry module performs the following functions:</para>
<para>
<itemizedlist>
<listitem>
<para>Efficiently polls metering data related to OpenStack
services.</para>
</listitem>
<listitem>
<para>Collects event and metering data by monitoring notifications
sent from services.</para>
</listitem>
<listitem>
<para>Publishes collected data to various targets including data
stores and message queues.</para>
</listitem>
<listitem>
<para>Creates alarms when collected data breaks defined rules.</para>
</listitem>
</itemizedlist>
</para>
<para>The Telemetry module consists of the following
components:</para>
<variablelist>
<varlistentry><term>A compute agent (<systemitem class="service"
>ceilometer-agent-compute</systemitem>)</term>
<listitem><para>Runs on each compute node and polls for resource
utilization statistics. There may be other types of agents in the
future, but for now our focus is creating the compute agent.</para>
</listitem>
</varlistentry>
<varlistentry><term>A central agent (<systemitem class="service"
>ceilometer-agent-central</systemitem>)</term>
<listitem><para>Runs on a central management server to poll for
resource utilization statistics for resources not tied to instances
or compute nodes. Multiple agents can be started to scale service
horizontally.</para></listitem>
</varlistentry>
<varlistentry><term>A notification agent (<systemitem class="service"
>ceilometer-agent-notification</systemitem>)</term>
<listitem><para>Runs on a central management server(s) and consumes
messages from the message queue(s) to build event and metering data.
</para></listitem>
</varlistentry>
<varlistentry><term>A collector (<systemitem class="service"
>ceilometer-collector</systemitem>)</term>
<listitem><para>Runs on central management server(s) and dispatches
collected telemetry data to a data store or external consumer
without modification.</para>
</listitem>
</varlistentry>
<varlistentry><term>An alarm evaluator (<systemitem class="service"
>ceilometer-alarm-evaluator</systemitem>)</term>
<listitem><para>Runs on one or more central management servers to
determine when alarms fire due to the associated statistic
trend crossing a threshold over a sliding time window.</para></listitem>
</varlistentry>
<varlistentry><term>An alarm notifier (<systemitem class="service"
>ceilometer-alarm-notifier</systemitem>)</term>
<listitem><para>Runs on one or more central management servers to
allow alarms to be set based on the threshold evaluation for a
collection of samples.</para></listitem>
</varlistentry>
<varlistentry>
<term>An API server (<systemitem
class="service">ceilometer-api</systemitem>)</term>
<listitem><para>Runs on one or more central management servers to
provide data access from the data store.</para></listitem>
</varlistentry>
</variablelist>
<para>These services communicate by using the OpenStack messaging bus.
Only the collector and API server have access
to the data store.</para>
</section>