Allow dict-style logging in breadcrumbs processing

Author: rakai93

raven/breadcrumbs.py

@@ -1,5 +1,6 @@
 from __future__ import absolute_import
 
+import collections
 import os
 import logging
 
@@ -132,13 +133,23 @@ def _record_log_breadcrumb(logger, level, msg, *args, **kwargs):
 
     def processor(data):
         formatted_msg = msg
+        format_args = args
+
+        # Extract 'extra' key from kwargs and merge into data
+        extra = kwargs.pop('extra', {})
+        data_value = kwargs
+        data_value.update(extra)
+
+        if args and len(args) == 1 and isinstance(args[0], collections.Mapping) and args[0]:
+            format_args = args[0]
+            data_value.update(format_args)
 
         # If people log bad things, this can happen.  Then just don't do
         # anything.
         try:
             formatted_msg = text_type(msg)
-            if args:
-                formatted_msg = msg % args
+            if format_args:
+                formatted_msg = msg % format_args
         except Exception:
             pass
 
@@ -151,7 +162,7 @@ def processor(data):
             'message': formatted_msg,
             'category': logger.name,
             'level': logging.getLevelName(level).lower(),
-            'data': kwargs,
+            'data': data_value,
         })
     record(processor=processor)
 

tests/breadcrumbs/tests.py

@@ -39,6 +39,20 @@ def test_log_crumb_reporting(self):
         assert crumbs[0]['data'] == {'blah': 'baz'}
         assert crumbs[0]['message'] == 'This is a message with foo!'
 
+    def test_log_crumb_reporting_with_dict(self):
+        client = Client('http://foo:[email protected]/0')
+        with client.context:
+            log = logging.getLogger('whatever.foo')
+            log.info('This is a message with %(foo)s!', {'foo': 'bar'},
+                     extra={'blah': 'baz'})
+            crumbs = client.context.breadcrumbs.get_buffer()
+
+        assert len(crumbs) == 1
+        assert crumbs[0]['type'] == 'default'
+        assert crumbs[0]['category'] == 'whatever.foo'
+        assert crumbs[0]['data'] == {'foo': 'bar', 'blah': 'baz'}
+        assert crumbs[0]['message'] == 'This is a message with bar!'
+
     def test_log_crumb_reporting_with_large_message(self):
         client = Client('http://foo:[email protected]/0')
         with client.context: