Update Telemetry config reference
The Telemetry config reference is updated by using the doc tools script. New config options are added to the existing tables following the current grouping of options. Flagmappings are also updated with the new options. Change-Id: Ia1172727879dd8dc71b0492a54a865fcc87b4064
This commit is contained in:
Ildiko Vancsa
parent
f6da847844
commit
a8c869e50c
@ -21,6 +21,10 @@
|
||||
<td>evaluation_interval = 60</td>
|
||||
<td>(IntOpt) Period of evaluation cycle, should be >= than configured pipeline interval for collection of underlying metrics.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>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>notifier_rpc_topic = alarm_notifier</td>
|
||||
<td>(StrOpt) The topic that ceilometer uses for alarm notifier messages.</td>
|
||||
|
||||
@ -29,6 +29,10 @@
|
||||
<td>policy_default_rule = default</td>
|
||||
<td>(StrOpt) Default rule. Enforced when a requested rule is not found.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>policy_dirs = ['policy.d']</td>
|
||||
<td>(MultiStrOpt) The directories of policy configuration files is stored</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>policy_file = policy.json</td>
|
||||
<td>(StrOpt) The JSON file that defines policies.</td>
|
||||
@ -46,7 +50,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td>enable_reverse_dns_lookup = False</td>
|
||||
<td>(BoolOpt) Set it to False if your environment does not need or have dns server, otherwise it will delay the response from api.</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>host = 0.0.0.0</td>
|
||||
|
||||
@ -26,7 +26,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td>requeue_sample_on_dispatcher_error = False</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>
|
||||
<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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>udp_address = 0.0.0.0</td>
|
||||
|
||||
@ -21,10 +21,6 @@
|
||||
<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>lock_path = None</td>
|
||||
<td>(StrOpt) Directory to use for lock files.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>memcached_servers = None</td>
|
||||
<td>(ListOpt) Memcached servers or None for in process cache.</td>
|
||||
@ -60,7 +56,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td>heartbeat = 1.0</td>
|
||||
<td>(FloatOpt) Number of seconds between heartbeats for distributed coordination (float)</td>
|
||||
<td>(FloatOpt) Number of seconds between heartbeats for distributed coordination.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th colspan="2">[keystone_authtoken]</th>
|
||||
|
||||
@ -60,6 +60,10 @@
|
||||
<td>db_retry_interval = 1</td>
|
||||
<td>(IntOpt) Seconds between database connection retries.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>event_connection = None</td>
|
||||
<td>(StrOpt) The connection string used to connect to the event database. (if unset, connection is used)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>idle_timeout = 3600</td>
|
||||
<td>(IntOpt) Timeout before idle SQL connections are reaped.</td>
|
||||
@ -84,6 +88,10 @@
|
||||
<td>min_pool_size = 1</td>
|
||||
<td>(IntOpt) Minimum number of SQL connections to keep open in a pool.</td>
|
||||
</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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>mysql_sql_mode = TRADITIONAL</td>
|
||||
<td>(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=</td>
|
||||
@ -116,10 +124,6 @@
|
||||
<td>use_db_reconnect = False</td>
|
||||
<td>(BoolOpt) Enable the experimental use of database reconnect on connection lost.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>use_tpool = False</td>
|
||||
<td>(BoolOpt) Enable the experimental use of thread pooling for all DB API calls</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</para>
|
||||
|
||||
@ -21,10 +21,6 @@
|
||||
<td>backdoor_port = None</td>
|
||||
<td>(StrOpt) Enable eventlet backdoor. Acceptable values are 0, <port>, and <start>:<end>, where 0 results in listening on a random tcp port number; <port> results in listening on the specified port number (and not enabling backdoor if that port is in use); and <start>:<end> results in listening on the smallest unused port number within the specified range of port numbers. The chosen port is displayed in the service's log file.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>disable_process_locking = False</td>
|
||||
<td>(BoolOpt) Enables or disables inter-process locks.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>nova_http_log_debug = False</td>
|
||||
<td>(BoolOpt) Allow novaclient's debug log output.</td>
|
||||
|
||||
@ -51,7 +51,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td>sahara_control_exchange = sahara</td>
|
||||
<td>(StrOpt) Exchange name for Data Processing notifications</td>
|
||||
<td>(StrOpt) Exchange name for Data Processing notifications.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>sample_source = openstack</td>
|
||||
@ -59,7 +59,7 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td>trove_control_exchange = trove</td>
|
||||
<td>(StrOpt) Exchange name for DBaaS notifications</td>
|
||||
<td>(StrOpt) Exchange name for DBaaS notifications.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
@ -29,22 +29,10 @@
|
||||
<td>fatal_deprecations = False</td>
|
||||
<td>(BoolOpt) Enables or disables fatal status of deprecations.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>fatal_exception_format_errors = False</td>
|
||||
<td>(BoolOpt) Make exception message format errors fatal</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>instance_format = "[instance: %(uuid)s] "</td>
|
||||
<td>(StrOpt) The format for an instance that is passed with the log message.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>instance_name_template = instance-%08x</td>
|
||||
<td>(StrOpt) Template string to be used to generate instance names</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>instance_usage_audit_period = month</td>
|
||||
<td>(StrOpt) Time period to generate instance usages for. Time period must be hour, day, month or year</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>instance_uuid_format = "[instance: %(uuid)s] "</td>
|
||||
<td>(StrOpt) The format for an instance UUID that is passed with the log message.</td>
|
||||
|
||||
@ -1,46 +0,0 @@
|
||||
<?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_nova">
|
||||
<caption>Description of nova 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">[DEFAULT]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>enable_new_services = True</td>
|
||||
<td>(BoolOpt) Services to be added to the available pool on create</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>monkey_patch = False</td>
|
||||
<td>(BoolOpt) Whether to log monkey patching</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>monkey_patch_modules = nova.api.ec2.cloud:nova.notifications.notify_decorator, nova.compute.api:nova.notifications.notify_decorator</td>
|
||||
<td>(ListOpt) List of modules/decorators to monkey patch</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>network_api_class = nova.network.api.API</td>
|
||||
<td>(StrOpt) The full class name of the network API class to use</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>password_length = 12</td>
|
||||
<td>(IntOpt) Length of generated instance admin passwords</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>snapshot_name_template = snapshot-%s</td>
|
||||
<td>(StrOpt) Template string to be used to generate snapshot names</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</para>
|
||||
@ -1,69 +0,0 @@
|
||||
<?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_nova_cells">
|
||||
<caption>Description of nova cells 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">[cells]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>bandwidth_update_interval = 600</td>
|
||||
<td>(IntOpt) Seconds between bandwidth updates for cells.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>call_timeout = 60</td>
|
||||
<td>(IntOpt) Seconds to wait for response from a call to a cell.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>capabilities = hypervisor=xenserver;kvm, os=linux;windows</td>
|
||||
<td>(ListOpt) Key/Multi-value list with the capabilities of the cell</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>cell_type = compute</td>
|
||||
<td>(StrOpt) Type of cell: api or compute</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>enable = False</td>
|
||||
<td>(BoolOpt) Enable cell functionality</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>manager = nova.cells.manager.CellsManager</td>
|
||||
<td>(StrOpt) Manager for cells</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>mute_child_interval = 300</td>
|
||||
<td>(IntOpt) Number of seconds after which a lack of capability and capacity updates signals the child cell is to be treated as a mute.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>name = nova</td>
|
||||
<td>(StrOpt) Name of this cell</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>reserve_percent = 10.0</td>
|
||||
<td>(FloatOpt) Percentage of cell capacity to hold in reserve. Affects both memory and disk utilization</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>topic = cells</td>
|
||||
<td>(StrOpt) The topic cells nodes listen on</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th colspan="2">[upgrade_levels]</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>cells = None</td>
|
||||
<td>(StrOpt) Set a version cap for messages sent to local cells services</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</para>
|
||||
@ -23,11 +23,11 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td>readonly_user_password = password</td>
|
||||
<td>(StrOpt) SNMPd password of all the nodes running in the cloud</td>
|
||||
<td>(StrOpt) SNMPd password of all the nodes running in the cloud.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>url_scheme = snmp://</td>
|
||||
<td>(StrOpt) URL scheme to use for hardware nodes</td>
|
||||
<td>(StrOpt) URL scheme to use for hardware nodes.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
@ -19,27 +19,31 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td>api_retry_count = 10</td>
|
||||
<td>(IntOpt) Number of times a VMware Vsphere API must be retried</td>
|
||||
<td>(IntOpt) Number of times a VMware Vsphere API may be retried.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>host_ip = </td>
|
||||
<td>(StrOpt) IP address of the VMware Vsphere host</td>
|
||||
<td>(StrOpt) IP address of the VMware Vsphere host.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>host_password = </td>
|
||||
<td>(StrOpt) Password of VMware Vsphere</td>
|
||||
<td>(StrOpt) Password of VMware Vsphere.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>host_port = 443</td>
|
||||
<td>(IntOpt) Port of the VMware Vsphere host.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>host_username = </td>
|
||||
<td>(StrOpt) Username of VMware Vsphere</td>
|
||||
<td>(StrOpt) Username of VMware Vsphere.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>task_poll_interval = 0.5</td>
|
||||
<td>(FloatOpt) Sleep time in seconds for polling an ongoing async task</td>
|
||||
<td>(FloatOpt) Sleep time in seconds for polling an ongoing async task.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>wsdl_location = None</td>
|
||||
<td>(StrOpt) Optional vim service WSDL location e.g http://<server>/vimService.wsdl. Optional over-ride to default location for bug work-arounds</td>
|
||||
<td>(StrOpt) Optional vim service WSDL location e.g http://<server>/vimService.wsdl. Optional over-ride to default location for bug work-arounds.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
@ -19,15 +19,15 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td>connection_password = None</td>
|
||||
<td>(StrOpt) Password for connection to XenServer/Xen Cloud Platform</td>
|
||||
<td>(StrOpt) Password for connection to XenServer/Xen Cloud Platform.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>connection_url = None</td>
|
||||
<td>(StrOpt) URL for connection to XenServer/Xen Cloud Platform</td>
|
||||
<td>(StrOpt) URL for connection to XenServer/Xen Cloud Platform.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>connection_username = root</td>
|
||||
<td>(StrOpt) Username for connection to XenServer/Xen Cloud Platform</td>
|
||||
<td>(StrOpt) Username for connection to XenServer/Xen Cloud Platform.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>login_timeout = 10</td>
|
||||
|
||||
@ -30,8 +30,6 @@
|
||||
<xi:include href="../common/tables/ceilometer-inspector.xml"/>
|
||||
<xi:include href="../common/tables/ceilometer-ipmi.xml"/>
|
||||
<xi:include href="../common/tables/ceilometer-logging.xml"/>
|
||||
<xi:include href="../common/tables/ceilometer-nova.xml"/>
|
||||
<xi:include href="../common/tables/ceilometer-nova_cells.xml"/>
|
||||
<xi:include href="../common/tables/ceilometer-qpid.xml"/>
|
||||
<xi:include href="../common/tables/ceilometer-rabbitmq.xml"/>
|
||||
<xi:include href="../common/tables/ceilometer-redis.xml"/>
|
||||
|
||||
@ -8,12 +8,9 @@ control_exchange amqp
|
||||
database_connection database
|
||||
debug logging
|
||||
default_log_levels logging
|
||||
disable_process_locking debug
|
||||
dispatcher rpc
|
||||
enable_new_services nova
|
||||
fake_rabbit testing
|
||||
fatal_deprecations logging
|
||||
fatal_exception_format_errors logging
|
||||
glance_control_exchange exchange
|
||||
glance_page_size glance
|
||||
heat_control_exchange exchange
|
||||
@ -21,8 +18,6 @@ host common
|
||||
http_control_exchanges exchange
|
||||
hypervisor_inspector inspector
|
||||
instance_format logging
|
||||
instance_name_template logging
|
||||
instance_usage_audit_period logging
|
||||
instance_uuid_format logging
|
||||
ironic_exchange exchange
|
||||
keystone_control_exchange exchange
|
||||
@ -33,7 +28,6 @@ kombu_ssl_keyfile rabbitmq
|
||||
kombu_ssl_version rabbitmq
|
||||
libvirt_type inspector
|
||||
libvirt_uri inspector
|
||||
lock_path common
|
||||
log_config_append logging
|
||||
log_date_format logging
|
||||
log_dir logging
|
||||
@ -46,18 +40,15 @@ logging_exception_prefix logging
|
||||
matchmaker_heartbeat_freq rpc
|
||||
matchmaker_heartbeat_ttl rpc
|
||||
memcached_servers common
|
||||
monkey_patch nova
|
||||
monkey_patch_modules nova
|
||||
network_api_class nova
|
||||
neutron_control_exchange exchange
|
||||
notification_driver amqp
|
||||
notification_topics amqp
|
||||
notification_workers common
|
||||
nova_control_exchange exchange
|
||||
nova_http_log_debug debug
|
||||
password_length nova
|
||||
pipeline_cfg_file api
|
||||
policy_default_rule api
|
||||
policy_dirs api
|
||||
policy_file api
|
||||
publish_errors logging
|
||||
qpid_heartbeat qpid
|
||||
@ -101,7 +92,6 @@ rpc_zmq_port zeromq
|
||||
rpc_zmq_topic_backlog zeromq
|
||||
sahara_control_exchange exchange
|
||||
sample_source exchange
|
||||
snapshot_name_template nova
|
||||
syslog_log_facility logging
|
||||
transport_url amqp
|
||||
trove_control_exchange exchange
|
||||
@ -110,6 +100,7 @@ use_syslog logging
|
||||
use_syslog_rfc_format logging
|
||||
verbose logging
|
||||
alarm/evaluation_interval alarm
|
||||
alarm/evaluation_service alarm
|
||||
alarm/notifier_rpc_topic alarm
|
||||
alarm/partition_rpc_topic alarm
|
||||
alarm/project_alarm_quota alarm
|
||||
@ -123,16 +114,6 @@ api/enable_reverse_dns_lookup api
|
||||
api/host api
|
||||
api/pecan_debug api
|
||||
api/port api
|
||||
cells/bandwidth_update_interval nova_cells
|
||||
cells/call_timeout nova_cells
|
||||
cells/capabilities nova_cells
|
||||
cells/cell_type nova_cells
|
||||
cells/enable nova_cells
|
||||
cells/manager nova_cells
|
||||
cells/mute_child_interval nova_cells
|
||||
cells/name nova_cells
|
||||
cells/reserve_percent nova_cells
|
||||
cells/topic nova_cells
|
||||
central/partitioning_group_prefix common
|
||||
collector/requeue_sample_on_dispatcher_error collector
|
||||
collector/udp_address collector
|
||||
@ -149,12 +130,14 @@ database/db_inc_retry_interval database
|
||||
database/db_max_retries database
|
||||
database/db_max_retry_interval database
|
||||
database/db_retry_interval database
|
||||
database/event_connection database
|
||||
database/idle_timeout database
|
||||
database/max_overflow database
|
||||
database/max_pool_size database
|
||||
database/max_retries database
|
||||
database/metering_connection database
|
||||
database/min_pool_size database
|
||||
database/mongodb_replica_set database
|
||||
database/mysql_sql_mode database
|
||||
database/pool_timeout database
|
||||
database/retry_interval database
|
||||
@ -163,7 +146,6 @@ database/sqlite_db database
|
||||
database/sqlite_synchronous database
|
||||
database/time_to_live database
|
||||
database/use_db_reconnect database
|
||||
database/use_tpool database
|
||||
dispatcher_file/backup_count collector
|
||||
dispatcher_file/file_path collector
|
||||
dispatcher_file/max_bytes collector
|
||||
@ -227,10 +209,10 @@ service_types/kwapi service_types
|
||||
service_types/neutron service_types
|
||||
service_types/nova service_types
|
||||
service_types/swift service_types
|
||||
upgrade_levels/cells nova_cells
|
||||
vmware/api_retry_count vmware
|
||||
vmware/host_ip vmware
|
||||
vmware/host_password vmware
|
||||
vmware/host_port vmware
|
||||
vmware/host_username vmware
|
||||
vmware/task_poll_interval vmware
|
||||
vmware/wsdl_location vmware
|
||||
|
||||
@ -4,6 +4,4 @@ events events
|
||||
exchange exchange
|
||||
inspector inspector
|
||||
ipmi IPMI
|
||||
nova nova
|
||||
nova_cells nova cells
|
||||
service_types service types
|
||||
|
||||
Loading…
Reference in New Issue
Block a user