feat: logging now uses breadcrumbs like rust sdk

untitaker · untitaker · commit a67cddbfcf53 · 2018-07-22T21:01:16.000+02:00
diff --git a/sentry_sdk/hub.py b/sentry_sdk/hub.py
@@ -152,9 +152,9 @@ def add_breadcrumb(self, crumb):
         if callable(crumb):
             crumb = crumb()
         if crumb is not None:
-            scope.breadcrumbs.append(crumb)
-        while len(scope.breadcrumbs) >= client.options['max_breadcrumbs']:
-            scope.breadcrumbs.popleft()
+            scope._breadcrumbs.append(crumb)
+        while len(scope._breadcrumbs) >= client.options['max_breadcrumbs']:
+            scope._breadcrumbs.popleft()
 
     def add_event_processor(self, factory):
         """Registers a new event processor with the top scope."""
diff --git a/sentry_sdk/integrations/logging.py b/sentry_sdk/integrations/logging.py
@@ -3,7 +3,7 @@
 
 import logging
 
-from sentry_sdk import get_current_hub, capture_event
+from sentry_sdk import get_current_hub, capture_event, add_breadcrumb
 from sentry_sdk.utils import to_string, create_event, exceptions_from_error_tuple, skip_internal_frames
 
 class SentryHandler(logging.Handler, object):
@@ -17,7 +17,20 @@ def emit(self, record):
     def can_record(self, record):
         return not record.name.startswith('sentry_sdk')
 
+    def _breadcrumb_from_record(self, record):
+        return {
+            'ty': 'log',
+            'level': self._logging_to_event_level(record.levelname),
+            'category': record.name,
+            'message': record.message
+        }
+
     def _emit(self, record):
+        add_breadcrumb(self._breadcrumb_from_record(record))
+
+        if not self._should_create_event(record):
+            return
+
         if not self.can_record(record):
             print(to_string(record.message), file=sys.stderr)
             return
@@ -32,7 +45,7 @@ def _emit(self, record):
                 get_current_hub().client.options['with_locals']
             )
 
-        event['level'] = record.levelname.lower()
+        event['level'] = self._logging_to_event_level(record.levelname)
         event['logger'] = record.name
 
         event['logentry'] = {
@@ -42,5 +55,16 @@ def _emit(self, record):
 
         capture_event(event)
 
+    def _logging_to_event_level(self, levelname):
+        return {
+            'critical': 'fatal'
+        }.get(levelname.lower(), levelname.lower())
+
+    def _should_create_event(self, record):
+        # TODO: make configurable
+        if record.levelno in (logging.ERROR, logging.CRITICAL):
+            return True
+        return False
+
 
 HANDLER = SentryHandler()
diff --git a/tests/integrations/conftest.py b/tests/integrations/conftest.py
@@ -1,13 +1,14 @@
 import pytest
 import sentry_sdk
+from sentry_sdk.consts import DEFAULT_OPTIONS
 from sentry_sdk.client import Client, Transport
 
 class TestClient(Client):
     def __init__(self):
         pass
 
     dsn = 'LOL'
-    options = {'with_locals': False, 'release': 'fake_release', 'environment': 'fake_environment', 'server_name': 'fake_servername'}
+    options = dict(DEFAULT_OPTIONS)
     _transport = None
 
 
diff --git a/tests/integrations/logging/test_logging.py b/tests/integrations/logging/test_logging.py
@@ -8,10 +8,11 @@
 logger.handlers = [HANDLER]
 logger.setLevel(logging.DEBUG)
 
-@pytest.mark.parametrize('level', ['info', 'debug', 'warning', 'error'])
-def test_logging(capture_events, level):
-    getattr(logger, level)('LOL')
+def test_logging(capture_events):
+    logger.info('bread')
+    logger.critical('LOL')
     event, = capture_events
-    assert event['level'] == level
+    assert event['level'] == 'fatal'
     assert not event['logentry']['params']
     assert event['logentry']['message'] == 'LOL'
+    assert event['breadcrumbs'][0]['message'] == 'bread'
