/usr/lib/python2.7/dist-packages/oslo_log/handlers.py is in python-oslo.log 3.36.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 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 148 149 150 151 152 153 154 155 156 157 158 159 160 161 | # -*- coding: utf-8 -*-
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import inspect
import logging
import logging.config
import logging.handlers
import os
import six
try:
from systemd import journal
except ImportError:
journal = None
try:
import syslog
except ImportError:
syslog = None
from oslo_utils import encodeutils
NullHandler = logging.NullHandler
def _get_binary_name():
return os.path.basename(inspect.stack()[-1][1])
_AUDIT = logging.INFO + 1
_TRACE = 5
# This is a copy of the numerical constants from syslog.h. The
# definition of these goes back at least 20 years, and is specifically
# 3 bits in a packed field, so these aren't likely to ever need
# changing.
SYSLOG_MAP = {
"CRITICAL": 2,
"ERROR": 3,
"WARNING": 4,
"WARN": 4,
"INFO": 6,
"DEBUG": 7,
}
class OSSysLogHandler(logging.Handler):
"""Syslog based handler. Only available on UNIX-like platforms."""
def __init__(self, facility=None):
# Default values always get evaluated, for which reason we avoid
# using 'syslog' directly, which may not be available.
facility = facility if facility is not None else syslog.LOG_USER
# Do not use super() unless type(logging.Handler) is 'type'
# (i.e. >= Python 2.7).
if not syslog:
raise RuntimeError("Syslog not available on this platform")
logging.Handler.__init__(self)
binary_name = _get_binary_name()
syslog.openlog(binary_name, 0, facility)
def emit(self, record):
priority = SYSLOG_MAP.get(record.levelname, 7)
message = self.format(record)
# NOTE(gangila): In python2, the syslog function takes in 's' as
# the format argument, which means it either accepts python string
# (str = 'a') or unicode strings (str = u'a'), the PyArg_ParseTuple
# then if needed converts the unicode objects to C strings using
# the *default encoding*. This default encoding is 'ascii' in case
# of python2 while it has been changed to 'utf-8' in case of
# python3. What this leads to is when we supply a syslog message
# like:
# >>> syslog.syslog(syslog.LOG_DEBUG, u"François Deppierraz")
# In case of python2 the above fails with TypeError: [priority,]
# message string. Because python2 doesn't explicitly encode as
# 'utf-8' and use the system default encoding ascii, which raises
# a UnicodeEncodeError (UnicodeEncodeError: 'ascii' codec can't
# encode character u'\xe7' in position 4: ordinal not in
# range(128)), and hence the error message that's set in the code
# (TypeError: [priority,] message string) gets shown to the user.
# However, this in the case of Python3, where the system default
# encoding is 'utf-8' works without any issues. Therefore, we need
# to safe_encode in case of python2 and not in case of Python3.
if six.PY2:
message = encodeutils.safe_encode(self.format(record))
syslog.syslog(priority, message)
class OSJournalHandler(logging.Handler):
custom_fields = (
'project_name',
'project_id',
'user_name',
'user_id',
'request_id',
)
def __init__(self):
# Do not use super() unless type(logging.Handler) is 'type'
# (i.e. >= Python 2.7).
if not journal:
raise RuntimeError("Systemd bindings do not exist")
logging.Handler.__init__(self)
self.binary_name = _get_binary_name()
def emit(self, record):
priority = SYSLOG_MAP.get(record.levelname, 7)
message = self.format(record)
extras = {
'CODE_FILE': record.pathname,
'CODE_LINE': record.lineno,
'CODE_FUNC': record.funcName,
'THREAD_NAME': record.threadName,
'PROCESS_NAME': record.processName,
'LOGGER_NAME': record.name,
'LOGGER_LEVEL': record.levelname,
'SYSLOG_IDENTIFIER': self.binary_name,
'PRIORITY': priority
}
if record.exc_text:
extras['EXCEPTION_TEXT'] = record.exc_text
if record.exc_info:
extras['EXCEPTION_INFO'] = record.exc_info
for field in self.custom_fields:
value = record.__dict__.get(field)
if value:
extras[field.upper()] = value
journal.send(message, **extras)
class ColorHandler(logging.StreamHandler):
LEVEL_COLORS = {
_TRACE: '\033[00;35m', # MAGENTA
logging.DEBUG: '\033[00;32m', # GREEN
logging.INFO: '\033[00;36m', # CYAN
_AUDIT: '\033[01;36m', # BOLD CYAN
logging.WARN: '\033[01;33m', # BOLD YELLOW
logging.ERROR: '\033[01;31m', # BOLD RED
logging.CRITICAL: '\033[01;31m', # BOLD RED
}
def format(self, record):
record.color = self.LEVEL_COLORS[record.levelno]
return logging.StreamHandler.format(self, record)
|