openstack/openstack-manuals
Code Issues Proposed changes

Update Telemetry Config Ref for Kilo

Browse Source 
Update the config reference and generate conf-changes
file for the Kilo release.

Closes-Bug: #1438882
Closes-Bug: #1421748
Closes-Bug: #1429957
Closes-Bug: #1430020
Closes-Bug: #1430290
Closes-Bug: #1426168
Closes-Bug: #1433793

Change-Id: Ic2348613cb13b0ad2fa622aaa04a44cec56b3e27
This commit is contained in:
Ildiko Vancsa 2015-04-07 11:16:09 +02:00
parent 5371252027
commit 5ff09ddf7c
15 changed files with 168 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
doc/common/tables/ceilometer-alarms.xml Normal file
View File

@ -0,0 +1,26 @@
<?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_alarms">
<caption>Description of alarms 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">[alarms]</th>
</tr>
<tr>
<td><option>gnocchi_url</option> = <replaceable>http://localhost:8041</replaceable></td>
<td>(StrOpt) URL to Gnocchi.</td>
</tr>
</tbody>
</table>
</para>

8
doc/common/tables/ceilometer-amqp.xml
View File

@ -17,14 +17,6 @@
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>amqp_auto_delete</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Auto-delete queues in AMQP.</td>
</tr>
<tr>
<td><option>amqp_durable_queues</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use durable queues in AMQP.</td>
</tr>
<tr>
<td><option>control_exchange</option> = <replaceable>openstack</replaceable></td>
<td>(StrOpt) The default exchange under which topics are scoped. May be overridden by an exchange name specified in the transport_url option.</td>

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

@ -21,6 +21,10 @@
<td><option>api_paste_config</option> = <replaceable>api_paste.ini</replaceable></td>
<td>(StrOpt) Configuration file for WSGI definition of API.</td>
</tr>
<tr>
<td><option>api_workers</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Number of workers for Ceilometer API server.</td>
</tr>
<tr>
<td><option>event_pipeline_cfg_file</option> = <replaceable>event_pipeline.yaml</replaceable></td>
<td>(StrOpt) Configuration file for event pipeline definition.</td>
@ -29,18 +33,6 @@
<td><option>pipeline_cfg_file</option> = <replaceable>pipeline.yaml</replaceable></td>
<td>(StrOpt) Configuration file for pipeline definition.</td>
</tr>
<tr>
<td><option>policy_default_rule</option> = <replaceable>default</replaceable></td>
<td>(StrOpt) Default rule. Enforced when a requested rule is not found.</td>
</tr>
<tr>
<td><option>policy_dirs</option> = <replaceable>['policy.d']</replaceable></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><option>policy_file</option> = <replaceable>policy.json</replaceable></td>
<td>(StrOpt) The JSON file that defines policies.</td>
</tr>
<tr>
<td><option>reserved_metadata_keys</option> = <replaceable></replaceable></td>
<td>(ListOpt) List of metadata keys reserved for metering use. And these keys are additional to the ones included in the namespace.</td>
@ -56,17 +48,13 @@
<tr>
<th colspan="2">[api]</th>
</tr>
<tr>
<td><option>enable_reverse_dns_lookup</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Set it to False if your environment does not need or have a DNS server, otherwise it will delay the response from the API.</td>
</tr>
<tr>
<td><option>host</option> = <replaceable>0.0.0.0</replaceable></td>
<td>(StrOpt) The listen IP for the ceilometer API server.</td>
</tr>
<tr>
<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>
<td><option>pecan_debug</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Toggle Pecan Debug Middleware.</td>
</tr>
<tr>
<td><option>port</option> = <replaceable>8777</replaceable></td>

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

@ -49,6 +49,10 @@
<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>
<td><option>sql_expire_samples_only</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Indicates if expirer expires only samples. If set true, expired samples will be deleted, but residual resource and meter definition data will remain.</td>
</tr>
<tr>
<th colspan="2">[compute]</th>
</tr>

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

@ -50,19 +50,19 @@
</tr>
<tr>
<td><option>db_inc_retry_interval</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) If True, increases the interval between database connection retries up to db_max_retry_interval.</td>
<td>(BoolOpt) If True, increases the interval between retries of a database operation up to db_max_retry_interval.</td>
</tr>
<tr>
<td><option>db_max_retries</option> = <replaceable>20</replaceable></td>
<td>(IntOpt) Maximum database connection retries before error is raised. Set to -1 to specify an infinite retry count.</td>
<td>(IntOpt) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count.</td>
</tr>
<tr>
<td><option>db_max_retry_interval</option> = <replaceable>10</replaceable></td>
<td>(IntOpt) If db_inc_retry_interval is set, the maximum seconds between database connection retries.</td>
<td>(IntOpt) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.</td>
</tr>
<tr>
<td><option>db_retry_interval</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Seconds between database connection retries.</td>
<td>(IntOpt) Seconds between retries of a database transaction.</td>
</tr>
<tr>
<td><option>event_connection</option> = <replaceable>None</replaceable></td>

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

@ -19,15 +19,19 @@
</tr>
<tr>
<td><option>cadf_only</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) The flag which indicates if only cadf message should be posted. If false, all meters will be posted.</td>
<td>(BoolOpt) The flag that indicates if only cadf message should be posted. If false, all meters will be posted.</td>
</tr>
<tr>
<td><option>event_target</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The target for event data where the http request will be sent to. If this is not set, it will default to same as Sample target.</td>
</tr>
<tr>
<td><option>target</option> = <replaceable></replaceable></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>
<td>(StrOpt) The target where the http request will be sent. If this is not set, no data will be posted. For example: target = http://hostname:1234/path</td>
</tr>
<tr>
<td><option>timeout</option> = <replaceable>5</replaceable></td>
<td>(IntOpt) The max time in second to wait for a request to timeout.</td>
<td>(IntOpt) The max time in seconds to wait for a request to timeout.</td>
</tr>
</tbody>
</table>

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

@ -25,6 +25,10 @@
<td><option>drop_unmatched_notifications</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Drop notifications if no event definition matches. (Otherwise, we convert them with just the default traits)</td>
</tr>
<tr>
<td><option>store_raw</option> = <replaceable>[]</replaceable></td>
<td>(MultiStrOpt) Store the raw notification for select priority levels (info and/or error). By default, raw details are not captured.</td>
</tr>
<tr>
<th colspan="2">[notification]</th>
</tr>

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

@ -23,7 +23,7 @@
</tr>
<tr>
<td><option>libvirt_type</option> = <replaceable>kvm</replaceable></td>
<td>(StrOpt) Libvirt domain type (valid options are: kvm, lxc, qemu, uml, xen).</td>
<td>(StrOpt) Libvirt domain type.</td>
</tr>
<tr>
<td><option>libvirt_uri</option> = <replaceable></replaceable></td>

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

@ -21,6 +21,10 @@
<td><option>node_manager_init_retry</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) Number of retries upon Intel Node Manager initialization failure</td>
</tr>
<tr>
<td><option>polling_retry</option> = <replaceable>3</replaceable></td>
<td>(IntOpt) Tolerance of IPMI/NM polling failures before disable this pollster. Negative indicates retrying forever.</td>
</tr>
</tbody>
</table>
</para>

26
doc/common/tables/ceilometer-notification.xml Normal file
View File

@ -0,0 +1,26 @@
<?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_notification">
<caption>Description of notification 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">[notification]</th>
</tr>
<tr>
<td><option>disable_non_metric_meters</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) WARNING: Ceilometer historically offered the ability to store events as meters. This usage is NOT advised as it can flood the metering database and cause performance degradation. This option disables the collection of non-metric meters and will be the default behavior in Liberty.</td>
</tr>
</tbody>
</table>
</para>

14
doc/common/tables/ceilometer-qpid.xml
View File

@ -15,7 +15,15 @@
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
<th colspan="2">[oslo_messaging_qpid]</th>
</tr>
<tr>
<td><option>amqp_auto_delete</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Auto-delete queues in AMQP.</td>
</tr>
<tr>
<td><option>amqp_durable_queues</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use durable queues in AMQP.</td>
</tr>
<tr>
<td><option>qpid_heartbeat</option> = <replaceable>60</replaceable></td>
@ -61,6 +69,10 @@
<td><option>qpid_username</option> = <replaceable></replaceable></td>
<td>(StrOpt) Username for Qpid connection.</td>
</tr>
<tr>
<td><option>rpc_conn_pool_size</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) Size of RPC connection pool.</td>
</tr>
</tbody>
</table>
</para>

26
doc/common/tables/ceilometer-rabbitmq.xml
View File

@ -15,7 +15,27 @@
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
<th colspan="2">[oslo_messaging_rabbit]</th>
</tr>
<tr>
<td><option>amqp_auto_delete</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Auto-delete queues in AMQP.</td>
</tr>
<tr>
<td><option>amqp_durable_queues</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Use durable queues in AMQP.</td>
</tr>
<tr>
<td><option>fake_rabbit</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Deprecated, use rpc_backend=kombu+memory or rpc_backend=fake</td>
</tr>
<tr>
<td><option>heartbeat_rate</option> = <replaceable>2</replaceable></td>
<td>(IntOpt) How often times during the heartbeat_timeout_threshold we check the heartbeat.</td>
</tr>
<tr>
<td><option>heartbeat_timeout_threshold</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Number of seconds after which the Rabbit broker is considered down if heartbeat's keep-alive fails (0 disable the heartbeat).</td>
</tr>
<tr>
<td><option>kombu_reconnect_delay</option> = <replaceable>1.0</replaceable></td>
@ -85,6 +105,10 @@
<td><option>rabbit_virtual_host</option> = <replaceable>/</replaceable></td>
<td>(StrOpt) The RabbitMQ virtual host.</td>
</tr>
<tr>
<td><option>rpc_conn_pool_size</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) Size of RPC connection pool.</td>
</tr>
</tbody>
</table>
</para>

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

@ -37,10 +37,6 @@
<td><option>rpc_cast_timeout</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) Seconds to wait before a cast expires (TTL). Only supported by impl_zmq.</td>
</tr>
<tr>
<td><option>rpc_conn_pool_size</option> = <replaceable>30</replaceable></td>
<td>(IntOpt) Size of RPC connection pool.</td>
</tr>
<tr>
<td><option>rpc_response_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Seconds to wait for a response from a call.</td>
@ -107,8 +103,8 @@
<th colspan="2">[publisher]</th>
</tr>
<tr>
<td><option>telemetry_secret</option> = <replaceable>change this or be hacked</replaceable></td>
<td>(StrOpt) Secret value for signing metering messages.</td>
<td><option>telemetry_secret</option> = <replaceable>change this for valid signing</replaceable></td>
<td>(StrOpt) Secret value for signing messages. Set value empty if signing is not required to avoid computational overhead.</td>
</tr>
<tr>
<th colspan="2">[publisher_notifier]</th>

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

@ -1,6 +1,5 @@
amqp_auto_delete amqp
amqp_durable_queues amqp
api_paste_config api
api_workers api
backdoor_port debug
cinder_control_exchange exchange
collector_workers collector
@ -10,7 +9,6 @@ debug logging
default_log_levels logging
dispatcher rpc
event_pipeline_cfg_file api
fake_rabbit testing
fatal_deprecations logging
glance_control_exchange exchange
glance_page_size glance
@ -23,11 +21,6 @@ instance_format logging
instance_uuid_format logging
ironic_exchange exchange
keystone_control_exchange exchange
kombu_reconnect_delay rabbitmq
kombu_ssl_ca_certs rabbitmq
kombu_ssl_certfile rabbitmq
kombu_ssl_keyfile rabbitmq
kombu_ssl_version rabbitmq
libvirt_type inspector
libvirt_uri inspector
log_config_append logging
@ -50,35 +43,9 @@ notification_workers common
nova_control_exchange exchange
nova_http_log_debug debug
pipeline_cfg_file api
policy_default_rule api
policy_dirs api
policy_file api
polling_namespaces common
pollster_list common
publish_errors logging
qpid_heartbeat qpid
qpid_hostname qpid
qpid_hosts qpid
qpid_password qpid
qpid_port qpid
qpid_protocol qpid
qpid_receiver_capacity qpid
qpid_sasl_mechanisms qpid
qpid_tcp_nodelay qpid
qpid_topology_version qpid
qpid_username qpid
rabbit_ha_queues rabbitmq
rabbit_host rabbitmq
rabbit_hosts rabbitmq
rabbit_login_method rabbitmq
rabbit_max_retries rabbitmq
rabbit_password rabbitmq
rabbit_port rabbitmq
rabbit_retry_backoff rabbitmq
rabbit_retry_interval rabbitmq
rabbit_use_ssl rabbitmq
rabbit_userid rabbitmq
rabbit_virtual_host rabbitmq
reseller_prefix swift
reserved_metadata_keys api
reserved_metadata_length api
@ -86,7 +53,6 @@ reserved_metadata_namespace api
rootwrap_config common
rpc_backend rpc
rpc_cast_timeout rpc
rpc_conn_pool_size rpc
rpc_response_timeout rpc
rpc_thread_pool_size rpc
rpc_zmq_bind_address zeromq
@ -99,6 +65,7 @@ rpc_zmq_topic_backlog zeromq
sahara_control_exchange exchange
sample_source exchange
shuffle_time_before_polling_task common
sql_expire_samples_only common
swift_control_exchange exchange
syslog_log_facility logging
transport_url amqp
@ -119,7 +86,7 @@ alarm/rest_notifier_certificate_key alarm
alarm/rest_notifier_max_retries alarm
alarm/rest_notifier_ssl_verify alarm
alarm/user_alarm_quota alarm
api/enable_reverse_dns_lookup api
alarms/gnocchi_url alarms
api/host api
api/pecan_debug api
api/port api
@ -162,14 +129,17 @@ dispatcher_file/backup_count collector
dispatcher_file/file_path collector
dispatcher_file/max_bytes collector
dispatcher_http/cadf_only dispatcher_http
dispatcher_http/event_target dispatcher_http
dispatcher_http/target dispatcher_http
dispatcher_http/timeout dispatcher_http
event/definitions_cfg_file events
event/drop_unmatched_notifications events
event/store_raw events
hardware/readonly_user_name tripleo
hardware/readonly_user_password tripleo
hardware/url_scheme tripleo
ipmi/node_manager_init_retry ipmi
ipmi/polling_retry ipmi
keystone_authtoken/admin_password auth_token
keystone_authtoken/admin_tenant_name auth_token
keystone_authtoken/admin_token auth_token
@ -212,6 +182,7 @@ matchmaker_redis/password redis
matchmaker_redis/port redis
matchmaker_ring/ringfile redis
notification/ack_on_event_error events
notification/disable_non_metric_meters notification
notification/messaging_urls rpc
notification/store_events events
notification/workload_partitioning events
@ -228,6 +199,43 @@ oslo_messaging_amqp/ssl_cert_file rpc
oslo_messaging_amqp/ssl_key_file rpc
oslo_messaging_amqp/ssl_key_password rpc
oslo_messaging_amqp/trace rpc
oslo_messaging_qpid/amqp_auto_delete qpid
oslo_messaging_qpid/amqp_durable_queues qpid
oslo_messaging_qpid/qpid_heartbeat qpid
oslo_messaging_qpid/qpid_hostname qpid
oslo_messaging_qpid/qpid_hosts qpid
oslo_messaging_qpid/qpid_password qpid
oslo_messaging_qpid/qpid_port qpid
oslo_messaging_qpid/qpid_protocol qpid
oslo_messaging_qpid/qpid_receiver_capacity qpid
oslo_messaging_qpid/qpid_sasl_mechanisms qpid
oslo_messaging_qpid/qpid_tcp_nodelay qpid
oslo_messaging_qpid/qpid_topology_version qpid
oslo_messaging_qpid/qpid_username qpid
oslo_messaging_qpid/rpc_conn_pool_size qpid
oslo_messaging_rabbit/amqp_auto_delete rabbitmq
oslo_messaging_rabbit/amqp_durable_queues rabbitmq
oslo_messaging_rabbit/fake_rabbit rabbitmq
oslo_messaging_rabbit/heartbeat_rate rabbitmq
oslo_messaging_rabbit/heartbeat_timeout_threshold rabbitmq
oslo_messaging_rabbit/kombu_reconnect_delay rabbitmq
oslo_messaging_rabbit/kombu_ssl_ca_certs rabbitmq
oslo_messaging_rabbit/kombu_ssl_certfile rabbitmq
oslo_messaging_rabbit/kombu_ssl_keyfile rabbitmq
oslo_messaging_rabbit/kombu_ssl_version rabbitmq
oslo_messaging_rabbit/rabbit_ha_queues rabbitmq
oslo_messaging_rabbit/rabbit_host rabbitmq
oslo_messaging_rabbit/rabbit_hosts rabbitmq
oslo_messaging_rabbit/rabbit_login_method rabbitmq
oslo_messaging_rabbit/rabbit_max_retries rabbitmq
oslo_messaging_rabbit/rabbit_password rabbitmq
oslo_messaging_rabbit/rabbit_port rabbitmq
oslo_messaging_rabbit/rabbit_retry_backoff rabbitmq
oslo_messaging_rabbit/rabbit_retry_interval rabbitmq
oslo_messaging_rabbit/rabbit_use_ssl rabbitmq
oslo_messaging_rabbit/rabbit_userid rabbitmq
oslo_messaging_rabbit/rabbit_virtual_host rabbitmq
oslo_messaging_rabbit/rpc_conn_pool_size rabbitmq
polling/partitioning_group_prefix common
publisher/telemetry_secret rpc
publisher_notifier/event_topic rpc

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

@ -1,9 +1,11 @@
alarm alarm
alarms alarms
collector collector
dispatcher_http HTTP dispatcher
events events
exchange exchange
inspector inspector
magnetodb MagnetoDB
notification notification
service_types service types
zaqar Zaqar