Puppet Class: cinder::logging

Defined in:
manifests/logging.pp

Overview

Class: cinder::logging

Cinder logging configuration

Parameters

[*debug*]
  (Optional) Should the daemons log debug messages
  Defaults to $::os_service_default

[*use_syslog*]
  (Optional) Use syslog for logging.
  Defaults to $::os_service_default

[*use_stderr*]
  (optional) Use stderr for logging
  Defaults to $::os_service_default

[*log_facility*]
  (Optional) Syslog facility to receive log lines.
  Defaults to $::os_service_default

[*log_dir*]
  (optional) Directory where logs should be stored.
  If set to boolean false or $::os_service_default, it will not log to any
  directory.
  Defaults to '/var/log/cinder'

[*logging_context_format_string*]
  (Optional) Format string to use for log messages with context.
  Defaults to $::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 $::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 $::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 $::os_service_default
  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 $::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 $::os_service_default.
  Example:
    { 'amqp' => 'WARN', 'amqplib' => 'WARN', 'boto' => 'WARN',
      'sqlalchemy' => 'WARN', 'suds' => 'INFO', 'iso8601' => 'WARN',
      'requests.packages.urllib3.connectionpool' => 'WARN' }

[*publish_errors*]
  (optional) Publish error events (boolean value).
  Defaults to $::os_service_default

[*fatal_deprecations*]
  (optional) Make deprecations fatal (boolean value)
  Defaults to $::os_service_default

[*instance_format*]
  (optional) If an instance is passed with the log message, format it
             like this (string value).
  Defaults to $::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 $::os_service_default
  Example: instance_uuid_format='[instance: %(uuid)s] '

[*log_date_format*]
  (optional) Format string for %%(asctime)s in log records.
  Defaults to $::os_service_default
  Example: 'Y-%m-%d %H:%M:%S'

DEPRECATED PARAMETERS

[*verbose*]
  (Optional) DEPRECATED. Should the daemons log verbose messages
  Defaults to undef

Parameters:

  • use_syslog (Any) (defaults to: $::os_service_default)
  • use_stderr (Any) (defaults to: $::os_service_default)
  • log_facility (Any) (defaults to: $::os_service_default)
  • log_dir (Any) (defaults to: '/var/log/cinder')
  • debug (Any) (defaults to: $::os_service_default)
  • logging_context_format_string (Any) (defaults to: $::os_service_default)
  • logging_default_format_string (Any) (defaults to: $::os_service_default)
  • logging_debug_format_suffix (Any) (defaults to: $::os_service_default)
  • logging_exception_prefix (Any) (defaults to: $::os_service_default)
  • log_config_append (Any) (defaults to: $::os_service_default)
  • default_log_levels (Any) (defaults to: $::os_service_default)
  • publish_errors (Any) (defaults to: $::os_service_default)
  • fatal_deprecations (Any) (defaults to: $::os_service_default)
  • instance_format (Any) (defaults to: $::os_service_default)
  • instance_uuid_format (Any) (defaults to: $::os_service_default)
  • log_date_format (Any) (defaults to: $::os_service_default)
  • verbose (Any) (defaults to: undef) 


94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'manifests/logging.pp', line 94

class cinder::logging(
  $use_syslog                    = $::os_service_default,
  $use_stderr                    = $::os_service_default,
  $log_facility                  = $::os_service_default,
  $log_dir                       = '/var/log/cinder',
  $debug                         = $::os_service_default,
  $logging_context_format_string = $::os_service_default,
  $logging_default_format_string = $::os_service_default,
  $logging_debug_format_suffix   = $::os_service_default,
  $logging_exception_prefix      = $::os_service_default,
  $log_config_append             = $::os_service_default,
  $default_log_levels            = $::os_service_default,
  $publish_errors                = $::os_service_default,
  $fatal_deprecations            = $::os_service_default,
  $instance_format               = $::os_service_default,
  $instance_uuid_format          = $::os_service_default,
  $log_date_format               = $::os_service_default,
  # DEPRECATED PARAMETERS
  $verbose                       = undef,
) {

  include ::cinder::deps

  if $verbose {
    warning('verbose is deprecated, has no effect and will be removed after Newton cycle.')
  }

  # NOTE(spredzy): In order to keep backward compatibility we rely on the pick function
  # to use cinder::<myparam> if cinder::logging::<myparam> isn't specified.
  $use_syslog_real = pick($::cinder::use_syslog,$use_syslog)
  $use_stderr_real = pick($::cinder::use_stderr,$use_stderr)
  $log_facility_real = pick($::cinder::log_facility,$log_facility)
  $log_dir_real = pick($::cinder::log_dir,$log_dir)
  $debug_real = pick($::cinder::debug,$debug)

  oslo::log { 'cinder_config':
    debug                         => $debug_real,
    use_syslog                    => $use_syslog_real,
    use_stderr                    => $use_stderr_real,
    log_dir                       => $log_dir_real,
    syslog_log_facility           => $log_facility_real,
    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,
    log_date_format               => $log_date_format,
    instance_format               => $instance_format,
    instance_uuid_format          => $instance_uuid_format,
  }
}