Masakari Monitors Configuration Options

The following is an overview of all available configuration options in masakari-monitors. To see sample configuration file, see Masakari Monitors Sample Configuration File.

DEFAULT

tempdir
Type

string

Default

<None>

Explicitly specify the temporary working directory.

monkey_patch
Type

boolean

Default

False

Determine if monkey patching should be applied.

Related options:

  • monkey_patch_modules: This must have values set for this option to have

any effect

monkey_patch_modules
Type

list

Default

[]

List of modules/decorators to monkey patch.

This option allows you to patch a decorator for all functions in specified modules.

Related options:

  • monkey_patch: This must be set to True for this option to have any effect

hostname
Type

string

Default

ubuntu-focal-inmotion-iad3-0032581511

Hostname, FQDN or IP address of this host. Must be valid within AMQP key.

Possible values:

  • String with hostname, FQDN or IP address. Default is hostname of this host.

Deprecated Variations

Group

Name

DEFAULT

host
instancemonitor_manager
Type

string

Default

masakarimonitors.instancemonitor.instance.InstancemonitorManager

Full class name for the Manager for instancemonitor.

introspectiveinstancemonitor_manager
Type

string

Default

masakarimonitors.introspectiveinstancemonitor.instance.IntrospectiveInstanceMonitorManager

Full class name for introspectiveinstancemonitor.

processmonitor_manager
Type

string

Default

masakarimonitors.processmonitor.process.ProcessmonitorManager

Full class name for the Manager for processmonitor.

hostmonitor_manager
Type

string

Default

masakarimonitors.hostmonitor.host.HostmonitorManager

Full class name for the Manager for hostmonitor.

debug
Type

boolean

Default

False

Mutable

This option can be changed without restarting.

If set to true, the logging level will be set to DEBUG instead of the default INFO level.

log_config_append
Type

string

Default

<None>

Mutable

This option can be changed without restarting.

The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation. Note that when logging configuration files are used then all logging configuration is set in the configuration file and other logging configuration options are ignored (for example, log-date-format).

Deprecated Variations

Group

Name

DEFAULT

log-config

DEFAULT

log_config
log_date_format
Type

string

Default

%Y-%m-%d %H:%M:%S

Defines the format string for %(asctime)s in log records. Default: the value above . This option is ignored if log_config_append is set.

log_file
Type

string

Default

<None>

(Optional) Name of log file to send logging output to. If no default is set, logging will go to stderr as defined by use_stderr. This option is ignored if log_config_append is set.

Deprecated Variations

Group

Name

DEFAULT

logfile
log_dir
Type

string

Default

<None>

(Optional) The base directory used for relative log_file paths. This option is ignored if log_config_append is set.

Deprecated Variations

Group

Name

DEFAULT

logdir
watch_log_file
Type

boolean

Default

False

Uses logging handler designed to watch file system. When log file is moved or removed this handler will open a new log file with specified path instantaneously. It makes sense only if log_file option is specified and Linux platform is used. This option is ignored if log_config_append is set.

use_syslog
Type

boolean

Default

False

Use syslog for logging. Existing syslog format is DEPRECATED and will be changed later to honor RFC5424. This option is ignored if log_config_append is set.

use_journal
Type

boolean

Default

False

Enable journald for logging. If running in a systemd environment you may wish to enable journal support. Doing so will use the journal native protocol which includes structured metadata in addition to log messages.This option is ignored if log_config_append is set.

syslog_log_facility
Type

string

Default

LOG_USER

Syslog facility to receive log lines. This option is ignored if log_config_append is set.

use_json
Type

boolean

Default

False

Use JSON formatting for logging. This option is ignored if log_config_append is set.

use_stderr
Type

boolean

Default

False

Log output to standard error. This option is ignored if log_config_append is set.

use_eventlog
Type

boolean

Default

False

Log output to Windows Event Log.

log_rotate_interval
Type

integer

Default

1

The amount of time before the log files are rotated. This option is ignored unless log_rotation_type is set to “interval”.

log_rotate_interval_type
Type

string

Default

days

Valid Values

Seconds, Minutes, Hours, Days, Weekday, Midnight

Rotation interval type. The time of the last file change (or the time when the service was started) is used when scheduling the next rotation.

max_logfile_count
Type

integer

Default

30

Maximum number of rotated log files.

max_logfile_size_mb
Type

integer

Default

200

Log file maximum size in MB. This option is ignored if “log_rotation_type” is not set to “size”.

log_rotation_type
Type

string

Default

none

Valid Values

interval, size, none

Log rotation type.

Possible values

interval

Rotate logs at predefined time intervals.

size

Rotate logs once they reach a predefined size.

none

Do not rotate log files.

logging_context_format_string
Type

string

Default

%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s

Format string to use for log messages with context. Used by oslo_log.formatters.ContextFormatter

logging_default_format_string
Type

string

Default

%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s

Format string to use for log messages when context is undefined. Used by oslo_log.formatters.ContextFormatter

logging_debug_format_suffix
Type

string

Default

%(funcName)s %(pathname)s:%(lineno)d

Additional data to append to log message when logging level for the message is DEBUG. Used by oslo_log.formatters.ContextFormatter

logging_exception_prefix
Type

string

Default

%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s

Prefix each line of exception output with this format. Used by oslo_log.formatters.ContextFormatter

logging_user_identity_format
Type

string

Default

%(user)s %(project)s %(domain)s %(user_domain)s %(project_domain)s

Defines the format string for %(user_identity)s that is used in logging_context_format_string. Used by oslo_log.formatters.ContextFormatter

default_log_levels
Type

list

Default

['amqp=WARN', 'amqplib=WARN', 'boto=WARN', 'qpid=WARN', 'sqlalchemy=WARN', 'suds=INFO', 'oslo.messaging=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', 'keystoneauth=WARN', 'oslo.cache=INFO', 'oslo_policy=INFO', 'dogpile.core.dogpile=INFO']

List of package logging levels in logger=LEVEL pairs. This option is ignored if log_config_append is set.

publish_errors
Type

boolean

Default

False

Enables or disables publication of error events.

instance_format
Type

string

Default

"[instance: %(uuid)s] "

The format for an instance that is passed with the log message.

instance_uuid_format
Type

string

Default

"[instance: %(uuid)s] "

The format for an instance UUID that is passed with the log message.

rate_limit_interval
Type

integer

Default

0

Interval, number of seconds, of log rate limiting.

rate_limit_burst
Type

integer

Default

0

Maximum number of logged messages per rate_limit_interval.

rate_limit_except_level
Type

string

Default

CRITICAL

Log level name used by rate limiting: CRITICAL, ERROR, INFO, WARNING, DEBUG or empty string. Logs with level greater or equal to rate_limit_except_level are not filtered. An empty string means that all levels are filtered.

fatal_deprecations
Type

boolean

Default

False

Enables or disables fatal status of deprecations.

api

Configuration options for sending notifications.

region
Type

string

Default

RegionOne

Region name.

api_version
Type

string

Default

v1

Masakari API Version.

api_interface
Type

string

Default

public

Interface of endpoint.

auth_url
Type

unknown type

Default

<None>

Authentication URL

system_scope
Type

unknown type

Default

<None>

Scope for system operations

domain_id
Type

unknown type

Default

<None>

Domain ID to scope to

domain_name
Type

unknown type

Default

<None>

Domain name to scope to

project_id
Type

unknown type

Default

<None>

Project ID to scope to

Deprecated Variations

Group

Name

api

tenant-id

api

tenant_id
project_name
Type

unknown type

Default

<None>

Project name to scope to

Deprecated Variations

Group

Name

api

tenant-name

api

tenant_name
project_domain_id
Type

unknown type

Default

<None>

Domain ID containing project

project_domain_name
Type

unknown type

Default

<None>

Domain name containing project

trust_id
Type

unknown type

Default

<None>

Trust ID

default_domain_id
Type

unknown type

Default

<None>

Optional domain ID to use with v3 and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.

default_domain_name
Type

unknown type

Default

<None>

Optional domain name to use with v3 API and v2 parameters. It will be used for both the user and project domain in v3 and ignored in v2 authentication.

user_id
Type

unknown type

Default

<None>

User id

username
Type

unknown type

Default

<None>

Username

Deprecated Variations

Group

Name

api

user-name

api

user_name
user_domain_id
Type

unknown type

Default

<None>

User’s domain id

user_domain_name
Type

unknown type

Default

<None>

User’s domain name

password
Type

unknown type

Default

<None>

User’s password

callback

retry_max
Type

integer

Default

12

Number of retries when the notification processing is error.

retry_interval
Type

integer

Default

10

Trial interval of time of the notification processing is error(in seconds).

consul

agent_manage
Type

string

Default

<None>

Addr for local consul agent in management datacenter.

agent_tenant
Type

string

Default

<None>

Addr for local consul agent in tenant datacenter.

agent_storage
Type

string

Default

<None>

Addr for local consul agent in storage datacenter.

matrix_config_file
Type

string

Default

<None>

Config file for consul health action matrix.

cors

allowed_origin
Type

list

Default

<None>

Indicate whether this resource may be shared with the domain received in the requests “origin” header. Format: “<protocol>://<host>[:<port>]”, no trailing slash. Example: https://horizon.example.com

allow_credentials
Type

boolean

Default

True

Indicate that the actual request can include user credentials

expose_headers
Type

list

Default

[]

Indicate which headers are safe to expose to the API. Defaults to HTTP Simple Headers.

max_age
Type

integer

Default

3600

Maximum cache age of CORS preflight requests.

allow_methods
Type

list

Default

['OPTIONS', 'GET', 'HEAD', 'POST', 'PUT', 'DELETE', 'TRACE', 'PATCH']

Indicate which methods can be used during the actual request.

allow_headers
Type

list

Default

[]

Indicate which header field names may be used during the actual request.

healthcheck

path
Type

string

Default

/healthcheck

The path to respond to healtcheck requests on.

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

detailed
Type

boolean

Default

False

Show more detailed information as part of the response. Security note: Enabling this option may expose sensitive details about the service being monitored. Be sure to verify that it will not violate your security policies.

backends
Type

list

Default

[]

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

disable_by_file_path
Type

string

Default

<None>

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

disable_by_file_paths
Type

list

Default

[]

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.

host

monitoring_driver
Type

string

Default

default

Driver that hostmonitor uses for monitoring hosts.

monitoring_interval
Type

integer

Default

60

Monitoring interval(in seconds) of node status.

monitoring_samples
Type

integer

Default

1

Monitoring probes to collect before making the decision to send Masakari notification about the node status. If and only if monitoring_samples consecutive reports have the same status, will the Masakari notification be sent.

api_retry_max
Type

integer

Default

12

Number of retries for send a notification in hostmonitor.

api_retry_interval
Type

integer

Default

10

Trial interval of time of the notification processing is error(in seconds).

disable_ipmi_check
Type

boolean

Default

False

Do not check whether the host is completely down.

Possible values:

  • True: Do not check whether the host is completely down.

  • False: Do check whether the host is completely down.

If ipmi RA is not set in pacemaker, this value should be set True.

restrict_to_remotes
Type

boolean

Default

False

Only monitor pacemaker-remotes, ignore the status of full cluster members.

ipmi_timeout
Type

integer

Default

5

Timeout value(in seconds) of the ipmitool command.

ipmi_retry_max
Type

integer

Default

3

Number of ipmitool command retries.

ipmi_retry_interval
Type

integer

Default

10

Retry interval(in seconds) of the ipmitool command.

stonith_wait
Type

integer

Default

30

Standby time(in seconds) until activate STONITH.

tcpdump_timeout
Type

integer

Default

5

Timeout value(in seconds) of the tcpdump command when monitors the corosync communication.

corosync_multicast_interfaces
Type

string

Default

<None>

The name of interface that corosync is using for mutual communication between hosts. If there are multiple interfaces, specify them in comma-separated like ‘enp0s3,enp0s8’. The number of interfaces you specify must be equal to the number of corosync_multicast_ports values and must be in correct order with relevant ports in corosync_multicast_ports.

corosync_multicast_ports
Type

string

Default

<None>

The port numbers that corosync is using for mutual communication between hosts. If there are multiple port numbers, specify them in comma-separated like ‘5405,5406’. The number of port numbers you specify must be equal to the number of corosync_multicast_interfaces values and must be in correct order with relevant interfaces in corosync_multicast_interfaces.

pacemaker_node_type
Type

string

Default

autodetect

Valid Values

autodetect, cluster, remote

Using this option, one can avoid systemd checks that would establish whether this hostmonitor is running alongside Corosync and Pacemaker (the cluster stack) or Pacemaker Remote (the remote stack).

The default (autodetect) ensures backward compatibility and means systemd is used to check the stack.

introspectiveinstancemonitor

guest_monitoring_interval
Type

integer

Default

10

Guest monitoring interval of VM status (in seconds). * The value should not be too low as there should not be false negative * for reporting QEMU_GUEST_AGENT failures * VM needs time to do powering-off. * guest_monitoring_interval should be greater than * the time to SHUTDOWN VM gracefully. * e.g. | 565da9ba-3c0c-4087-83ca | iim1 | ACTIVE | powering-off | Running

guest_monitoring_timeout
Type

integer

Default

2

Guest monitoring timeout (in seconds).

guest_monitoring_failure_threshold
Type

integer

Default

3

Failure threshold before sending notification.

qemu_guest_agent_sock_path
Type

string

Default

/var/lib/libvirt/qemu/org\.qemu\.guest_agent\..*\.instance-.*\.sock

  • The file path of qemu guest agent sock.

  • Please use Python raw string notation as regular expressions.

e.g. r’/var/lib/libvirt/qemu/org.qemu.guest_agent..*.instance-.*.sock’

libvirt

connection_uri
Type

string

Default

qemu:///system

Override the default libvirt URI.

oslo_middleware

max_request_body_size
Type

integer

Default

114688

The maximum body size for each request, in bytes.

Deprecated Variations

Group

Name

DEFAULT

osapi_max_request_body_size

DEFAULT

max_request_body_size
secure_proxy_ssl_header
Type

string

Default

X-Forwarded-Proto

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.

Warning

This option is deprecated for removal. Its value may be silently ignored in the future.

enable_proxy_headers_parsing
Type

boolean

Default

False

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

http_basic_auth_user_file
Type

string

Default

/etc/htpasswd

HTTP basic auth password file.

process

check_interval
Type

integer

Default

5

Interval in seconds for checking a process.

restart_retries
Type

integer

Default

3

Number of retries when the failure of restarting a process.

restart_interval
Type

integer

Default

5

Interval in seconds for restarting a process.

api_retry_max
Type

integer

Default

12

Number of retries for send a notification in processmonitor.

api_retry_interval
Type

integer

Default

10

Interval between re-sending a notification in processmonitor(in seconds).

process_list_path
Type

string

Default

/etc/masakarimonitors/process_list.yaml

The file path of process list.