Puppet Class: neutron::logging

Defined in:
manifests/logging.pp

Overview

Class: neutron::logging

Neutron logging configuration

Parameters:

debug

(Optional) Print debug messages in the logs Defaults to $facts

use_syslog

(Optional) Use syslog for logging Defaults to $facts

use_json

(Optional) Use json for logging Defaults to $facts

use_journal

(Optional) Use journal for logging Defaults to $facts

use_stderr

(Optional) Use stderr for logging Defaults to $facts

log_file

(Optional) Where to log Defaults to $facts

log_dir

(Optional) Directory where logs should be stored If set to $facts, it will not log to any directory Defaults to /var/log/neutron

log_config_append

(Optional) The name of an additional logging configuration file. Defaults to $facts See docs.python.org/2/howto/logging.html

log_date_format

(Optional) Format string for %%(asctime)s in log records. Defaults to $facts Example: ‘Y-%m-%d %H:%M:%S’

watch_log_file

(Optional) Uses logging handler designed to watch file system (boolean value). Defaults to $facts

syslog_log_facility

(Optional) Syslog facility to receive log lines. This option is ignored if log_config_append is set. Defaults to $facts

logging_context_format_string

(Optional) Format string to use for log messages with context. Defaults to $facts 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 when context is undefined. Defaults to $facts Example: ‘%(asctime)s.%(msecs)03d %(process)d %(levelname)s \

%(name)s [-] %(instance)s%(message)s'
logging_debug_format_suffix

(Optional) Additional data to append to log message when logging level for the message is DEBUG’ Defaults to $facts Example: ‘%(funcName)s %(pathname)s:%(lineno)d’

logging_exception_prefix

(Optional) Prefix each line of exception output with this format. Defaults to $facts Example: ‘%(asctime)s.%(msecs)03d %(process)d ERROR %(name)s %(instance)s’

logging_user_identity_format

(Optional) Defines the format string for %(user_identity)s that is used in logging_context_format_string. Defaults to $facts Example: ‘%(user)s %(tenant)s %(domain)s %(user_domain)s %(project_domain)s’

default_log_levels

(Optional) Hash of logger (keys) and level (values) pairs. Defaults to $facts Example:

{ 'amqp' => 'WARN', 'amqplib' => 'WARN', 'boto' => 'WARN',
  'sqlalchemy' => 'WARN', 'suds' => 'INFO', 'iso8601' => 'WARN',
  'requests.packages.urllib3.connectionpool' => 'WARN' }
publish_errors

(Optional) Enables or disables publication of error events (boolean value). Defaults to $facts

instance_format

(Optional) The format for an instance that is passed with the log message. Defaults to $facts Example: ‘[instance: %(uuid)s] ’

instance_uuid_format

(Optional) The format for an instance UUID that is passed with the log message. Defaults to $facts Example: ‘[instance: %(uuid)s] ’

fatal_deprecations

(Optional) Enables or disables fatal status of deprecations (boolean value). Defaults to $facts

Parameters:

  • debug (Any) (defaults to: $facts['os_service_default'])
  • use_syslog (Any) (defaults to: $facts['os_service_default'])
  • use_json (Any) (defaults to: $facts['os_service_default'])
  • use_journal (Any) (defaults to: $facts['os_service_default'])
  • use_stderr (Any) (defaults to: $facts['os_service_default'])
  • log_file (Any) (defaults to: $facts['os_service_default'])
  • log_dir (Any) (defaults to: '/var/log/neutron')
  • log_config_append (Any) (defaults to: $facts['os_service_default'])
  • log_date_format (Any) (defaults to: $facts['os_service_default'])
  • watch_log_file (Any) (defaults to: $facts['os_service_default'])
  • syslog_log_facility (Any) (defaults to: $facts['os_service_default'])
  • logging_context_format_string (Any) (defaults to: $facts['os_service_default'])
  • logging_default_format_string (Any) (defaults to: $facts['os_service_default'])
  • logging_debug_format_suffix (Any) (defaults to: $facts['os_service_default'])
  • logging_exception_prefix (Any) (defaults to: $facts['os_service_default'])
  • logging_user_identity_format (Any) (defaults to: $facts['os_service_default'])
  • default_log_levels (Any) (defaults to: $facts['os_service_default'])
  • publish_errors (Any) (defaults to: $facts['os_service_default'])
  • instance_format (Any) (defaults to: $facts['os_service_default'])
  • instance_uuid_format (Any) (defaults to: $facts['os_service_default'])
  • fatal_deprecations (Any) (defaults to: $facts['os_service_default']) 


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
148
149
150
151
152
153
154
155
156
157
158
 
# File 'manifests/logging.pp', line 108

class neutron::logging (
  $debug                         = $facts['os_service_default'],
  $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_file                      = $facts['os_service_default'],
  $log_dir                       = '/var/log/neutron',
  $log_config_append             = $facts['os_service_default'],
  $log_date_format               = $facts['os_service_default'],
  $watch_log_file                = $facts['os_service_default'],
  $syslog_log_facility           = $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'],
  $logging_user_identity_format  = $facts['os_service_default'],
  $default_log_levels            = $facts['os_service_default'],
  $publish_errors                = $facts['os_service_default'],
  $instance_format               = $facts['os_service_default'],
  $instance_uuid_format          = $facts['os_service_default'],
  $fatal_deprecations            = $facts['os_service_default'],
) {

  include neutron::deps

  oslo::log { 'neutron_config':
    debug                         => $debug,
    use_stderr                    => $use_stderr,
    use_syslog                    => $use_syslog,
    use_json                      => $use_json,
    use_journal                   => $use_journal,
    syslog_log_facility           => $syslog_log_facility,
    log_file                      => $log_file,
    log_dir                       => $log_dir,
    log_config_append             => $log_config_append,
    log_date_format               => $log_date_format,
    watch_log_file                => $watch_log_file,
    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,
    logging_user_identity_format  => $logging_user_identity_format,
    default_log_levels            => $default_log_levels,
    publish_errors                => $publish_errors,
    instance_format               => $instance_format,
    instance_uuid_format          => $instance_uuid_format,
    fatal_deprecations            => $fatal_deprecations,
  }

}