openstack/openstack-manuals
Code Issues Proposed changes

Update Telemetry config reference

Browse Source 
Update the config reference with using the autohelp-wrapper script.

Change-Id: Ia37e966001a3466b65071e570a202e3f31502cde
Closes-Bug: #1418299
Closes-Bug: #1418622
Closes-Bug: #1418372
This commit is contained in:
Ildiko Vancsa 2015-02-09 10:47:25 +01:00
parent a43c87cb13
commit 33990c31fb
7 changed files with 37 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/common/tables/ceilometer-api.xml
View File

@ -65,8 +65,8 @@
<td>(StrOpt) The listen IP for the ceilometer API server.</td>
</tr>
<tr>
<td><option>pecan_debug</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Toggle Pecan Debug Middleware. Defaults to global debug value.</td>
<td><option>pecan_debug</option> = <replaceable>None</replaceable></td>
<td>(BoolOpt) Toggle Pecan Debug Middleware. If it is not set, global debug value will be used.</td>
</tr>
<tr>
<td><option>port</option> = <replaceable>8777</replaceable></td>

4
doc/common/tables/ceilometer-collector.xml
View File

@ -24,6 +24,10 @@
<tr>
<th colspan="2">[collector]</th>
</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>

4
doc/common/tables/ceilometer-common.xml
View File

@ -45,6 +45,10 @@
<td><option>rootwrap_config</option> = <replaceable>/etc/ceilometer/rootwrap.conf</replaceable></td>
<td>(StrOpt) Path to the rootwrap configuration file touse for running commands as root</td>
</tr>
<tr>
<td><option>shuffle_time_before_polling_task</option> = <replaceable>0</replaceable></td>
<td>(IntOpt) To reduce large requests at same time to Nova or other components from different compute agents, shuffle start time of polling task.</td>
</tr>
<tr>
<th colspan="2">[compute]</th>
</tr>

12
doc/common/tables/ceilometer-database.xml
View File

@ -68,6 +68,10 @@
<td><option>event_connection</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The connection string used to connect to the event database. (if unset, connection is used)</td>
</tr>
<tr>
<td><option>event_time_to_live</option> = <replaceable>-1</replaceable></td>
<td>(IntOpt) Number of seconds that events are kept in the database for (&lt;= 0 means forever).</td>
</tr>
<tr>
<td><option>idle_timeout</option> = <replaceable>3600</replaceable></td>
<td>(IntOpt) Timeout before idle SQL connections are reaped.</td>
@ -88,6 +92,10 @@
<td><option>metering_connection</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The connection string used to connect to the metering database. (if unset, connection is used)</td>
</tr>
<tr>
<td><option>metering_time_to_live</option> = <replaceable>-1</replaceable></td>
<td>(IntOpt) Number of seconds that samples are kept in the database for (&lt;= 0 means forever).</td>
</tr>
<tr>
<td><option>min_pool_size</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Minimum number of SQL connections to keep open in a pool.</td>
@ -120,10 +128,6 @@
<td><option>sqlite_synchronous</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) If True, SQLite uses synchronous mode.</td>
</tr>
<tr>
<td><option>time_to_live</option> = <replaceable>-1</replaceable></td>
<td>(IntOpt) Number of seconds that samples are kept in the database for (&lt;= 0 means forever).</td>
</tr>
<tr>
<td><option>use_db_reconnect</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable the experimental use of database reconnect on connection lost.</td>

4
doc/common/tables/ceilometer-exchange.xml
View File

@ -57,6 +57,10 @@
<td><option>sample_source</option> = <replaceable>openstack</replaceable></td>
<td>(StrOpt) Source for samples emitted on this instance.</td>
</tr>
<tr>
<td><option>swift_control_exchange</option> = <replaceable>swift</replaceable></td>
<td>(StrOpt) Exchange name for Swift notifications.</td>
</tr>
<tr>
<td><option>trove_control_exchange</option> = <replaceable>trove</replaceable></td>
<td>(StrOpt) Exchange name for DBaaS notifications.</td>

10
doc/common/tables/ceilometer-rpc.xml
View File

@ -107,20 +107,24 @@
<th colspan="2">[publisher]</th>
</tr>
<tr>
<td><option>metering_secret</option> = <replaceable>change this or be hacked</replaceable></td>
<td><option>telemetry_secret</option> = <replaceable>change this or be hacked</replaceable></td>
<td>(StrOpt) Secret value for signing metering messages.</td>
</tr>
<tr>
<th colspan="2">[publisher_notifier]</th>
</tr>
<tr>
<td><option>metering_driver</option> = <replaceable>messagingv2</replaceable></td>
<td>(StrOpt) The driver that ceilometer uses for metering notifications.</td>
<td><option>event_topic</option> = <replaceable>event</replaceable></td>
<td>(StrOpt) The topic that ceilometer uses for event notifications.</td>
</tr>
<tr>
<td><option>metering_topic</option> = <replaceable>metering</replaceable></td>
<td>(StrOpt) The topic that ceilometer uses for metering notifications.</td>
</tr>
<tr>
<td><option>telemetry_driver</option> = <replaceable>messagingv2</replaceable></td>
<td>(StrOpt) The driver that ceilometer uses for metering notifications.</td>
</tr>
<tr>
<th colspan="2">[publisher_rpc]</th>
</tr>

11
tools/autogenerate-config-flagmappings/ceilometer.flagmappings
View File

@ -98,6 +98,8 @@ rpc_zmq_port zeromq
rpc_zmq_topic_backlog zeromq
sahara_control_exchange exchange
sample_source exchange
shuffle_time_before_polling_task common
swift_control_exchange exchange
syslog_log_facility logging
transport_url amqp
trove_control_exchange exchange
@ -121,6 +123,7 @@ api/enable_reverse_dns_lookup api
api/host api
api/pecan_debug api
api/port api
collector/requeue_event_on_dispatcher_error collector
collector/requeue_sample_on_dispatcher_error collector
collector/udp_address collector
collector/udp_port collector
@ -139,11 +142,13 @@ database/db_max_retries database
database/db_max_retry_interval database
database/db_retry_interval database
database/event_connection database
database/event_time_to_live database
database/idle_timeout database
database/max_overflow database
database/max_pool_size database
database/max_retries database
database/metering_connection database
database/metering_time_to_live database
database/min_pool_size database
database/mongodb_replica_set database
database/mysql_sql_mode database
@ -152,7 +157,6 @@ database/retry_interval database
database/slave_connection database
database/sqlite_db database
database/sqlite_synchronous database
database/time_to_live database
database/use_db_reconnect database
dispatcher_file/backup_count collector
dispatcher_file/file_path collector
@ -225,9 +229,10 @@ oslo_messaging_amqp/ssl_key_file rpc
oslo_messaging_amqp/ssl_key_password rpc
oslo_messaging_amqp/trace rpc
polling/partitioning_group_prefix common
publisher/metering_secret rpc
publisher_notifier/metering_driver rpc
publisher/telemetry_secret rpc
publisher_notifier/event_topic rpc
publisher_notifier/metering_topic rpc
publisher_notifier/telemetry_driver rpc
publisher_rpc/metering_topic rpc
service_credentials/insecure auth
service_credentials/os_auth_url auth