Merge 1b1d20d into 436f008

README.rst

@@ -209,6 +209,7 @@ module.
     })
     l.info('{"from": "userC", "to": "userD"}')
     l.info("This log entry will be logged with the additional key: 'message'.")
+    l.info("This log entry will be enriched with extra data.", extra={'user_id': 1})
 
 You can also customize formatter via logging.config.dictConfig
 

fluent/handler.py

@@ -77,6 +77,7 @@ def __init__(self, fmt=None, datefmt=None, style='%', fill_missing_fmt_key=False
             else:
                 if hasattr(fmt, "__call__"):
                     self._formatter = fmt
+                    self._fmt_dict = None
                     self.usesTime = fmt.usesTime
                 else:
                     self._fmt_dict = fmt
@@ -101,9 +102,40 @@ def format(self, record):
         # Apply format
         data = self._formatter(record)
 
+        # Add extra data
+        extra = self._get_extra_fields(record)
+        if extra:
+            data['extra'] = extra
+
         self._structuring(data, record)
         return data
 
+    def _get_extra_fields(self, record):
+        """
+        Method based on:
+        https://github.com/vklochan/python-logstash/blob/master/logstash/formatter.py#L23
+        """
+        # The list contains all the attributes listed in
+        # http://docs.python.org/library/logging.html#logrecord-attributes
+        skip_list = (
+            'args', 'asctime', 'created', 'exc_info', 'exc_text', 'filename',
+            'funcName', 'id', 'levelname', 'levelno', 'lineno', 'module',
+            'msecs', 'msecs', 'message', 'msg', 'name', 'pathname', 'process',
+            'processName', 'relativeCreated', 'stack_info', 'thread', 'threadName',
+            'extra', 'auth_token', 'password', 'hostname', )
+
+        easy_types = (str, bool, dict, float, int, list, type(None))
+
+        fields = {}
+        fmt_dict = self._fmt_dict or {}
+        for key, value in record.__dict__.items():
+            if key not in skip_list and key not in fmt_dict:
+                if isinstance(value, easy_types):
+                    fields[key] = value
+                else:
+                    fields[key] = repr(value)
+        return fields
+
     def usesTime(self):
         """This method is substituted on construction based on settings for performance reasons"""
 

tests/test_handler.py

@@ -371,3 +371,19 @@ def test_exception_message(self):
         self.assertTrue('it failed' in message)
         self.assertTrue('tests/test_handler.py", line' in message)
         self.assertTrue('Exception: sample exception' in message)
+
+    def test_extra_data(self):
+        handler = fluent.handler.FluentHandler('app.follow', port=self._port)
+
+        with handler:
+            logging.basicConfig(level=logging.INFO)
+            log = logging.getLogger('fluent.test')
+            handler.setFormatter(fluent.handler.FluentRecordFormatter())
+            log.addHandler(handler)
+            log.info("Sample log massage", extra={'user_id': 1})
+            log.removeHandler(handler)
+
+        data = self.get_data()
+        eq = self.assertEqual
+        eq("Sample log massage", data[0][2]['message'])
+        eq({'user_id': 1}, data[0][2]['extra'])