File size: 10,274 Bytes
d1ceb73 |
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 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 |
'''
This library is provided to allow standard python logging
to output log data as JSON formatted strings
'''
import logging
import json
import re
from datetime import date, datetime, time, timezone
import traceback
import importlib
from typing import Any, Dict, Optional, Union, List, Tuple
from inspect import istraceback
from collections import OrderedDict
# skip natural LogRecord attributes
# http://docs.python.org/library/logging.html#logrecord-attributes
RESERVED_ATTRS: Tuple[str, ...] = (
'args', 'asctime', 'created', 'exc_info', 'exc_text', 'filename',
'funcName', 'levelname', 'levelno', 'lineno', 'module',
'msecs', 'message', 'msg', 'name', 'pathname', 'process',
'processName', 'relativeCreated', 'stack_info', 'thread', 'threadName')
def merge_record_extra(
record: logging.LogRecord,
target: Dict,
reserved: Union[Dict, List],
rename_fields: Optional[Dict[str,str]] = None,
) -> Dict:
"""
Merges extra attributes from LogRecord object into target dictionary
:param record: logging.LogRecord
:param target: dict to update
:param reserved: dict or list with reserved keys to skip
:param rename_fields: an optional dict, used to rename field names in the output.
Rename levelname to log.level: {'levelname': 'log.level'}
"""
if rename_fields is None:
rename_fields = {}
for key, value in record.__dict__.items():
# this allows to have numeric keys
if (key not in reserved
and not (hasattr(key, "startswith")
and key.startswith('_'))):
target[rename_fields.get(key,key)] = value
return target
class JsonEncoder(json.JSONEncoder):
"""
A custom encoder extending the default JSONEncoder
"""
def default(self, obj):
if isinstance(obj, (date, datetime, time)):
return self.format_datetime_obj(obj)
elif istraceback(obj):
return ''.join(traceback.format_tb(obj)).strip()
elif type(obj) == Exception \
or isinstance(obj, Exception) \
or type(obj) == type:
return str(obj)
try:
return super(JsonEncoder, self).default(obj)
except TypeError:
try:
return str(obj)
except Exception:
return None
def format_datetime_obj(self, obj):
return obj.isoformat()
class JsonFormatter(logging.Formatter):
"""
A custom formatter to format logging records as json strings.
Extra values will be formatted as str() if not supported by
json default encoder
"""
def __init__(self, *args, **kwargs):
"""
:param json_default: a function for encoding non-standard objects
as outlined in https://docs.python.org/3/library/json.html
:param json_encoder: optional custom encoder
:param json_serializer: a :meth:`json.dumps`-compatible callable
that will be used to serialize the log record.
:param json_indent: an optional :meth:`json.dumps`-compatible numeric value
that will be used to customize the indent of the output json.
:param prefix: an optional string prefix added at the beginning of
the formatted string
:param rename_fields: an optional dict, used to rename field names in the output.
Rename message to @message: {'message': '@message'}
:param static_fields: an optional dict, used to add fields with static values to all logs
:param json_indent: indent parameter for json.dumps
:param json_ensure_ascii: ensure_ascii parameter for json.dumps
:param reserved_attrs: an optional list of fields that will be skipped when
outputting json log record. Defaults to all log record attributes:
http://docs.python.org/library/logging.html#logrecord-attributes
:param timestamp: an optional string/boolean field to add a timestamp when
outputting the json log record. If string is passed, timestamp will be added
to log record using string as key. If True boolean is passed, timestamp key
will be "timestamp". Defaults to False/off.
"""
self.json_default = self._str_to_fn(kwargs.pop("json_default", None))
self.json_encoder = self._str_to_fn(kwargs.pop("json_encoder", None))
self.json_serializer = self._str_to_fn(kwargs.pop("json_serializer", json.dumps))
self.json_indent = kwargs.pop("json_indent", None)
self.json_ensure_ascii = kwargs.pop("json_ensure_ascii", True)
self.prefix = kwargs.pop("prefix", "")
self.rename_fields = kwargs.pop("rename_fields", {})
self.static_fields = kwargs.pop("static_fields", {})
reserved_attrs = kwargs.pop("reserved_attrs", RESERVED_ATTRS)
self.reserved_attrs = dict(zip(reserved_attrs, reserved_attrs))
self.timestamp = kwargs.pop("timestamp", False)
# super(JsonFormatter, self).__init__(*args, **kwargs)
logging.Formatter.__init__(self, *args, **kwargs)
if not self.json_encoder and not self.json_default:
self.json_encoder = JsonEncoder
self._required_fields = self.parse()
self._skip_fields = dict(zip(self._required_fields,
self._required_fields))
self._skip_fields.update(self.reserved_attrs)
def _str_to_fn(self, fn_as_str):
"""
If the argument is not a string, return whatever was passed in.
Parses a string such as package.module.function, imports the module
and returns the function.
:param fn_as_str: The string to parse. If not a string, return it.
"""
if not isinstance(fn_as_str, str):
return fn_as_str
path, _, function = fn_as_str.rpartition('.')
module = importlib.import_module(path)
return getattr(module, function)
def parse(self) -> List[str]:
"""
Parses format string looking for substitutions
This method is responsible for returning a list of fields (as strings)
to include in all log messages.
"""
if isinstance(self._style, logging.StringTemplateStyle):
formatter_style_pattern = re.compile(r'\$\{(.+?)\}', re.IGNORECASE)
elif isinstance(self._style, logging.StrFormatStyle):
formatter_style_pattern = re.compile(r'\{(.+?)\}', re.IGNORECASE)
# PercentStyle is parent class of StringTemplateStyle and StrFormatStyle so
# it needs to be checked last.
elif isinstance(self._style, logging.PercentStyle):
formatter_style_pattern = re.compile(r'%\((.+?)\)', re.IGNORECASE)
else:
raise ValueError('Invalid format: %s' % self._fmt)
if self._fmt:
return formatter_style_pattern.findall(self._fmt)
else:
return []
def add_fields(self, log_record: Dict[str, Any], record: logging.LogRecord, message_dict: Dict[str, Any]) -> None:
"""
Override this method to implement custom logic for adding fields.
"""
for field in self._required_fields:
log_record[field] = record.__dict__.get(field)
log_record.update(self.static_fields)
log_record.update(message_dict)
merge_record_extra(record, log_record, reserved=self._skip_fields, rename_fields=self.rename_fields)
if self.timestamp:
key = self.timestamp if type(self.timestamp) == str else 'timestamp'
log_record[key] = datetime.fromtimestamp(record.created, tz=timezone.utc)
self._perform_rename_log_fields(log_record)
def _perform_rename_log_fields(self, log_record):
for old_field_name, new_field_name in self.rename_fields.items():
log_record[new_field_name] = log_record[old_field_name]
del log_record[old_field_name]
def process_log_record(self, log_record):
"""
Override this method to implement custom logic
on the possibly ordered dictionary.
"""
return log_record
def jsonify_log_record(self, log_record):
"""Returns a json string of the log record."""
return self.json_serializer(log_record,
default=self.json_default,
cls=self.json_encoder,
indent=self.json_indent,
ensure_ascii=self.json_ensure_ascii)
def serialize_log_record(self, log_record: Dict[str, Any]) -> str:
"""Returns the final representation of the log record."""
return "%s%s" % (self.prefix, self.jsonify_log_record(log_record))
def format(self, record: logging.LogRecord) -> str:
"""Formats a log record and serializes to json"""
message_dict: Dict[str, Any] = {}
# FIXME: logging.LogRecord.msg and logging.LogRecord.message in typeshed
# are always type of str. We shouldn't need to override that.
if isinstance(record.msg, dict):
message_dict = record.msg
record.message = ""
else:
record.message = record.getMessage()
# only format time if needed
if "asctime" in self._required_fields:
record.asctime = self.formatTime(record, self.datefmt)
# Display formatted exception, but allow overriding it in the
# user-supplied dict.
if record.exc_info and not message_dict.get('exc_info'):
message_dict['exc_info'] = self.formatException(record.exc_info)
if not message_dict.get('exc_info') and record.exc_text:
message_dict['exc_info'] = record.exc_text
# Display formatted record of stack frames
# default format is a string returned from :func:`traceback.print_stack`
if record.stack_info and not message_dict.get('stack_info'):
message_dict['stack_info'] = self.formatStack(record.stack_info)
log_record: Dict[str, Any] = OrderedDict()
self.add_fields(log_record, record, message_dict)
log_record = self.process_log_record(log_record)
return self.serialize_log_record(log_record)
|