openstack
/
openstack-manuals
Code Issues Proposed changes

Merge "Update Config reference for ceilometer"

This commit is contained in:
Jenkins 2015-09-03 14:54:31 +00:00 committed by Gerrit Code Review
parent dd3d949e21 94391237f6
commit ed802f7bbd
13 changed files with 70 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -21,10 +21,6 @@
<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>
@ -57,9 +53,21 @@
<th colspan="2">[api]</th>
</tr>
<tr>
<td><option>default_api_return_limit</option> = <replaceable>1000</replaceable></td>
<td><option>aodh_is_enabled</option> = <replaceable>None</replaceable></td>
<td>(BoolOpt) Set True to redirect alarms URLs to aodh. Default autodetection by querying keystone.</td>
</tr>
<tr>
<td><option>aodh_url</option> = <replaceable>None</replaceable></td>
<td>(StrOpt) The endpoint of Aodh to redirect alarms URLs to Aodh API. Default autodetection by querying keystone.</td>
</tr>
<tr>
<td><option>default_api_return_limit</option> = <replaceable>100</replaceable></td>
<td>(IntOpt) Default maximum number of items returned by API request.</td>
</tr>
<tr>
<td><option>gnocchi_is_enabled</option> = <replaceable>None</replaceable></td>
<td>(BoolOpt) Set True to disable resource/meter/sample URLs. Default autodetection by querying keystone.</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>
@ -72,6 +80,10 @@
<td><option>port</option> = <replaceable>8777</replaceable></td>
<td>(IntOpt) The port for the ceilometer API server.</td>
</tr>
<tr>
<td><option>workers</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Number of workers for api, default value is 1.</td>
</tr>
<tr>
<th colspan="2">[oslo_middleware]</th>
</tr>

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

@ -14,16 +14,13 @@
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>collector_workers</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Number of workers for collector service. A single collector is enabled by default.</td>
</tr>
<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>
@ -40,6 +37,10 @@
<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>

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

@ -17,6 +17,14 @@
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td><option>batch_polled_samples</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) To reduce polling agent load, samples are sent to the notification agent in a batch. To gain higher throughput at the cost of load set this to False.</td>
</tr>
<tr>
<td><option>executor_thread_pool_size</option> = <replaceable>64</replaceable></td>
<td>(IntOpt) Size of executor thread pool.</td>
</tr>
<tr>
<td><option>host</option> = <replaceable>localhost</replaceable></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>
@ -29,10 +37,6 @@
<td><option>memcached_servers</option> = <replaceable>None</replaceable></td>
<td>(ListOpt) Memcached servers or None for in process cache.</td>
</tr>
<tr>
<td><option>notification_workers</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Number of workers for notification service. A single notification agent is enabled by default.</td>
</tr>
<tr>
<td><option>polling_namespaces</option> = <replaceable>['compute', 'central']</replaceable></td>
<td>(MultiChoicesOpt) Polling namespace(s) to be used while resource polling</td>

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

@ -106,7 +106,7 @@
</tr>
<tr>
<td><option>mongodb_replica_set</option> = <replaceable></replaceable></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>
<td>(StrOpt) The name of the replica set which is used to connect to MongoDB database. Add "?replicaSet=myreplicatset" in your connection URI instead.</td>
</tr>
<tr>
<td><option>mysql_sql_mode</option> = <replaceable>TRADITIONAL</replaceable></td>

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

@ -33,6 +33,10 @@
<td><option>filter_service_activity</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) Filter out samples generated by Gnocchi service activity</td>
</tr>
<tr>
<td><option>resources_definition_file</option> = <replaceable>gnocchi_resources.yaml</replaceable></td>
<td>(StrOpt) The Yaml file that defines mapping between samples and gnocchi resources/metrics</td>
</tr>
<tr>
<td><option>url</option> = <replaceable>http://localhost:8041</replaceable></td>
<td>(StrOpt) URL to Gnocchi.</td>

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

@ -40,6 +40,10 @@
<td><option>store_events</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Save event details.</td>
</tr>
<tr>
<td><option>workers</option> = <replaceable>1</replaceable></td>
<td>(IntOpt) Number of workers for notification service, default value is 1.</td>
</tr>
<tr>
<td><option>workload_partitioning</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Enable workload partitioning, allowing multiple notification agents to be run simultaneously.</td>

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

@ -25,6 +25,10 @@
<td><option>cinder_control_exchange</option> = <replaceable>cinder</replaceable></td>
<td>(StrOpt) Exchange name for Cinder notifications.</td>
</tr>
<tr>
<td><option>dns_control_exchange</option> = <replaceable>central</replaceable></td>
<td>(StrOpt) Exchange name for DNS notifications.</td>
</tr>
<tr>
<td><option>glance_control_exchange</option> = <replaceable>glance</replaceable></td>
<td>(StrOpt) Exchange name for Glance notifications.</td>
@ -45,6 +49,10 @@
<td><option>keystone_control_exchange</option> = <replaceable>keystone</replaceable></td>
<td>(StrOpt) Exchange name for Keystone notifications.</td>
</tr>
<tr>
<td><option>magnum_control_exchange</option> = <replaceable>magnum</replaceable></td>
<td>(StrOpt) Exchange name for Magnum notifications.</td>
</tr>
<tr>
<td><option>neutron_control_exchange</option> = <replaceable>neutron</replaceable></td>
<td>(StrOpt) Exchange name for Neutron notifications.</td>

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

@ -19,7 +19,7 @@
</tr>
<tr>
<td><option>hypervisor_inspector</option> = <replaceable>libvirt</replaceable></td>
<td>(StrOpt) Inspector to use for inspecting the hypervisor layer.</td>
<td>(StrOpt) Inspector to use for inspecting the hypervisor layer. Known inspectors are libvirt, hyperv, vmware, xenapi and powervm.</td>
</tr>
<tr>
<td><option>libvirt_type</option> = <replaceable>kvm</replaceable></td>

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

@ -19,10 +19,10 @@
</tr>
<tr>
<td><option>debug</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
<td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default INFO level).</td>
</tr>
<tr>
<td><option>default_log_levels</option> = <replaceable>amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN</replaceable></td>
<td><option>default_log_levels</option> = <replaceable>amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, requests.packages.urllib3.util.retry=WARN, urllib3.util.retry=WARN, keystonemiddleware=WARN, routes.middleware=WARN, stevedore=WARN, taskflow=WARN</replaceable></td>
<td>(ListOpt) List of logger=LEVEL pairs.</td>
</tr>
<tr>
@ -91,11 +91,11 @@
</tr>
<tr>
<td><option>use_syslog_rfc_format</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in K, and will be removed in M, along with this option.</td>
<td>(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in Kilo, and will be removed in Mitaka, along with this option.</td>
</tr>
<tr>
<td><option>verbose</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
<td><option>verbose</option> = <replaceable>True</replaceable></td>
<td>(BoolOpt) If set to false, will disable INFO logging level, making WARNING the default.</td>
</tr>
</tbody>
</table>

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

@ -71,7 +71,7 @@
</tr>
<tr>
<td><option>send_single_reply</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in M release.</td>
<td>(BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release.</td>
</tr>
</tbody>
</table>

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

@ -111,7 +111,7 @@
</tr>
<tr>
<td><option>send_single_reply</option> = <replaceable>False</replaceable></td>
<td>(BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in M release.</td>
<td>(BoolOpt) Send a single AMQP reply to call message. The current behaviour since oslo-incubator is to send two AMQP replies - first one with the payload, a second one to ensure the other have finish to send the payload. We are going to remove it in the N release, but we must keep backward compatible at the same time. This option provides such compatibility - it defaults to False in Liberty and can be turned on for early adopters with a new installations or for testing. Please note, that this option will be removed in the Mitaka release.</td>
</tr>
</tbody>
</table>

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

@ -45,10 +45,6 @@
<td><option>rpc_response_timeout</option> = <replaceable>60</replaceable></td>
<td>(IntOpt) Seconds to wait for a response from a call.</td>
</tr>
<tr>
<td><option>rpc_thread_pool_size</option> = <replaceable>64</replaceable></td>
<td>(IntOpt) Size of RPC thread pool.</td>
</tr>
<tr>
<th colspan="2">[notification]</th>
</tr>

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

@ -1,14 +1,15 @@
api_paste_config api
api_workers api
batch_polled_samples common
ceilometer_control_exchange exchange
cinder_control_exchange exchange
collector_workers collector
control_exchange amqp
database_connection database
debug logging
default_log_levels logging
dispatcher rpc
dns_control_exchange exchange
event_pipeline_cfg_file api
executor_thread_pool_size common
fatal_deprecations logging
glance_control_exchange exchange
glance_page_size glance
@ -33,13 +34,13 @@ logging_debug_format_suffix logging
logging_default_format_string logging
logging_exception_prefix logging
magnetodb_control_exchange magnetodb
magnum_control_exchange exchange
matchmaker_heartbeat_freq rpc
matchmaker_heartbeat_ttl rpc
memcached_servers common
neutron_control_exchange exchange
notification_driver amqp
notification_topics amqp
notification_workers common
nova_control_exchange exchange
nova_http_log_debug debug
pipeline_cfg_file api
@ -57,7 +58,6 @@ 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
rpc_zmq_contexts zeromq
rpc_zmq_host zeromq
@ -89,14 +89,20 @@ alarm/rest_notifier_max_retries alarm
alarm/rest_notifier_ssl_verify alarm
alarm/user_alarm_quota alarm
alarms/gnocchi_url alarms
api/aodh_is_enabled api
api/aodh_url api
api/default_api_return_limit api
api/gnocchi_is_enabled api
api/host api
api/pecan_debug api
api/port api
api/workers api
collector/enable_rpc collector
collector/requeue_event_on_dispatcher_error collector
collector/requeue_sample_on_dispatcher_error collector
collector/udp_address collector
collector/udp_port collector
collector/workers collector
compute/workload_partitioning common
coordination/backend_url common
coordination/check_watchers common
@ -148,6 +154,7 @@ dispatcher_gnocchi/archive_policy dispatcher_gnocchi
dispatcher_gnocchi/archive_policy_file dispatcher_gnocchi
dispatcher_gnocchi/filter_project dispatcher_gnocchi
dispatcher_gnocchi/filter_service_activity dispatcher_gnocchi
dispatcher_gnocchi/resources_definition_file dispatcher_gnocchi
dispatcher_gnocchi/url dispatcher_gnocchi
dispatcher_http/cadf_only dispatcher_http
dispatcher_http/event_target dispatcher_http
@ -207,6 +214,7 @@ notification/ack_on_event_error events
notification/disable_non_metric_meters notification
notification/messaging_urls rpc
notification/store_events events
notification/workers events
notification/workload_partitioning events
oslo_concurrency/disable_process_locking rpc
oslo_concurrency/lock_path rpc