Merge branch 'master' into ensure_ascii

Author: madzak

README.markdown

@@ -25,7 +25,7 @@ Usage
 
 ## Integrating with Python's logging framework
 
-Json outputs are provided by the JsonFormatter logging formatter. You can add the customer formatter like below:
+Json outputs are provided by the JsonFormatter logging formatter. You can add the custom formatter like below:
 
 **Please note: version 0.1.0 has changed the import structure, please update to the following example for proper importing**
 
@@ -63,7 +63,7 @@ You can also add extra fields to your json output by specifying a dict in place
 
 Contents of these dictionaries will be added at the root level of the entry and may override basic fields.
 
-You can also use the `add_fields` method to add to or generally normalize the set of default set of fields, it is be called for every log event. For example, to unify default fields with those provided by [structlog](http://www.structlog.org/) you could do something like this:
+You can also use the `add_fields` method to add to or generally normalize the set of default set of fields, it is called for every log event. For example, to unify default fields with those provided by [structlog](http://www.structlog.org/) you could do something like this:
 
 ```python
 class CustomJsonFormatter(jsonlogger.JsonFormatter):

debian/changelog

@@ -0,0 +1,5 @@
+python3-jsonlogger (0.1.8-1) stable; urgency=medium
+
+  * Initial release.
+
+ -- Maximilian Wilhelm <max@sdn.clinic>  Wed, 07 Feb 2018 22:12:07 +0100

debian/compat

@@ -0,0 +1 @@
+9

debian/control

@@ -0,0 +1,19 @@
+Source: python3-jsonlogger
+Section: python
+Priority: optional
+Maintainer: Maximilian Wilhelm <max@sdn.clinic>
+Build-Depends: debhelper (>= 9), dh-python, dh-systemd,
+               python3-all,
+               python3-setuptools,
+               python3-pbr
+Standards-Version: 3.9.5
+Homepage: https://github.com/madzak/python-json-logger
+X-Python3-Version: >= 3.2
+
+Package: python3-jsonlogger
+Architecture: all
+Depends: ${python3:Depends}, ${misc:Depends}
+Description: JSON library for Python logging framework
+ This library is provided to allow standard python logging to output log data
+ as json objects. With JSON we can make our logs more readable by machines
+ and we can stop writing custom parsers for syslog type records.

debian/copyright

@@ -0,0 +1,33 @@
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Upstream-Name: python-json-logger
+Source: https://github.com/madzak/python-json-logger
+
+Files: *
+Copyright: 2011-2018 Zakaria Zajac <madzak42@gmail.com>
+License: BSD-2-Clause
+
+Files: debian/*
+Copyright: 2018 Maximilian Wilhelm <max@sdn.clinic>
+License: BSD-2-Clause
+
+License: BSD-2-Clause
+ Redistribution and use in source and binary forms, with or without
+ modification, are permitted provided that the following conditions
+ are met:
+ 1. Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+ 2. Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in the
+    documentation and/or other materials provided with the distribution.
+ .
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE HOLDERS OR
+ CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

debian/rules

@@ -0,0 +1,17 @@
+#!/usr/bin/make -f
+# See debhelper(7) (uncomment to enable)
+# output every command that modifies files on the build system.
+#DH_VERBOSE = 1
+
+# see EXAMPLES in dpkg-buildflags(1) and read /usr/share/dpkg/*
+DPKG_EXPORT_BUILDFLAGS = 1
+include /usr/share/dpkg/default.mk
+
+export PBR_VERSION=0.5.5
+
+# main packaging script based on dh7 syntax
+%:
+	dh $@ --with python3 --buildsystem=pybuild
+
+override_dh_auto_install:
+	dh_auto_install -O--buildsystem=pybuild

debian/source/format

@@ -0,0 +1 @@
+3.0 (quilt)

setup.py

@@ -32,6 +32,8 @@
         'Programming Language :: Python :: 3.2',
         'Programming Language :: Python :: 3.3',
         'Programming Language :: Python :: 3.4',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
         'Topic :: System :: Logging',
     ]
 )

src/pythonjsonlogger/jsonlogger.py

@@ -5,7 +5,7 @@
 import logging
 import json
 import re
-import datetime
+from datetime import date, datetime, time
 import traceback
 
 from inspect import istraceback
@@ -24,10 +24,8 @@
     'msecs', 'message', 'msg', 'name', 'pathname', 'process',
     'processName', 'relativeCreated', 'stack_info', 'thread', 'threadName')
 
-RESERVED_ATTR_HASH = dict(zip(RESERVED_ATTRS, RESERVED_ATTRS))
 
-
-def merge_record_extra(record, target, reserved=RESERVED_ATTR_HASH):
+def merge_record_extra(record, target, reserved):
     """
     Merges extra attributes from LogRecord object into target dictionary
 
@@ -44,6 +42,36 @@ def merge_record_extra(record, target, reserved=RESERVED_ATTR_HASH):
     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.
@@ -58,35 +86,39 @@ def __init__(self, *args, **kwargs):
         :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 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 = kwargs.pop("json_default", None)
         self.json_encoder = kwargs.pop("json_encoder", None)
         self.json_serializer = 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", "")
+        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:
-            def _default_json_handler(obj):
-                '''Prints dates in ISO format'''
-                if isinstance(obj, (datetime.date, datetime.time)):
-                    return obj.isoformat()
-                elif istraceback(obj):
-                    tb = ''.join(traceback.format_tb(obj))
-                    return tb.strip()
-                elif isinstance(obj, Exception):
-                    return "Exception: %s" % str(obj)
-                return str(obj)
-            self.json_default = _default_json_handler
+            self.json_encoder = JsonEncoder
+
         self._required_fields = self.parse()
         self._skip_fields = dict(zip(self._required_fields,
                                      self._required_fields))
-        self._skip_fields.update(RESERVED_ATTR_HASH)
+        self._skip_fields.update(self.reserved_attrs)
 
     def parse(self):
         """
@@ -107,6 +139,10 @@ def add_fields(self, log_record, record, message_dict):
         log_record.update(message_dict)
         merge_record_extra(record, log_record, reserved=self._skip_fields)
 
+        if self.timestamp:
+            key = self.timestamp if type(self.timestamp) == str else 'timestamp'
+            log_record[key] = datetime.utcnow()
+
     def process_log_record(self, log_record):
         """
         Override this method to implement custom logic