Chapter 11. Telemetry

[oslo_middleware]

enable_proxy_headers_parsing = False

(Boolean) Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not.

max_request_body_size = 114688

(Integer) The maximum body size for each request, in bytes.

secure_proxy_ssl_header = X-Forwarded-Proto

(String) DEPRECATED: The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by a SSL termination proxy.

[service_credentials]

auth_section = None

(Unknown) Config Section from which to load plugin specific options

auth_type = None

(Unknown) Authentication type to load

cafile = None

(String) PEM encoded Certificate Authority to use when verifying HTTPs connections.

certfile = None

(String) PEM encoded client certificate cert file

insecure = False

(Boolean) Verify HTTPS connections.

interface = public

(String) Type of endpoint in Identity service catalog to use for communication with OpenStack services.

keyfile = None

(String) PEM encoded client certificate key file

region_name = None

(String) Region name to use for OpenStack service endpoints.

timeout = None

(Integer) Timeout value for http requests

[collector]

batch_size = 1

(Integer) Number of notification messages to wait before dispatching them

batch_timeout = None

(Integer) Number of seconds to wait before dispatching sampleswhen batch_size is not reached (None means indefinitely)

udp_address = 0.0.0.0

(String) Address to which the UDP socket is bound. Set to an empty string to disable.

udp_port = 4952

(Port number) Port to which the UDP socket is bound.

workers = 1

(Integer) Number of workers for collector service. default value is 1.

[dispatcher_file]

backup_count = 0

(Integer) The max number of the files to keep.

file_path = None

(String) Name and the location of the file to record meters.

max_bytes = 0

(Integer) The max size of the file.

[DEFAULT]

executor_thread_pool_size = 64

(Integer) Size of executor thread pool.

graceful_shutdown_timeout = 60

(Integer) Specify a timeout after which a gracefully shutdown server will exit. Zero value means endless wait. Mutable This option can be changed without restarting.

log_options = True

(Boolean) Enables or disables logging values of all registered options when starting a service (at DEBUG level). Mutable This option can be changed without restarting.

[healthcheck]

backends =

(List) Additional backends that can perform health checks and report that information back as part of a request.

detailed = False

(Boolean) Show more detailed information as part of the response

disable_by_file_path = None

(String) Check the presence of a file to determine if an application is running on a port. Used by DisableByFileHealthcheck plugin.

disable_by_file_paths =

(List) Check the presence of a file based on a port to determine if an application is running on a port. Expects a "port:path" list of strings. Used by DisableByFilesPortsHealthcheck plugin.

path = /healthcheck

(String) DEPRECATED: The path to respond to healtcheck requests on.

[DEFAULT]

nova_http_log_debug = False

(Boolean) DEPRECATED: Allow novaclient’s debug log output. (Use default_log_levels instead)

[dispatcher_http]

event_target = None

(String) 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.

target =

(String) 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

timeout = 5

(Integer) The max time in seconds to wait for a request to timeout.

verify_ssl = None

(String) The path to a server certificate or directory if the system CAs are not used or if a self-signed certificate is used. Set to False to ignore SSL cert verification.

[DEFAULT]

event_dispatchers = []

(Multi-valued) Dispatchers to process event data.

meter_dispatchers = ['database']

(Multi-valued) Dispatchers to process metering data.

[event]

definitions_cfg_file = event_definitions.yaml

(String) Configuration file for event definitions.

drop_unmatched_notifications = False

(Boolean) Drop notifications if no event definition matches. (Otherwise, we convert them with just the default traits)

store_raw = []

(Multi-valued) Store the raw notification for select priority levels (info and/or error). By default, raw details are not captured.

[notification]

ack_on_event_error = True

(Boolean) Acknowledge message when event persistence fails.

workers = 1

(Integer) Number of workers for notification service, default value is 1.

workload_partitioning = False

(Boolean) Enable workload partitioning, allowing multiple notification agents to be run simultaneously.

[DEFAULT]

ceilometer_control_exchange = ceilometer

(String) Exchange name for ceilometer notifications.

cinder_control_exchange = cinder

(String) Exchange name for Cinder notifications.

dns_control_exchange = central

(String) Exchange name for DNS service notifications.

glance_control_exchange = glance

(String) Exchange name for Glance notifications.

heat_control_exchange = heat

(String) Exchange name for Heat notifications

http_control_exchanges = ['nova', 'glance', 'neutron', 'cinder']

(Multi-valued) Exchanges name to listen for notifications.

ironic_exchange = ironic

(String) Exchange name for Ironic notifications.

keystone_control_exchange = keystone

(String) Exchange name for Keystone notifications.

magnum_control_exchange = magnum

(String) Exchange name for Magnum notifications.

neutron_control_exchange = neutron

(String) Exchange name for Neutron notifications.

nova_control_exchange = nova

(String) Exchange name for Nova notifications.

sahara_control_exchange = sahara

(String) Exchange name for Data Processing notifications.

sample_source = openstack

(String) Source for samples emitted on this instance.

swift_control_exchange = swift

(String) Exchange name for Swift notifications.

trove_control_exchange = trove

(String) Exchange name for DBaaS notifications.

[DEFAULT]

hypervisor_inspector = libvirt

(String) Inspector to use for inspecting the hypervisor layer. Known inspectors are libvirt, xenapi and powervm.

libvirt_type = kvm

(String) Libvirt domain type.

libvirt_uri =

(String) Override the default libvirt URI (which is dependent on libvirt_type).

[ipmi]

node_manager_init_retry = 3

(Integer) Number of retries upon Intel Node Manager initialization failure

polling_retry = 3

(Integer) Tolerance of IPMI/NM polling failures before disable this pollster. Negative indicates retrying forever.

[notification]

batch_size = 100

(Integer) Number of notification messages to wait before publishing them. Batching is advised when transformations areapplied in pipeline.

batch_timeout = 5

(Integer) Number of seconds to wait before publishing sampleswhen batch_size is not reached (None means indefinitely)

disable_non_metric_meters = True

(Boolean) 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.

messaging_urls = []

(Multi-valued) Messaging URLs to listen for notifications. Example: rabbit://user:pass@host1:port1[,user:pass@hostN:portN]/virtual_host (DEFAULT/transport_url is used if empty). This is useful when you have dedicate messaging nodes for each service, for example, all nova notifications go to rabbit-nova:5672, while all cinder notifications go to rabbit-cinder:5672.

pipeline_processing_queues = 10

(Integer) Number of queues to parallelize workload across. This value should be larger than the number of active notification agents for optimal results. WARNING: Once set, lowering this value may result in lost data.

[matchmaker_redis]

check_timeout = 20000

(Integer) Time in ms to wait before the transaction is killed.

host = 127.0.0.1

(String) DEPRECATED: Host to locate redis. Replaced by [DEFAULT]/transport_url

password =

(String) DEPRECATED: Password for Redis server (optional). Replaced by [DEFAULT]/transport_url

port = 6379

(Port number) DEPRECATED: Use this port to connect to redis host. Replaced by [DEFAULT]/transport_url

sentinel_group_name = oslo-messaging-zeromq

(String) Redis replica set name.

sentinel_hosts =

(List) DEPRECATED: List of Redis Sentinel hosts (fault tolerance mode), e.g., [host:port, host1:port …​ ] Replaced by [DEFAULT]/transport_url

socket_timeout = 10000

(Integer) Timeout in ms on blocking socket operations.

wait_timeout = 2000

(Integer) Time in ms to wait between connection attempts.

[rgw_admin_credentials]

access_key = None

(String) Access key for Radosgw Admin.

secret_key = None

(String) Secret key for Radosgw Admin.

[service_types]

glance = image

(String) Glance service type.

kwapi = energy

(String) Kwapi service type.

neutron = network

(String) Neutron service type.

neutron_lbaas_version = v2

(String) Neutron load balancer version.

nova = compute

(String) Nova service type.

radosgw = object-store

(String) Radosgw service type.

swift = object-store

(String) Swift service type.

[storage]

max_retries = 10

(Integer) Maximum number of connection retries during startup. Set to -1 to specify an infinite retry count.

retry_interval = 10

(Integer) Interval (in seconds) between retries of connection.

[DEFAULT]

reseller_prefix = AUTH_

(String) Swift reseller prefix. Must be on par with reseller_prefix in proxy-server.conf.

[hardware]

meter_definitions_file = snmp.yaml

(String) Configuration file for defining hardware snmp meters.

readonly_user_auth_proto = None

(String) SNMPd v3 authentication algorithm of all the nodes running in the cloud

readonly_user_name = ro_snmp_user

(String) SNMPd user name of all nodes running in the cloud.

readonly_user_password = password

(String) SNMPd v3 authentication password of all the nodes running in the cloud.

readonly_user_priv_password = None

(String) SNMPd v3 encryption password of all the nodes running in the cloud.

readonly_user_priv_proto = None

(String) SNMPd v3 encryption algorithm of all the nodes running in the cloud

url_scheme = snmp://

(String) URL scheme to use for hardware nodes.

[DEFAULT]

zaqar_control_exchange = zaqar

(String) Exchange name for Messaging service notifications.

[DEFAULT] graceful_shutdown_timeout = 60

(IntOpt) Specify a timeout after which a gracefully shutdown server will exit. Zero value means endless wait.

[DEFAULT] log_options = True

(BoolOpt) Enables or disables logging values of all registered options when starting a service (at DEBUG level).

[DEFAULT] rpc_thread_pool_size

[DEFAULT] executor_thread_pool_size

[DEFAULT] use_syslog

None

[hyperv] force_volumeutils_v1

None

[api]

alarm_max_actions = -1

(Integer) Maximum count of actions for each state of an alarm, non-positive number means no limit.

enable_combination_alarms = False

(Boolean) DEPRECATED: Enable deprecated combination alarms. Combination alarms are deprecated. This option and combination alarms will be removed in Aodh 5.0.

paste_config = /usr/lib/python/site-packages/aodh/aodh/api/api-paste.ini

(String) Configuration file for WSGI definition of API.

project_alarm_quota = None

(Integer) Maximum number of alarms defined for a project.

user_alarm_quota = None

(Integer) Maximum number of alarms defined for a user.

[oslo_middleware]

enable_proxy_headers_parsing = False

(Boolean) Whether the application is behind a proxy or not. This determines if the middleware should parse the headers or not.

max_request_body_size = 114688

(Integer) The maximum body size for each request, in bytes.

secure_proxy_ssl_header = X-Forwarded-Proto

(String) DEPRECATED: The HTTP Header that will be used to determine what the original request protocol scheme was, even if it was hidden by a SSL termination proxy.

[DEFAULT]

additional_ingestion_lag = 0

(Integer) The number of seconds to extend the evaluation windows to compensate the reporting/ingestion lag.

evaluation_interval = 60

(Integer) Period of evaluation cycle, should be >= than configured pipeline interval for collection of underlying meters.

event_alarm_cache_ttl = 60

(Integer) TTL of event alarm caches, in seconds. Set to 0 to disable caching.

executor_thread_pool_size = 64

(Integer) Size of executor thread pool.

http_timeout = 600

(Integer) Timeout seconds for HTTP requests. Set it to None to disable timeout.

notifier_topic = alarming

(String) The topic that aodh uses for alarm notifier messages.

record_history = True

(Boolean) Record alarm change events.

rest_notifier_ca_bundle_certificate_path = None

(String) SSL CA_BUNDLE certificate for REST notifier

rest_notifier_certificate_file =

(String) SSL Client certificate file for REST notifier.

rest_notifier_certificate_key =

(String) SSL Client private key file for REST notifier.

rest_notifier_max_retries = 0

(Integer) Number of retries for REST notifier

rest_notifier_ssl_verify = True

(Boolean) Whether to verify the SSL Server certificate when calling alarm action.

[database]

alarm_history_time_to_live = -1

(Integer) Number of seconds that alarm histories are kept in the database for (⇐ 0 means forever).

[evaluator]

workers = 1

(Integer) Number of workers for evaluator service. default value is 1.

[healthcheck]

backends =

(List) Additional backends that can perform health checks and report that information back as part of a request.

detailed = False

(Boolean) Show more detailed information as part of the response

disable_by_file_path = None

(String) Check the presence of a file to determine if an application is running on a port. Used by DisableByFileHealthcheck plugin.

disable_by_file_paths =

(List) Check the presence of a file based on a port to determine if an application is running on a port. Expects a "port:path" list of strings. Used by DisableByFilesPortsHealthcheck plugin.

path = /healthcheck

(String) DEPRECATED: The path to respond to healtcheck requests on.

[listener]

batch_size = 1

(Integer) Number of notification messages to wait before dispatching them.

batch_timeout = None

(Integer) Number of seconds to wait before dispatching samples when batch_size is not reached (None means indefinitely).

event_alarm_topic = alarm.all

(String) The topic that aodh uses for event alarm evaluation.

workers = 1

(Integer) Number of workers for listener service. default value is 1.

[notifier]

batch_size = 1

(Integer) Number of notification messages to wait before dispatching them.

batch_timeout = None

(Integer) Number of seconds to wait before dispatching samples when batch_size is not reached (None means indefinitely).

workers = 1

(Integer) Number of workers for notifier service. default value is 1.

[service_credentials]

interface = public

(String) Type of endpoint in Identity service catalog to use for communication with OpenStack services.

region_name = None

(String) Region name to use for OpenStack service endpoints.

[service_types]

zaqar = messaging

(String) Message queue service type.

[coordination]

backend_url = None

(String) The backend URL to use for distributed coordination. If left empty, per-deployment central agent and per-host compute agent won’t do workload partitioning and will only function correctly if a single instance of that service is running.

check_watchers = 10.0

(Floating point) Number of seconds between checks to see if group membership has changed

heartbeat = 1.0

(Floating point) Number of seconds between heartbeats for distributed coordination.

max_retry_interval = 30

(Integer) Maximum number of seconds between retry to join partitioning group

retry_backoff = 1

(Integer) Retry backoff factor when retrying to connect with coordination backend

[matchmaker_redis]

check_timeout = 20000

(Integer) Time in ms to wait before the transaction is killed.

host = 127.0.0.1

(String) DEPRECATED: Host to locate redis. Replaced by [DEFAULT]/transport_url

password =

(String) DEPRECATED: Password for Redis server (optional). Replaced by [DEFAULT]/transport_url

port = 6379

(Port number) DEPRECATED: Use this port to connect to redis host. Replaced by [DEFAULT]/transport_url

sentinel_group_name = oslo-messaging-zeromq

(String) Redis replica set name.

sentinel_hosts =

(List) DEPRECATED: List of Redis Sentinel hosts (fault tolerance mode), e.g., [host:port, host1:port …​ ] Replaced by [DEFAULT]/transport_url

socket_timeout = 10000

(Integer) Timeout in ms on blocking socket operations.

wait_timeout = 2000

(Integer) Time in ms to wait between connection attempts.

[api] auth_mode = keystone

(StrOpt) Authentication mode to use. Unset to disable authentication

[api] paste_config

api_paste.ini

/usr/lib/python/site-packages/aodh/aodh/api/api-paste.ini

[DEFAULT] rpc_thread_pool_size

[DEFAULT] executor_thread_pool_size

[DEFAULT] use_syslog

None