feat: magic logging config

Author: untitaker

sentry_sdk/integrations/__init__.py

@@ -43,3 +43,10 @@ def _celery_integration(*a, **kw):
     from .celery import install
 
     return install(*a, **kw)
+
+
+@register_integration('logging')
+def _logging_integration(*a, **kw):
+    from .logging import install
+
+    return install(*a, **kw)

sentry_sdk/integrations/logging.py

@@ -3,11 +3,37 @@
 
 import sys
 import logging
+from threading import Lock
 
 from sentry_sdk import get_current_hub, capture_event, add_breadcrumb
 from sentry_sdk.utils import to_string, Event, skip_internal_frames
 
 
+_installer_lock = Lock()
+_installed = False
+_master_handler = None
+
+def install(client):
+    global _installed
+    global _master_handler
+    with _installer_lock:
+        if _installed:
+            return
+
+        _master_handler = SentryHandler()
+        _master_handler.setLevel(logging.INFO) # TODO: make configurable
+
+        old_callhandlers = logging.Logger.callHandlers
+
+        def sentry_patched_callhandlers(self, record):
+            _master_handler.handle(record)
+            return old_callhandlers(self, record)
+
+        logging.Logger.callHandlers = sentry_patched_callhandlers
+
+        _installed = True
+
+
 class SentryHandler(logging.Handler, object):
     def emit(self, record):
         try:

tests/integrations/flask/test_flask.py

@@ -14,7 +14,7 @@
 from sentry_sdk.integrations.logging import SentryHandler
 import sentry_sdk.integrations.flask as flask_sentry
 
-get_current_hub().bind_client(Client(integrations=["flask"]))
+get_current_hub().bind_client(Client(integrations=["flask", "logging"]))
 login_manager = LoginManager()
 
 
@@ -23,11 +23,6 @@ def app():
     app = Flask(__name__)
     app.config["TESTING"] = True
     app.secret_key = "haha"
-    app.logger.setLevel(logging.DEBUG)
-    handler = SentryHandler()
-    handler.setLevel(logging.DEBUG)
-    app.logger.handlers = []
-    app.logger.addHandler(handler)
 
     login_manager.init_app(app)
 
@@ -273,6 +268,8 @@ def index():
 
 
 def test_logging(capture_events, app):
+    # ensure that Flask's logger magic doesn't break ours
+
     @app.route("/")
     def index():
         app.logger.error("hi")

tests/integrations/logging/test_logging.py

@@ -1,21 +1,23 @@
+import pytest
 import logging
 
 import sentry_sdk
-from sentry_sdk.integrations.logging import SentryHandler
 
-logger = logging.getLogger(__name__)
+other_logger = logging.getLogger("testfoo")
+other_logger.setLevel(logging.DEBUG)
 
-logger.handlers = [SentryHandler()]
-logger.setLevel(logging.DEBUG)
+sentry_sdk.get_current_hub().bind_client(sentry_sdk.Client(integrations=['logging']))
 
-sentry_sdk.get_current_hub().bind_client(sentry_sdk.Client())
+logger = logging.getLogger(__name__)
+logger.setLevel(logging.DEBUG)
 
 
-def test_logging(capture_events):
+@pytest.mark.parametrize("logger", [logger, other_logger])
+def test_logging(capture_events, logger):
     logger.info("bread")
     logger.critical("LOL")
     event, = capture_events
     assert event["level"] == "fatal"
     assert not event["logentry"]["params"]
     assert event["logentry"]["message"] == "LOL"
-    assert event["breadcrumbs"][0]["message"] == "bread"
+    assert any(crumb["message"] == "bread" for crumb in event['breadcrumbs'])