c4efae01d7
Currently logging configuration is splitted in two distinct classes, the api.pp and the logging.pp classes. This review aims to centralize all logging related parameters in a single class, the logging.pp one. The impacted parameters are : * use_syslog * use_stderr * log_facility * verbose * debug * log_dir * log_file This change remains backward compatible with what is currently in place. Change-Id: I6e56123217a38c384734d31e60699f7b76f7dc4a
266 lines
7.5 KiB
Puppet
266 lines
7.5 KiB
Puppet
# Class tuskar::logging
|
|
#
|
|
# tuskar logging configuration
|
|
#
|
|
# == parameters
|
|
#
|
|
# [*verbose*]
|
|
# (Optional) Should the daemons log verbose messages
|
|
# Defaults to 'false'
|
|
#
|
|
# [*debug*]
|
|
# (Optional) Should the daemons log debug messages
|
|
# Defaults to 'false'
|
|
#
|
|
# [*use_syslog*]
|
|
# (Optional) Use syslog for logging.
|
|
# Defaults to 'false'
|
|
#
|
|
# [*use_stderr*]
|
|
# (optional) Use stderr for logging
|
|
# Defaults to 'true'
|
|
#
|
|
# [*log_facility*]
|
|
# (Optional) Syslog facility to receive log lines.
|
|
# Defaults to 'LOG_USER'
|
|
#
|
|
# [*log_dir*]
|
|
# (optional) Directory where logs should be stored.
|
|
# If set to boolean false, it will not log to any directory.
|
|
# Defaults to '/var/log/tuskar'
|
|
#
|
|
# [*log_file*]
|
|
# (optional) The path of file used for logging
|
|
# If set to boolean false, it will not log to any file.
|
|
# Default to '/var/log/tuskar/tuskar-api.log'
|
|
#
|
|
# [*logging_context_format_string*]
|
|
# (optional) Format string to use for log messages with context.
|
|
# Defaults to undef.
|
|
# 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 undef.
|
|
# 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 undef.
|
|
# Example: '%(funcName)s %(pathname)s:%(lineno)d'
|
|
#
|
|
# [*logging_exception_prefix*]
|
|
# (optional) Prefix each line of exception output with this format.
|
|
# Defaults to undef.
|
|
# Example: '%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s'
|
|
#
|
|
# [*log_config_append*]
|
|
# The name of an additional logging configuration file.
|
|
# Defaults to undef.
|
|
# See https://docs.python.org/2/howto/logging.html
|
|
#
|
|
# [*default_log_levels*]
|
|
# (optional) Hash of logger (keys) and level (values) pairs.
|
|
# Defaults to undef.
|
|
# Example:
|
|
# { 'amqp' => 'WARN', 'amqplib' => 'WARN', 'boto' => 'WARN',
|
|
# 'qpid' => 'WARN', 'sqlalchemy' => 'WARN', 'suds' => 'INFO',
|
|
# 'iso8601' => 'WARN',
|
|
# 'requests.packages.urllib3.connectionpool' => 'WARN' }
|
|
#
|
|
# [*publish_errors*]
|
|
# (optional) Publish error events (boolean value).
|
|
# Defaults to undef (false if unconfigured).
|
|
#
|
|
# [*fatal_deprecations*]
|
|
# (optional) Make deprecations fatal (boolean value)
|
|
# Defaults to undef (false if unconfigured).
|
|
#
|
|
# [*instance_format*]
|
|
# (optional) If an instance is passed with the log message, format it
|
|
# like this (string value).
|
|
# Defaults to undef.
|
|
# 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 undef.
|
|
# Example: instance_uuid_format='[instance: %(uuid)s] '
|
|
|
|
# [*log_date_format*]
|
|
# (optional) Format string for %%(asctime)s in log records.
|
|
# Defaults to undef.
|
|
# Example: 'Y-%m-%d %H:%M:%S'
|
|
|
|
class tuskar::logging(
|
|
$use_syslog = false,
|
|
$use_stderr = true,
|
|
$log_facility = 'LOG_USER',
|
|
$log_dir = '/var/log/tuskar',
|
|
$log_file = '/var/log/tuskar/tuskar-api.log',
|
|
$verbose = false,
|
|
$debug = false,
|
|
$logging_context_format_string = undef,
|
|
$logging_default_format_string = undef,
|
|
$logging_debug_format_suffix = undef,
|
|
$logging_exception_prefix = undef,
|
|
$log_config_append = undef,
|
|
$default_log_levels = undef,
|
|
$publish_errors = undef,
|
|
$fatal_deprecations = undef,
|
|
$instance_format = undef,
|
|
$instance_uuid_format = undef,
|
|
$log_date_format = undef,
|
|
) {
|
|
|
|
# NOTE(spredzy): In order to keep backward compatibility we rely on the pick function
|
|
# to use tuskar::<myparam> first then tuskar::logging::<myparam>.
|
|
$use_syslog_real = pick($::tuskar::api::use_syslog,$use_syslog)
|
|
$use_stderr_real = pick($::tuskar::api::use_stderr,$use_stderr)
|
|
$log_facility_real = pick($::tuskar::api::log_facility,$log_facility)
|
|
$log_dir_real = pick($::tuskar::api::log_dir,$log_dir)
|
|
$log_file_real = pick($::tuskar::api::log_file,$log_file)
|
|
$verbose_real = pick($::tuskar::api::verbose,$verbose)
|
|
$debug_real = pick($::tuskar::api::debug,$debug)
|
|
|
|
tuskar_config {
|
|
'DEFAULT/debug' : value => $debug_real;
|
|
'DEFAULT/verbose' : value => $verbose_real;
|
|
'DEFAULT/use_stderr' : value => $use_stderr_real;
|
|
'DEFAULT/use_syslog' : value => $use_syslog_real;
|
|
'DEFAULT/log_dir' : value => $log_dir_real;
|
|
'DEFAULT/log_file' : value => $log_file_real;
|
|
'DEFAULT/syslog_log_facility': value => $log_facility_real;
|
|
}
|
|
|
|
if $logging_context_format_string {
|
|
tuskar_config {
|
|
'DEFAULT/logging_context_format_string' :
|
|
value => $logging_context_format_string;
|
|
}
|
|
}
|
|
else {
|
|
tuskar_config {
|
|
'DEFAULT/logging_context_format_string' : ensure => absent;
|
|
}
|
|
}
|
|
|
|
if $logging_default_format_string {
|
|
tuskar_config {
|
|
'DEFAULT/logging_default_format_string' :
|
|
value => $logging_default_format_string;
|
|
}
|
|
}
|
|
else {
|
|
tuskar_config {
|
|
'DEFAULT/logging_default_format_string' : ensure => absent;
|
|
}
|
|
}
|
|
|
|
if $logging_debug_format_suffix {
|
|
tuskar_config {
|
|
'DEFAULT/logging_debug_format_suffix' :
|
|
value => $logging_debug_format_suffix;
|
|
}
|
|
}
|
|
else {
|
|
tuskar_config {
|
|
'DEFAULT/logging_debug_format_suffix' : ensure => absent;
|
|
}
|
|
}
|
|
|
|
if $logging_exception_prefix {
|
|
tuskar_config {
|
|
'DEFAULT/logging_exception_prefix' : value => $logging_exception_prefix;
|
|
}
|
|
}
|
|
else {
|
|
tuskar_config {
|
|
'DEFAULT/logging_exception_prefix' : ensure => absent;
|
|
}
|
|
}
|
|
|
|
if $log_config_append {
|
|
tuskar_config {
|
|
'DEFAULT/log_config_append' : value => $log_config_append;
|
|
}
|
|
}
|
|
else {
|
|
tuskar_config {
|
|
'DEFAULT/log_config_append' : ensure => absent;
|
|
}
|
|
}
|
|
|
|
if $default_log_levels {
|
|
tuskar_config {
|
|
'DEFAULT/default_log_levels' :
|
|
value => join(sort(join_keys_to_values($default_log_levels, '=')), ',');
|
|
}
|
|
}
|
|
else {
|
|
tuskar_config {
|
|
'DEFAULT/default_log_levels' : ensure => absent;
|
|
}
|
|
}
|
|
|
|
if $publish_errors {
|
|
tuskar_config {
|
|
'DEFAULT/publish_errors' : value => $publish_errors;
|
|
}
|
|
}
|
|
else {
|
|
tuskar_config {
|
|
'DEFAULT/publish_errors' : ensure => absent;
|
|
}
|
|
}
|
|
|
|
if $fatal_deprecations {
|
|
tuskar_config {
|
|
'DEFAULT/fatal_deprecations' : value => $fatal_deprecations;
|
|
}
|
|
}
|
|
else {
|
|
tuskar_config {
|
|
'DEFAULT/fatal_deprecations' : ensure => absent;
|
|
}
|
|
}
|
|
|
|
if $instance_format {
|
|
tuskar_config {
|
|
'DEFAULT/instance_format' : value => $instance_format;
|
|
}
|
|
}
|
|
else {
|
|
tuskar_config {
|
|
'DEFAULT/instance_format' : ensure => absent;
|
|
}
|
|
}
|
|
|
|
if $instance_uuid_format {
|
|
tuskar_config {
|
|
'DEFAULT/instance_uuid_format' : value => $instance_uuid_format;
|
|
}
|
|
}
|
|
else {
|
|
tuskar_config {
|
|
'DEFAULT/instance_uuid_format' : ensure => absent;
|
|
}
|
|
}
|
|
|
|
if $log_date_format {
|
|
tuskar_config {
|
|
'DEFAULT/log_date_format' : value => $log_date_format;
|
|
}
|
|
}
|
|
else {
|
|
tuskar_config {
|
|
'DEFAULT/log_date_format' : ensure => absent;
|
|
}
|
|
}
|
|
|
|
|
|
}
|