|
| 1 | +import traceback |
| 2 | +import logging |
| 3 | +import socket |
| 4 | +import sys |
| 5 | +from datetime import datetime |
| 6 | +try: |
| 7 | + import simplejson as json |
| 8 | +except ImportError: |
| 9 | + import json |
| 10 | + |
| 11 | + |
| 12 | +class JSONFormatter(logging.Formatter): |
| 13 | + |
| 14 | + def __init__(self, tags=None, hostname=None, fqdn=False, message_type='JSON', indent=None): |
| 15 | + self.message_type = message_type |
| 16 | + self.tags = tags if tags is not None else [] |
| 17 | + self.extra_tags = [] |
| 18 | + self.indent = indent |
| 19 | + |
| 20 | + if hostname: |
| 21 | + self.host = hostname |
| 22 | + elif fqdn: |
| 23 | + self.host = socket.getfqdn() |
| 24 | + else: |
| 25 | + self.host = socket.gethostname() |
| 26 | + |
| 27 | + def get_extra_fields(self, record): |
| 28 | + # The list contains all the attributes listed in |
| 29 | + # http://docs.python.org/library/logging.html#logrecord-attributes |
| 30 | + skip_list = [ |
| 31 | + 'asctime', 'created', 'exc_info', 'exc_text', 'filename', 'args', |
| 32 | + 'funcName', 'id', 'levelname', 'levelno', 'lineno', 'module', 'msg', |
| 33 | + 'msecs', 'msecs', 'message', 'name', 'pathname', 'process', |
| 34 | + 'processName', 'relativeCreated', 'thread', 'threadName', 'extra'] |
| 35 | + |
| 36 | + if sys.version_info < (3, 0): |
| 37 | + easy_types = (basestring, bool, dict, float, int, list, type(None)) |
| 38 | + else: |
| 39 | + easy_types = (str, bool, dict, float, int, list, type(None)) |
| 40 | + |
| 41 | + fields = {} |
| 42 | + |
| 43 | + if record.args: |
| 44 | + fields['msg'] = record.msg |
| 45 | + |
| 46 | + self.extra_tags = [] |
| 47 | + for key, value in record.__dict__.items(): |
| 48 | + if key not in skip_list: |
| 49 | + if key == 'tags' and isinstance(value, list): |
| 50 | + self.extra_tags = value |
| 51 | + elif isinstance(value, easy_types): |
| 52 | + fields[key] = value |
| 53 | + else: |
| 54 | + fields[key] = repr(value) |
| 55 | + |
| 56 | + return fields |
| 57 | + |
| 58 | + def get_debug_fields(self, record): |
| 59 | + if record.exc_info: |
| 60 | + exc_info = self.format_exception(record.exc_info) |
| 61 | + else: |
| 62 | + exc_info = record.exc_text |
| 63 | + return { |
| 64 | + 'exc_info': exc_info, |
| 65 | + 'filename': record.filename, |
| 66 | + 'lineno': record.lineno, |
| 67 | + } |
| 68 | + |
| 69 | + @classmethod |
| 70 | + def format_source(cls, message_type, host, path): |
| 71 | + return "%s://%s/%s" % (message_type, host, path) |
| 72 | + |
| 73 | + @classmethod |
| 74 | + def format_timestamp(cls, time): |
| 75 | + return datetime.utcfromtimestamp(time).isoformat() + 'Z' |
| 76 | + |
| 77 | + @classmethod |
| 78 | + def format_exception(cls, exc_info): |
| 79 | + return ''.join(traceback.format_exception(*exc_info)) if exc_info else '' |
| 80 | + |
| 81 | + @classmethod |
| 82 | + def serialize(cls, message, indent=None): |
| 83 | + return json.dumps(message, indent=indent) |
| 84 | + |
| 85 | + def format(self, record, serialize=True): |
| 86 | + # Create message dict |
| 87 | + message = { |
| 88 | + 'timestamp': self.format_timestamp(record.created), |
| 89 | + 'message': record.getMessage(), |
| 90 | + 'host': self.host, |
| 91 | + 'path': record.pathname, |
| 92 | + 'tags': self.tags[:], |
| 93 | + 'level': record.levelname, |
| 94 | + 'logger': record.name, |
| 95 | + } |
| 96 | + |
| 97 | + # Add extra fields |
| 98 | + message.update(self.get_extra_fields(record)) |
| 99 | + |
| 100 | + # Add extra tags |
| 101 | + if self.extra_tags: |
| 102 | + message['tags'].extend(self.extra_tags) |
| 103 | + |
| 104 | + # If exception, add debug info |
| 105 | + if record.exc_info or record.exc_text: |
| 106 | + message.update(self.get_debug_fields(record)) |
| 107 | + |
| 108 | + if serialize: |
| 109 | + return self.serialize(message, indent=self.indent) |
| 110 | + return message |
| 111 | + |
| 112 | + |
| 113 | +class LogstashFormatterV0(JSONFormatter): |
| 114 | + version = 0 |
| 115 | + |
| 116 | + def format(self, record): |
| 117 | + # Create message dict |
| 118 | + message = { |
| 119 | + '@timestamp': self.format_timestamp(record.created), |
| 120 | + '@message': record.getMessage(), |
| 121 | + '@source': self.format_source(self.message_type, self.host, |
| 122 | + record.pathname), |
| 123 | + '@source_host': self.host, |
| 124 | + '@source_path': record.pathname, |
| 125 | + '@tags': self.tags[:], |
| 126 | + '@type': self.message_type, |
| 127 | + '@fields': { |
| 128 | + 'levelname': record.levelname, |
| 129 | + 'logger': record.name, |
| 130 | + }, |
| 131 | + } |
| 132 | + |
| 133 | + # Add extra fields |
| 134 | + message['@fields'].update(self.get_extra_fields(record)) |
| 135 | + |
| 136 | + # Add extra tags |
| 137 | + if self.extra_tags: |
| 138 | + message['@tags'].extend(self.extra_tags) |
| 139 | + |
| 140 | + # If exception, add debug info |
| 141 | + if record.exc_info or record.exc_text: |
| 142 | + message['@fields'].update(self.get_debug_fields(record)) |
| 143 | + |
| 144 | + return self.serialize(message, indent=self.indent) |
| 145 | + |
| 146 | + |
| 147 | +class LogstashFormatterV1(JSONFormatter): |
| 148 | + def format(self, record): |
| 149 | + # Create message dict |
| 150 | + message = { |
| 151 | + '@timestamp': self.format_timestamp(record.created), |
| 152 | + '@version': 1, |
| 153 | + 'message': record.getMessage(), |
| 154 | + 'host': self.host, |
| 155 | + 'path': record.pathname, |
| 156 | + 'tags': self.tags[:], |
| 157 | + 'type': self.message_type, |
| 158 | + |
| 159 | + # Extra Fields |
| 160 | + 'levelname': record.levelname, |
| 161 | + 'logger': record.name, |
| 162 | + } |
| 163 | + |
| 164 | + # Add extra fields |
| 165 | + message.update(self.get_extra_fields(record)) |
| 166 | + |
| 167 | + # Add extra tags |
| 168 | + if self.extra_tags: |
| 169 | + message['tags'].extend(self.extra_tags) |
| 170 | + |
| 171 | + # If exception, add debug info |
| 172 | + if record.exc_info or record.exc_text: |
| 173 | + message.update(self.get_debug_fields(record)) |
| 174 | + |
| 175 | + return self.serialize(message, indent=self.indent) |
0 commit comments