openstack-manuals/doc/common/tables/ceilometer-collector.xml
Gauvain Pocentek e7cbc675ce update the config reference tables for liberty
Change-Id: I959cc6884633ada1deb55f44ca1fc6f230bdebd9
2015-10-29 07:45:04 +01:00

80 lines
3.2 KiB
XML

<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!--
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
Warning: Do not edit this file. It is automatically
generated from the software project's code and your changes
will be overwritten.
The tool to generate this file lives in openstack-doc-tools
repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools
repository, or ask for help on the documentation mailing list,
IRC channel or meeting.
###################################################################
WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
###################################################################
-->
<table rules="all" xml:id="config_table_ceilometer_collector">
<caption>Description of collector configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[collector]</th>
</tr>
<tr>
<td><option>enable_rpc</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable the RPC functionality of collector. This functionality is now deprecated in favour of notifier publisher and queues.</td>
</tr>
<tr>
<td><option>requeue_event_on_dispatcher_error</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Requeue the event on the collector event queue when the collector fails to dispatch it.</td>
</tr>
<tr>
<td><option>requeue_sample_on_dispatcher_error</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Requeue the sample on the collector sample queue when the collector fails to dispatch it. This is only valid if the sample come from the notifier publisher.</td>
</tr>
<tr>
<td><option>udp_address</option> = <replaceable>0.0.0.0</replaceable></td>
<td>(StrOpt) Address to which the UDP socket is bound. Set to an empty string to disable.</td>
</tr>
<tr>
<td><option>udp_port</option> = <replaceable>4952</replaceable></td>
<td>(IntOpt) Port to which the UDP socket is bound.</td>
</tr>
<tr>
<td><option>workers</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Number of workers for collector service. default value is 1.</td>
</tr>
<tr>
<th colspan="2">[dispatcher_file]</th>
</tr>
<tr>
<td><option>backup_count</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) The max number of the files to keep.</td>
</tr>
<tr>
<td><option>file_path</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) Name and the location of the file to record meters.</td>
</tr>
<tr>
<td><option>max_bytes</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) The max size of the file.</td>
</tr>
</tbody>
</table>
</para>