Puppet Class: placement::logging

Defined in:
manifests/logging.pp

Overview

Class placement::logging

placement 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_json

(Optional) Use json for logging. Defaults to $::os_service_default

use_journal

(Optional) Use journal for logging. Defaults to $::os_service_default

use_stderr

(Optional) Use stderr for logging Defaults to $::os_service_default

syslog_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, it will not log to any directory. Defaults to ‘/var/log/placement’.

log_file

(Optional) File where logs should be stored. Defaults to ‘/var/log/placement/placement.log’

watch_log_file

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

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

(Optional) The name of an additional logging configuration file. Defaults to $::os_service_default See 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',
     'oslo.messaging' => 'INFO', 'iso8601' => 'WARN',
     'requests.packages.urllib3.connectionpool' => 'WARN',
     'urllib3.connectionpool' => 'WARN',
     'websocket' => 'WARN', 'placementmiddleware' => 'WARN',
     'routes.middleware' => 'WARN', stevedore => '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 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 $::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’

Parameters:

  • use_syslog (Any) (defaults to: $::os_service_default)
  • use_json (Any) (defaults to: $::os_service_default)
  • use_journal (Any) (defaults to: $::os_service_default)
  • use_stderr (Any) (defaults to: $::os_service_default)
  • syslog_log_facility (Any) (defaults to: $::os_service_default)
  • log_dir (Any) (defaults to: '/var/log/placement')
  • log_file (Any) (defaults to: '/var/log/placement/placement.log')
  • watch_log_file (Any) (defaults to: $::os_service_default)
  • 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) 


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
 
# File 'manifests/logging.pp', line 108

class placement::logging(
  $use_syslog                    = $::os_service_default,
  $use_json                      = $::os_service_default,
  $use_journal                   = $::os_service_default,
  $use_stderr                    = $::os_service_default,
  $syslog_log_facility           = $::os_service_default,
  $log_dir                       = '/var/log/placement',
  $log_file                      = '/var/log/placement/placement.log',
  $watch_log_file                = $::os_service_default,
  $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,
) {

  include placement::deps

  oslo::log { 'placement_config':
    use_stderr                    => $use_stderr,
    use_syslog                    => $use_syslog,
    use_json                      => $use_json,
    use_journal                   => $use_journal,
    log_dir                       => $log_dir,
    log_file                      => $log_file,
    watch_log_file                => $watch_log_file,
    debug                         => $debug,
    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,
    syslog_log_facility           => $syslog_log_facility,
  }
}