jsonlogger.py 5.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148
  1. '''
  2. This library is provided to allow standard python logging
  3. to output log data as JSON formatted strings
  4. '''
  5. import logging
  6. import json
  7. import re
  8. import datetime
  9. import traceback
  10. from inspect import istraceback
  11. #Support order in python 2.7 and 3
  12. try:
  13. from collections import OrderedDict
  14. except ImportError:
  15. pass
  16. # skip natural LogRecord attributes
  17. # http://docs.python.org/library/logging.html#logrecord-attributes
  18. RESERVED_ATTRS = (
  19. 'args', 'asctime', 'created', 'exc_info', 'exc_text', 'filename',
  20. 'funcName', 'levelname', 'levelno', 'lineno', 'module',
  21. 'msecs', 'message', 'msg', 'name', 'pathname', 'process',
  22. 'processName', 'relativeCreated', 'stack_info', 'thread', 'threadName')
  23. RESERVED_ATTR_HASH = dict(zip(RESERVED_ATTRS, RESERVED_ATTRS))
  24. def merge_record_extra(record, target, reserved=RESERVED_ATTR_HASH):
  25. """
  26. Merges extra attributes from LogRecord object into target dictionary
  27. :param record: logging.LogRecord
  28. :param target: dict to update
  29. :param reserved: dict or list with reserved keys to skip
  30. """
  31. for key, value in record.__dict__.items():
  32. #this allows to have numeric keys
  33. if (key not in reserved
  34. and not (hasattr(key, "startswith")
  35. and key.startswith('_'))):
  36. target[key] = value
  37. return target
  38. class JsonFormatter(logging.Formatter):
  39. """
  40. A custom formatter to format logging records as json strings.
  41. extra values will be formatted as str() if nor supported by
  42. json default encoder
  43. """
  44. def __init__(self, *args, **kwargs):
  45. """
  46. :param json_default: a function for encoding non-standard objects
  47. as outlined in http://docs.python.org/2/library/json.html
  48. :param json_encoder: optional custom encoder
  49. :param json_serializer: a :meth:`json.dumps`-compatible callable
  50. that will be used to serialize the log record.
  51. :param prefix: an optional string prefix added at the beginning of
  52. the formatted string
  53. """
  54. self.json_default = kwargs.pop("json_default", None)
  55. self.json_encoder = kwargs.pop("json_encoder", None)
  56. self.json_serializer = kwargs.pop("json_serializer", json.dumps)
  57. self.json_indent = kwargs.pop("json_indent", None)
  58. self.prefix = kwargs.pop("prefix", "")
  59. #super(JsonFormatter, self).__init__(*args, **kwargs)
  60. logging.Formatter.__init__(self, *args, **kwargs)
  61. if not self.json_encoder and not self.json_default:
  62. def _default_json_handler(obj):
  63. '''Prints dates in ISO format'''
  64. if isinstance(obj, (datetime.date, datetime.time)):
  65. return obj.isoformat()
  66. elif istraceback(obj):
  67. tb = ''.join(traceback.format_tb(obj))
  68. return tb.strip()
  69. elif isinstance(obj, Exception):
  70. return "Exception: %s" % str(obj)
  71. return str(obj)
  72. self.json_default = _default_json_handler
  73. self._required_fields = self.parse()
  74. self._skip_fields = dict(zip(self._required_fields,
  75. self._required_fields))
  76. self._skip_fields.update(RESERVED_ATTR_HASH)
  77. def parse(self):
  78. """
  79. Parses format string looking for substitutions
  80. This method is responsible for returning a list of fields (as strings)
  81. to include in all log messages.
  82. """
  83. standard_formatters = re.compile(r'\((.+?)\)', re.IGNORECASE)
  84. return standard_formatters.findall(self._fmt)
  85. def add_fields(self, log_record, record, message_dict):
  86. """
  87. Override this method to implement custom logic for adding fields.
  88. """
  89. for field in self._required_fields:
  90. log_record[field] = record.__dict__.get(field)
  91. log_record.update(message_dict)
  92. merge_record_extra(record, log_record, reserved=self._skip_fields)
  93. def process_log_record(self, log_record):
  94. """
  95. Override this method to implement custom logic
  96. on the possibly ordered dictionary.
  97. """
  98. return log_record
  99. def jsonify_log_record(self, log_record):
  100. """Returns a json string of the log record."""
  101. return self.json_serializer(log_record,
  102. default=self.json_default,
  103. cls=self.json_encoder,
  104. indent=self.json_indent)
  105. def format(self, record):
  106. """Formats a log record and serializes to json"""
  107. message_dict = {}
  108. if isinstance(record.msg, dict):
  109. message_dict = record.msg
  110. record.message = None
  111. else:
  112. record.message = record.getMessage()
  113. # only format time if needed
  114. if "asctime" in self._required_fields:
  115. record.asctime = self.formatTime(record, self.datefmt)
  116. # Display formatted exception, but allow overriding it in the
  117. # user-supplied dict.
  118. if record.exc_info and not message_dict.get('exc_info'):
  119. message_dict['exc_info'] = self.formatException(record.exc_info)
  120. if not message_dict.get('exc_info') and record.exc_text:
  121. message_dict['exc_info'] = record.exc_text
  122. try:
  123. log_record = OrderedDict()
  124. except NameError:
  125. log_record = {}
  126. self.add_fields(log_record, record, message_dict)
  127. log_record = self.process_log_record(log_record)
  128. return "%s%s" % (self.prefix, self.jsonify_log_record(log_record))