openstack/openstack-manuals
Code Issues Proposed changes

config-reference: add a Telemetry section

Browse Source 
Add a basic Telemetry section providing configuration tables and
configuration files for ceilometer.

Closes-Bug: #1284472
Change-Id: I7483c7c66d00dd198e6f7265b6c65e54ab9fcb96
This commit is contained in:
Gauvain Pocentek 2014-03-22 12:05:41 +01:00
parent 96ee88410f
commit 8d6562cd8f
3 changed files with 82 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/config-reference/bk-config-ref.xml
View File

@ -117,6 +117,8 @@
<xi:include href="ch_networkingconfigure.xml"/> <xi:include href="ch_networkingconfigure.xml"/>
<!-- Object Storage --> <!-- Object Storage -->
<xi:include href="ch_objectstorageconfigure.xml"/> <xi:include href="ch_objectstorageconfigure.xml"/>
<!-- Telemetry -->
<xi:include href="ch_telemetryconfigure.xml"/>
<!-- Appendices --> <!-- Appendices -->
<xi:include href="app_firewalls-ports.xml"/> <xi:include href="app_firewalls-ports.xml"/>
<!-- Support --> <!-- Support -->

42
doc/config-reference/ch_telemetryconfigure.xml Normal file
View File

@ -0,0 +1,42 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter version="5.0" xml:id="ch_configuring-openstack-telemetry"
xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:ns5="http://www.w3.org/1999/xhtml"
xmlns:ns4="http://www.w3.org/2000/svg"
xmlns:ns3="http://www.w3.org/1998/Math/MathML"
xmlns:ns="http://docbook.org/ns/docbook">
<title>Telemetry</title>
<para>The Telemetry service collects measurements within OpenStack. Its
various agents and services are configured in the
<filename>/etc/ceilometer/ceilometer.conf</filename> file.</para>
<para>To install Telemetry, see the <citetitle>OpenStack Installation
Guide</citetitle> for your distribution (<link
xlink:href="docs.openstack.org" >docs.openstack.org</link>).</para>
<para>The following tables provide a comprehensive list of the Telemetry
configuration options.</para>
<xi:include href="../common/tables/ceilometer-alarm.xml"/>
<xi:include href="../common/tables/ceilometer-amqp.xml"/>
<xi:include href="../common/tables/ceilometer-api.xml"/>
<xi:include href="../common/tables/ceilometer-auth.xml"/>
<xi:include href="../common/tables/ceilometer-cells.xml"/>
<xi:include href="../common/tables/ceilometer-collector.xml"/>
<xi:include href="../common/tables/ceilometer-common.xml"/>
<xi:include href="../common/tables/ceilometer-database.xml"/>
<xi:include href="../common/tables/ceilometer-events.xml"/>
<xi:include href="../common/tables/ceilometer-exchange.xml"/>
<xi:include href="../common/tables/ceilometer-inspector.xml"/>
<xi:include href="../common/tables/ceilometer-logging.xml"/>
<xi:include href="../common/tables/ceilometer-qpid.xml"/>
<xi:include href="../common/tables/ceilometer-rabbitmq.xml"/>
<xi:include href="../common/tables/ceilometer-redis.xml"/>
<xi:include href="../common/tables/ceilometer-rpc.xml"/>
<xi:include href="../common/tables/ceilometer-ssl.xml"/>
<xi:include href="../common/tables/ceilometer-swift.xml"/>
<xi:include href="../common/tables/ceilometer-vmware.xml"/>
<xi:include href="telemetry/section_telemetry-sample-configuration-files.xml" />
</chapter>

38
doc/config-reference/telemetry/section_telemetry-sample-configuration-files.xml Normal file
View File

@ -0,0 +1,38 @@
<?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="section_telemetry-sample-configuration-files">
<title>Telemetry sample configuration files</title>
<para>All the files in this section can be found in the <filename
class="directory">/etc/ceilometer/</filename> directory.</para>
<section xml:id="section_ceilometer.conf">
<title>ceilometer.conf</title>
<para>The configuration for the Telemetry services and agents is
found in the <filename>ceilometer.conf</filename> file.</para>
<para>This file must be modified after installation.</para>
<programlisting language="ini"><xi:include parse="text" href="http://git.openstack.org/cgit/openstack/ceilometer/plain/etc/ceilometer/ceilometer.conf.sample"/></programlisting>
</section>
<section xml:id="section_event_definitions.yaml">
<title>event_definitions.yaml</title>
<para>The <filename>event_definitions.yaml</filename> file defines how
events received from other OpenStack components should be translated
to Telemetry samples.</para>
<para>You should not need to modify this file.</para>
<programlisting language="ini"><xi:include parse="text" href="http://git.openstack.org/cgit/openstack/ceilometer/plain/etc/ceilometer/event_definitions.yaml"/></programlisting>
</section>
<section xml:id="section_pipeline.yaml">
<title>pipeline.yaml</title>
<para>Pipelines describe a coupling between sources of samples and the
corresponding sinks for transformation and publication of these
data. They are defined in the <filename>pipeline.yaml</filename>
file.</para>
<para>You should not need to modify this file.</para>
<programlisting language="ini"><xi:include parse="text" href="http://git.openstack.org/cgit/openstack/ceilometer/plain/etc/ceilometer/pipeline.yaml"/></programlisting>
</section>
<section xml:id="section_ceilometer-policy.json">
<title>policy.json</title>
<para>The <filename>policy.json</filename> file defines additional
access controls that apply to the Telemetry service.</para>
<programlisting language="json"><xi:include parse="text" href="http://git.openstack.org/cgit/openstack/ceilometer/plain/etc/ceilometer/policy.json"/></programlisting>
</section>
<!-- TODO(gpocentek): include sources.json -->
</section>