Search

7.2. Telemetry Alarming Configuration Options

download PDF
The Telemetry Alarming services trigger alarms when the collected metering or event data break the defined rules. Their options are configured in the /etc/aodh/aodh.conf file.

7.2.1. Description of Configuration Options

The following tables provide a comprehensive list of the Telemetry Alarming configuration options.
Table 7.25. Description of API configuration options
Configuration option = Default value
Description
[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.
Table 7.26. Description of common configuration options
Configuration option = Default value
Description
[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.
Table 7.27. Description of coordination configuration options
Configuration option = Default value
Description
[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
Table 7.28. Description of Redis configuration options
Configuration option = Default value
Description
[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.

7.2.2. New, Updated, and Deprecated Options in Ocata for Telemetry Alarming

Table 7.29. New options
Option = default value
(Type) Help string
[api] auth_mode = keystone
(StrOpt) Authentication mode to use. Unset to disable authentication
Table 7.30. New default values
Option
Previous default value
New default value
[api] paste_config
api_paste.ini
/usr/lib/python/site-packages/aodh/aodh/api/api-paste.ini
Table 7.31. Deprecated options
Deprecated option
New Option
[DEFAULT] rpc_thread_pool_size
[DEFAULT] executor_thread_pool_size
[DEFAULT] use_syslog
None
Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.