Update Telemetry config reference
Update the config reference for Ceilometer with the recent changes and also update the conf-changes file. Change-Id: Ieffee2bedc2482697d6a0a7277be56c88fcb5a53
This commit is contained in:
Ildiko Vancsa
parent
d7d7d38e97
commit
c037dc05a7
@ -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>event_pipeline_cfg_file</option> = <replaceable>event_pipeline.yaml</replaceable></td>
|
||||
<td>(StrOpt) Configuration file for event pipeline definition.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>pipeline_cfg_file</option> = <replaceable>pipeline.yaml</replaceable></td>
|
||||
<td>(StrOpt) Configuration file for pipeline definition.</td>
|
||||
|
||||
@ -41,6 +41,10 @@
|
||||
<td><option>auth_host</option> = <replaceable>127.0.0.1</replaceable></td>
|
||||
<td>(StrOpt) Host providing the admin Identity API endpoint. Deprecated, use identity_uri.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>auth_plugin</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Name of the plugin to load</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>auth_port</option> = <replaceable>35357</replaceable></td>
|
||||
<td>(IntOpt) Port of the admin Identity API endpoint. Deprecated, use identity_uri.</td>
|
||||
@ -49,6 +53,10 @@
|
||||
<td><option>auth_protocol</option> = <replaceable>https</replaceable></td>
|
||||
<td>(StrOpt) Protocol of the admin Identity API endpoint (http or https). Deprecated, use identity_uri.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>auth_section</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Config Section from which to load plugin specific options</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>auth_uri</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Complete public Identity API endpoint.</td>
|
||||
@ -109,6 +117,26 @@
|
||||
<td><option>keyfile</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Required if identity server requires client certificate</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>memcache_pool_conn_get_timeout</option> = <replaceable>10</replaceable></td>
|
||||
<td>(IntOpt) (Optional) Number of seconds that an operation will wait to get a memcache client connection from the pool.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>memcache_pool_dead_retry</option> = <replaceable>300</replaceable></td>
|
||||
<td>(IntOpt) (Optional) Number of seconds memcached server is considered dead before it is tried again.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>memcache_pool_maxsize</option> = <replaceable>10</replaceable></td>
|
||||
<td>(IntOpt) (Optional) Maximum total number of open connections to every memcached server.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>memcache_pool_socket_timeout</option> = <replaceable>3</replaceable></td>
|
||||
<td>(IntOpt) (Optional) Socket timeout in seconds for communicating with a memcache server.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>memcache_pool_unused_timeout</option> = <replaceable>60</replaceable></td>
|
||||
<td>(IntOpt) (Optional) Number of seconds a connection to memcached is held unused in the pool before it is closed.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>memcache_secret_key</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) (Optional, mandatory if memcache_security_strategy is defined) This string is used for key derivation.</td>
|
||||
@ -117,6 +145,10 @@
|
||||
<td><option>memcache_security_strategy</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) (Optional) If defined, indicate whether token data should be authenticated or authenticated and encrypted. Acceptable values are MAC or ENCRYPT. If MAC, token data is authenticated (with HMAC) in the cache. If ENCRYPT, token data is encrypted and authenticated in the cache. If the value is not one of these options or empty, auth_token will raise an exception on initialization.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>memcache_use_advanced_pool</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) (Optional) Use the advanced (eventlet safe) memcache client pool. The advanced pool will only work under python 2.x.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>revocation_cache_time</option> = <replaceable>10</replaceable></td>
|
||||
<td>(IntOpt) Determines the frequency at which the list of revoked tokens is retrieved from the Identity service (in seconds). A high number of revocation events combined with a low cache duration may significantly reduce performance.</td>
|
||||
|
||||
30
doc/common/tables/ceilometer-concurrency.xml
Normal file
30
doc/common/tables/ceilometer-concurrency.xml
Normal file
@ -0,0 +1,30 @@
|
||||
<?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_concurrency">
|
||||
<caption>Description of concurrency 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">[oslo_concurrency]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>disable_process_locking</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Enables or disables inter-process locks.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>lock_path</option> = <replaceable>None</replaceable></td>
|
||||
<td>(StrOpt) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</para>
|
||||
@ -12,14 +12,42 @@
|
||||
<td>(Type) Help string</td>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr>
|
||||
<td>[DEFAULT] event_pipeline_cfg_file = event_pipeline.yaml</td>
|
||||
<td>(StrOpt) Configuration file for event pipeline definition.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>[DEFAULT] magnetodb_control_exchange = magnetodb</td>
|
||||
<td>(StrOpt) Exchange name for Magnetodb notifications.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>[DEFAULT] policy_dirs = ['policy.d']</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>[DEFAULT] polling_namespaces = ['compute', 'central']</td>
|
||||
<td>(MultiChoicesOpt) Polling namespace(s) to be used while resource polling</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>[DEFAULT] pollster_list = []</td>
|
||||
<td>(MultiChoicesOpt) List of pollsters (or wildcard templates) to be used while polling</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>[DEFAULT] reserved_metadata_keys = </td>
|
||||
<td>(ListOpt) List of metadata keys reserved for metering use. And these keys are additional to the ones included in the namespace.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>[DEFAULT] zaqar_control_exchange = zaqar</td>
|
||||
<td>(StrOpt) Exchange name for Messaging service notifications.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>[alarm] evaluation_service = default</td>
|
||||
<td>(StrOpt) Driver to use for alarm evaluation service. DEPRECATED: "singleton" and "partitioned" alarm evaluator services will be removed in Kilo in favour of the default alarm evaluation service using tooz for partitioning.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>[coordination] check_watchers = 10.0</td>
|
||||
<td>(FloatOpt) Number of seconds between checks to see if group membership has changed</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>[database] 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 <hostname>_<nodename>.</td>
|
||||
@ -44,9 +72,43 @@
|
||||
<td>[dispatcher_http] timeout = 5</td>
|
||||
<td>(IntOpt) The max time in second to wait for a request to timeout.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>[notification] workload_partitioning = False</td>
|
||||
<td>(BoolOpt) Enable workload partitioning, allowing multiple notification agents to be run simultaneously.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>[oslo_concurrency] disable_process_locking = False</td>
|
||||
<td>(BoolOpt) Enables or disables inter-process locks.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>[oslo_concurrency] lock_path = None</td>
|
||||
<td>(StrOpt) Directory to use for lock files. For security, the specified directory should only be writable by the user running the processes that need locking. Defaults to environment variable OSLO_LOCK_PATH. If external locks are used, a lock path must be set.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>[polling] partitioning_group_prefix = None</td>
|
||||
<td>(StrOpt) Work-load partitioning group prefix. Use only if you want to run multiple polling agents with different config files. For each sub-group of the agent pool with the same partitioning_group_prefix a disjoint subset of pollsters should be loaded.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>[vmware] host_port = 443</td>
|
||||
<td>(IntOpt) Port of the VMware Vsphere host.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table>
|
||||
<caption>New default values</caption>
|
||||
<col width="33%"/>
|
||||
<col width="33%"/>
|
||||
<col width="33%"/>
|
||||
<thead>
|
||||
<tr>
|
||||
<td>Option</td>
|
||||
<td>Previous default value</td>
|
||||
<td>New default value</td>
|
||||
</tr>
|
||||
</thead>
|
||||
<tr>
|
||||
<td>[DEFAULT] rpc_zmq_matchmaker</td>
|
||||
<td>oslo.messaging._drivers.matchmaker.MatchMakerLocalhost</td>
|
||||
<td>oslo_messaging._drivers.matchmaker.MatchMakerLocalhost</td>
|
||||
</tr>
|
||||
</table>
|
||||
</section>
|
||||
|
||||
@ -29,10 +29,6 @@
|
||||
<td><option>fatal_deprecations</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Enables or disables fatal status of deprecations.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>fatal_exception_format_errors</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Make exception message format errors fatal</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>instance_format</option> = <replaceable>"[instance: %(uuid)s] "</replaceable></td>
|
||||
<td>(StrOpt) The format for an instance that is passed with the log message.</td>
|
||||
|
||||
@ -35,7 +35,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>kombu_ssl_version</option> = <replaceable></replaceable></td>
|
||||
<td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1 and SSLv23. SSLv2 and SSLv3 may be available on some distributions.</td>
|
||||
<td>(StrOpt) SSL version to use (valid only if SSL enabled). Valid values are TLSv1 and SSLv23. SSLv2, SSLv3, TLSv1_1, and TLSv1_2 may be available on some distributions.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>rabbit_ha_queues</option> = <replaceable>False</replaceable></td>
|
||||
|
||||
@ -47,7 +47,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>rpc_thread_pool_size</option> = <replaceable>64</replaceable></td>
|
||||
<td>(IntOpt) Size of RPC greenthread pool.</td>
|
||||
<td>(IntOpt) Size of RPC thread pool.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th colspan="2">[notification]</th>
|
||||
|
||||
@ -21,14 +21,6 @@
|
||||
<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>monkey_patch</option> = <replaceable>False</replaceable></td>
|
||||
<td>(BoolOpt) Whether to log monkey patching</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>monkey_patch_modules</option> = <replaceable>nova.api.ec2.cloud:nova.notifications.notify_decorator, nova.compute.api:nova.notifications.notify_decorator</replaceable></td>
|
||||
<td>(ListOpt) List of modules/decorators to monkey patch</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</para>
|
||||
|
||||
@ -34,7 +34,7 @@
|
||||
<td>(StrOpt) Directory for holding IPC sockets.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><option>rpc_zmq_matchmaker</option> = <replaceable>oslo.messaging._drivers.matchmaker.MatchMakerLocalhost</replaceable></td>
|
||||
<td><option>rpc_zmq_matchmaker</option> = <replaceable>oslo_messaging._drivers.matchmaker.MatchMakerLocalhost</replaceable></td>
|
||||
<td>(StrOpt) MatchMaker driver.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
|
||||
@ -22,6 +22,7 @@
|
||||
<xi:include href="../common/tables/ceilometer-auth_token.xml"/>
|
||||
<xi:include href="../common/tables/ceilometer-collector.xml"/>
|
||||
<xi:include href="../common/tables/ceilometer-common.xml"/>
|
||||
<xi:include href="../common/tables/ceilometer-concurrency.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"/>
|
||||
|
||||
@ -9,9 +9,9 @@ database_connection database
|
||||
debug logging
|
||||
default_log_levels logging
|
||||
dispatcher rpc
|
||||
event_pipeline_cfg_file api
|
||||
fake_rabbit testing
|
||||
fatal_deprecations logging
|
||||
fatal_exception_format_errors logging
|
||||
glance_control_exchange exchange
|
||||
glance_page_size glance
|
||||
heat_control_exchange exchange
|
||||
@ -20,7 +20,6 @@ http_control_exchanges exchange
|
||||
http_timeout common
|
||||
hypervisor_inspector inspector
|
||||
instance_format logging
|
||||
instance_usage_audit_period compute
|
||||
instance_uuid_format logging
|
||||
ironic_exchange exchange
|
||||
keystone_control_exchange exchange
|
||||
@ -44,15 +43,12 @@ magnetodb_control_exchange magnetodb
|
||||
matchmaker_heartbeat_freq rpc
|
||||
matchmaker_heartbeat_ttl rpc
|
||||
memcached_servers common
|
||||
monkey_patch testing
|
||||
monkey_patch_modules testing
|
||||
neutron_control_exchange exchange
|
||||
notification_driver amqp
|
||||
notification_topics amqp
|
||||
notification_workers common
|
||||
nova_control_exchange exchange
|
||||
nova_http_log_debug debug
|
||||
password_length compute
|
||||
pipeline_cfg_file api
|
||||
policy_default_rule api
|
||||
policy_dirs api
|
||||
@ -125,16 +121,6 @@ api/enable_reverse_dns_lookup api
|
||||
api/host api
|
||||
api/pecan_debug api
|
||||
api/port api
|
||||
cells/bandwidth_update_interval cells
|
||||
cells/call_timeout cells
|
||||
cells/capabilities cells
|
||||
cells/cell_type cells
|
||||
cells/enable cells
|
||||
cells/manager cells
|
||||
cells/mute_child_interval cells
|
||||
cells/name cells
|
||||
cells/reserve_percent cells
|
||||
cells/topic cells
|
||||
collector/requeue_sample_on_dispatcher_error collector
|
||||
collector/udp_address collector
|
||||
collector/udp_port collector
|
||||
@ -186,8 +172,10 @@ keystone_authtoken/admin_token auth_token
|
||||
keystone_authtoken/admin_user auth_token
|
||||
keystone_authtoken/auth_admin_prefix auth_token
|
||||
keystone_authtoken/auth_host auth_token
|
||||
keystone_authtoken/auth_plugin auth_token
|
||||
keystone_authtoken/auth_port auth_token
|
||||
keystone_authtoken/auth_protocol auth_token
|
||||
keystone_authtoken/auth_section auth_token
|
||||
keystone_authtoken/auth_uri auth_token
|
||||
keystone_authtoken/auth_version auth_token
|
||||
keystone_authtoken/cache auth_token
|
||||
@ -203,8 +191,14 @@ keystone_authtoken/identity_uri auth_token
|
||||
keystone_authtoken/include_service_catalog auth_token
|
||||
keystone_authtoken/insecure auth_token
|
||||
keystone_authtoken/keyfile auth_token
|
||||
keystone_authtoken/memcache_pool_conn_get_timeout auth_token
|
||||
keystone_authtoken/memcache_pool_dead_retry auth_token
|
||||
keystone_authtoken/memcache_pool_maxsize auth_token
|
||||
keystone_authtoken/memcache_pool_socket_timeout auth_token
|
||||
keystone_authtoken/memcache_pool_unused_timeout auth_token
|
||||
keystone_authtoken/memcache_secret_key auth_token
|
||||
keystone_authtoken/memcache_security_strategy auth_token
|
||||
keystone_authtoken/memcache_use_advanced_pool auth_token
|
||||
keystone_authtoken/memcached_servers common
|
||||
keystone_authtoken/revocation_cache_time auth_token
|
||||
keystone_authtoken/signing_dir auth_token
|
||||
@ -217,6 +211,8 @@ notification/ack_on_event_error events
|
||||
notification/messaging_urls rpc
|
||||
notification/store_events events
|
||||
notification/workload_partitioning events
|
||||
oslo_concurrency/disable_process_locking concurrency
|
||||
oslo_concurrency/lock_path concurrency
|
||||
oslo_messaging_amqp/allow_insecure_clients rpc
|
||||
oslo_messaging_amqp/broadcast_prefix rpc
|
||||
oslo_messaging_amqp/container_name rpc
|
||||
|
||||
Loading…
Reference in New Issue
Block a user