openstack/openstack-manuals
Code Issues Proposed changes

Update Telemetry Config Ref

Browse Source 
Update Telemetry's config reference according to the recent
changes.

closes-Bug: #1399150
Closes-Bug: #1391160
Partially-Closes-Bug: #1400422

Change-Id: I4e3dc79b9f6c48d6b68352864f30d0aa2209fb31
This commit is contained in:
Ildiko Vancsa 2014-12-08 19:34:46 +01:00
parent 7d65f1efc0
commit 3a573f42ca
7 changed files with 53 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -31,7 +31,7 @@
</tr>
<tr>
<td>policy_dirs = ['policy.d']</td>
<td>(MultiStrOpt) The directories of policy configuration files is stored</td>
<td>(MultiStrOpt) Directories where policy configuration files are stored. They can be relative to any directory in the search path defined by the config_dir option, or absolute paths. The file defined by policy_file must exist for these directories to be searched.</td>
</tr>
<tr>
<td>policy_file = policy.json</td>

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

@ -21,6 +21,10 @@
<td>host = localhost</td>
<td>(StrOpt) Name of this node, which must be valid in an AMQP key. Can be an opaque identifier. For ZeroMQ only, must be a valid host name, FQDN, or IP address.</td>
</tr>
<tr>
<td>http_timeout = 600</td>
<td>(IntOpt) Timeout seconds for HTTP requests. Set it to None to disable timeout.</td>
</tr>
<tr>
<td>memcached_servers = None</td>
<td>(ListOpt) Memcached servers or None for in process cache.</td>

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

@ -44,6 +44,10 @@
<td>connection_trace = False</td>
<td>(BoolOpt) Add Python stack traces to SQL as comment strings.</td>
</tr>
<tr>
<td>db2nosql_resource_id_maxlen = 512</td>
<td>(IntOpt) The max length of resources id in DB2 nosql, the value should be larger than len(hostname) * 2 as compute node's resource id is &lt;hostname&gt;_&lt;nodename&gt;.</td>
</tr>
<tr>
<td>db_inc_retry_interval = True</td>
<td>(BoolOpt) If True, increases the interval between database connection retries up to db_max_retry_interval.</td>
@ -78,11 +82,11 @@
</tr>
<tr>
<td>max_retries = 10</td>
<td>(IntOpt) Maximum db connection retries during startup. Set to -1 to specify an infinite retry count.</td>
<td>(IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.</td>
</tr>
<tr>
<td>metering_connection = None</td>
<td>(StrOpt) The connection string used to connect to the meteting database. (if unset, connection is used)</td>
<td>(StrOpt) The connection string used to connect to the metering database. (if unset, connection is used)</td>
</tr>
<tr>
<td>min_pool_size = 1</td>
@ -90,7 +94,7 @@
</tr>
<tr>
<td>mongodb_replica_set = </td>
<td>(StrOpt) The connection string used to connect to mongo database, if mongodb replica set was chosen.</td>
<td>(StrOpt) The name of the replica set which is used to connect to MongoDB database. If it is set, MongoReplicaSetClient will be used instead of MongoClient.</td>
</tr>
<tr>
<td>mysql_sql_mode = TRADITIONAL</td>

34
doc/common/tables/ceilometer-dispatcher_http.xml Normal file
View File

@ -0,0 +1,34 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_ceilometer_dispatcher_http">
<caption>Description of HTTP dispatcher 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">[dispatcher_http]</th>
</tr>
<tr>
<td>cadf_only = False</td>
<td>(BoolOpt) The flag which indicates if only cadf message should be posted. If false, all meters will be posted.</td>
</tr>
<tr>
<td>target = </td>
<td>(StrOpt) The target where the http request will be sent to. If this is not set, no data will be posted. For example: target = http://hostname:1234/path</td>
</tr>
<tr>
<td>timeout = 5</td>
<td>(IntOpt) The max time in second to wait for a request to timeout.</td>
</tr>
</tbody>
</table>
</para>

1
doc/config-reference/ch_telemetryconfigure.xml
View File

@ -24,6 +24,7 @@
<xi:include href="../common/tables/ceilometer-common.xml"/>
<xi:include href="../common/tables/ceilometer-database.xml"/>
<xi:include href="../common/tables/ceilometer-debug.xml"/>
<xi:include href="../common/tables/ceilometer-dispatcher_http.xml"/>
<xi:include href="../common/tables/ceilometer-events.xml"/>
<xi:include href="../common/tables/ceilometer-exchange.xml"/>
<xi:include href="../common/tables/ceilometer-glance.xml"/>

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

@ -16,6 +16,7 @@ glance_page_size glance
heat_control_exchange exchange
host common
http_control_exchanges exchange
http_timeout common
hypervisor_inspector inspector
instance_format logging
instance_uuid_format logging
@ -126,6 +127,7 @@ database/backend database
database/connection database
database/connection_debug database
database/connection_trace database
database/db2nosql_resource_id_maxlen database
database/db_inc_retry_interval database
database/db_max_retries database
database/db_max_retry_interval database
@ -149,6 +151,9 @@ database/use_db_reconnect database
dispatcher_file/backup_count collector
dispatcher_file/file_path collector
dispatcher_file/max_bytes collector
dispatcher_http/cadf_only dispatcher_http
dispatcher_http/target dispatcher_http
dispatcher_http/timeout dispatcher_http
event/definitions_cfg_file events
event/drop_unmatched_notifications events
hardware/readonly_user_name tripleo

1
tools/autogenerate-config-flagmappings/ceilometer.headers
View File

@ -1,5 +1,6 @@
alarm alarm
collector collector
dispatcher_http HTTP dispatcher
events events
exchange exchange
inspector inspector