Allow to rename standard field names

schlitzered · schlitzered · commit faba0c270bb3 · 2020-10-04T14:56:25.000+02:00
diff --git a/src/pythonjsonlogger/jsonlogger.py b/src/pythonjsonlogger/jsonlogger.py
@@ -88,6 +88,8 @@ def __init__(self, *args, **kwargs):
             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 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
@@ -104,6 +106,7 @@ def __init__(self, *args, **kwargs):
         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", {})
         reserved_attrs = kwargs.pop("reserved_attrs", RESERVED_ATTRS)
         self.reserved_attrs = dict(zip(reserved_attrs, reserved_attrs))
         self.timestamp = kwargs.pop("timestamp", False)
@@ -148,7 +151,10 @@ def add_fields(self, log_record, record, message_dict):
         Override this method to implement custom logic for adding fields.
         """
         for field in self._required_fields:
-            log_record[field] = record.__dict__.get(field)
+            if field in self.rename_fields:
+                log_record[self.rename_fields[field]] = record.__dict__.get(field)
+            else:
+                log_record[field] = record.__dict__.get(field)
         log_record.update(message_dict)
         merge_record_extra(record, log_record, reserved=self._skip_fields)
 
diff --git a/tests/tests.py b/tests/tests.py
@@ -42,6 +42,16 @@ def testDefaultFormat(self):
 
         self.assertEqual(logJson["message"], msg)
 
+    def testRenameBaseField(self):
+        fr = jsonlogger.JsonFormatter(rename_fields={'message': '@message'})
+        self.logHandler.setFormatter(fr)
+
+        msg = "testing logging format"
+        self.logger.info(msg)
+        logJson = json.loads(self.buffer.getvalue())
+
+        self.assertEqual(logJson["@message"], msg)
+
     def testFormatKeys(self):
         supported_keys = [
             'asctime',
