6fb6ebfaf0
This option was deprecated in oslo.log 6.0.0 [1]. Because the warning to catch usage of the parameter is implemented in the underlying oslo::log defined resource type, no additional warning message is implemented in this module. [1] https://review.opendev.org/914788 Depends-on: https://review.opendev.org/930126 Change-Id: I3630f8773977c388c227378b28323be920b78b6a
160 lines
6.2 KiB
Puppet
160 lines
6.2 KiB
Puppet
# Class zaqar::logging
|
|
#
|
|
# zaqar extended logging configuration
|
|
#
|
|
# == parameters
|
|
#
|
|
# [*debug*]
|
|
# (Optional) Should the daemons log debug messages.
|
|
# Defaults to $facts['os_service_default'].
|
|
#
|
|
# [*use_syslog*]
|
|
# (Optional) Use syslog for logging.
|
|
# Defaults to $facts['os_service_default'].
|
|
#
|
|
# [*use_json*]
|
|
# (Optional) Use json for logging.
|
|
# Defaults to $facts['os_service_default'].
|
|
#
|
|
# [*use_journal*]
|
|
# (Optional) Use journal for logging.
|
|
# Defaults to $facts['os_service_default'].
|
|
#
|
|
# [*use_stderr*]
|
|
# (Optional) Use stderr for logging.
|
|
# Defaults to $facts['os_service_default'].
|
|
#
|
|
# [*log_facility*]
|
|
# (Optional) Syslog facility to receive log lines.
|
|
# Defaults to $facts['os_service_default'].
|
|
#
|
|
# [*log_dir*]
|
|
# (Optional) Directory where logs should be stored.
|
|
# If set to $facts['os_service_default'], it will not log to any directory.
|
|
# Defaults to '/var/log/zaqar'
|
|
#
|
|
# [*log_file*]
|
|
# (Optional) File where logs should be stored.
|
|
# Defaults to $facts['os_service_default']
|
|
#
|
|
# [*logging_context_format_string*]
|
|
# (Optional) Format string to use for log messages with context.
|
|
# Defaults to $facts['os_service_default'].
|
|
# Example: '%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s\
|
|
# [%(request_id)s %(user_identity)s] %(instance)s%(message)s'
|
|
#
|
|
# [*logging_default_format_string*]
|
|
# (Optional) Format string to use for log messages without context.
|
|
# Defaults to $facts['os_service_default'].
|
|
# Example: '%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s\
|
|
# [-] %(instance)s%(message)s'
|
|
#
|
|
# [*logging_debug_format_suffix*]
|
|
# (Optional) Formatted data to append to log format when level is DEBUG.
|
|
# Defaults to $facts['os_service_default'].
|
|
# Example: '%(funcName)s %(pathname)s:%(lineno)d'
|
|
#
|
|
# [*logging_exception_prefix*]
|
|
# (Optional) Prefix each line of exception output with this format.
|
|
# Defaults to $facts['os_service_default'].
|
|
# Example: '%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s'
|
|
#
|
|
# [*log_config_append*]
|
|
# (Optional) The name of an additional logging configuration file.
|
|
# Defaults to $facts['os_service_default'].
|
|
# See https://docs.python.org/2/howto/logging.html
|
|
#
|
|
# [*default_log_levels*]
|
|
# (Optional) Hash of logger (keys) and level (values) pairs.
|
|
# Defaults to $facts['os_service_default'].
|
|
# Example:
|
|
# { 'amqp' => 'WARN', 'amqplib' => 'WARN', 'boto' => 'WARN',
|
|
# 'sqlalchemy' => 'WARN', 'suds' => 'INFO',
|
|
# 'oslo.messaging' => 'INFO', 'iso8601' => 'WARN',
|
|
# 'requests.packages.urllib3.connectionpool' => 'WARN',
|
|
# 'urllib3.connectionpool' => 'WARN',
|
|
# 'websocket' => 'WARN', 'zaqarmiddleware' => 'WARN',
|
|
# 'routes.middleware' => 'WARN', stevedore => 'WARN' }
|
|
#
|
|
# [*publish_errors*]
|
|
# (Optional) Publish error events (boolean value).
|
|
# Defaults to $facts['os_service_default'] (false if unconfigured).
|
|
#
|
|
# [*fatal_deprecations*]
|
|
# (Optional) Make deprecations fatal (boolean value)
|
|
# Defaults to $facts['os_service_default'] (false if unconfigured).
|
|
#
|
|
# [*instance_format*]
|
|
# (Optional) If an instance is passed with the log message, format it
|
|
# like this (string value).
|
|
# Defaults to $facts['os_service_default'].
|
|
# Example: '[instance: %(uuid)s] '
|
|
#
|
|
# [*instance_uuid_format*]
|
|
# (Optional) If an instance UUID is passed with the log message, format
|
|
# it like this (string value).
|
|
# Defaults to $facts['os_service_default'].
|
|
# Example: instance_uuid_format='[instance: %(uuid)s] '
|
|
#
|
|
# [*log_date_format*]
|
|
# (Optional) Format string for %%(asctime)s in log records.
|
|
# Defaults to $facts['os_service_default'].
|
|
# Example: 'Y-%m-%d %H:%M:%S'
|
|
#
|
|
# DEPRECATED PARAMETERS
|
|
#
|
|
# [*watch_log_file*]
|
|
# (Optional) Uses logging handler designed to watch file system (boolean value).
|
|
# Defaults to $facts['os_service_default']
|
|
#
|
|
class zaqar::logging(
|
|
$use_syslog = $facts['os_service_default'],
|
|
$use_json = $facts['os_service_default'],
|
|
$use_journal = $facts['os_service_default'],
|
|
$use_stderr = $facts['os_service_default'],
|
|
$log_facility = $facts['os_service_default'],
|
|
$log_dir = '/var/log/zaqar',
|
|
$log_file = $facts['os_service_default'],
|
|
$debug = $facts['os_service_default'],
|
|
$logging_context_format_string = $facts['os_service_default'],
|
|
$logging_default_format_string = $facts['os_service_default'],
|
|
$logging_debug_format_suffix = $facts['os_service_default'],
|
|
$logging_exception_prefix = $facts['os_service_default'],
|
|
$log_config_append = $facts['os_service_default'],
|
|
$default_log_levels = $facts['os_service_default'],
|
|
$publish_errors = $facts['os_service_default'],
|
|
$fatal_deprecations = $facts['os_service_default'],
|
|
$instance_format = $facts['os_service_default'],
|
|
$instance_uuid_format = $facts['os_service_default'],
|
|
$log_date_format = $facts['os_service_default'],
|
|
# DEPRECATED PARAMETERS
|
|
$watch_log_file = undef,
|
|
) {
|
|
|
|
include zaqar::deps
|
|
|
|
oslo::log { 'zaqar_config':
|
|
logging_context_format_string => $logging_context_format_string,
|
|
logging_default_format_string => $logging_default_format_string,
|
|
logging_debug_format_suffix => $logging_debug_format_suffix,
|
|
logging_exception_prefix => $logging_exception_prefix,
|
|
log_config_append => $log_config_append,
|
|
default_log_levels => $default_log_levels,
|
|
publish_errors => $publish_errors,
|
|
fatal_deprecations => $fatal_deprecations,
|
|
instance_format => $instance_format,
|
|
instance_uuid_format => $instance_uuid_format,
|
|
log_date_format => $log_date_format,
|
|
use_syslog => $use_syslog,
|
|
use_json => $use_json,
|
|
use_journal => $use_journal,
|
|
use_stderr => $use_stderr,
|
|
syslog_log_facility => $log_facility,
|
|
log_dir => $log_dir,
|
|
log_file => $log_file,
|
|
watch_log_file => $watch_log_file,
|
|
debug => $debug,
|
|
}
|
|
|
|
}
|