before_send_log, compat tests

Author: sentrivana

sentry_sdk/client.py

@@ -37,7 +37,7 @@
 )
 from sentry_sdk.integrations import _DEFAULT_INTEGRATIONS, setup_integrations
 from sentry_sdk.integrations.dedupe import DedupeIntegration
-from sentry_sdk.logger import has_logs_enabled
+from sentry_sdk.logger import has_logs_enabled, get_before_send_log
 from sentry_sdk.sessions import SessionFlusher
 from sentry_sdk.envelope import Envelope
 from sentry_sdk.profiler.continuous_profiler import setup_continuous_profiler
@@ -955,7 +955,7 @@ def _capture_experimental_log(self, log):
                 f'[Sentry Logs] [{log.get("severity_text")}] {log.get("body")}'
             )
 
-        before_send_log = self.options["_experiments"].get("before_send_log")
+        before_send_log = get_before_send_log(self.options)
         if before_send_log is not None:
             log = before_send_log(log, {})
         if log is None:

sentry_sdk/consts.py

@@ -799,6 +799,7 @@ def __init__(
         add_full_stack=DEFAULT_ADD_FULL_STACK,  # type: bool
         max_stack_frames=DEFAULT_MAX_STACK_FRAMES,  # type: Optional[int]
         enable_logs=False,  # type: bool
+        before_send_log=None,  # type: Optional[Callable[[Log, Hint], Optional[Log]]]
     ):
         # type: (...) -> None
         """Initialize the Sentry SDK with the given parameters. All parameters described here can be used in a call to `sentry_sdk.init()`.

sentry_sdk/logger.py

@@ -1,10 +1,11 @@
 # NOTE: this is the logger sentry exposes to users, not some generic logger.
 import functools
 import time
-from typing import Any, Optional
+from typing import Any, Callable, Optional
 
 from sentry_sdk import get_client
 from sentry_sdk.utils import safe_repr
+from sentry_sdk.types import Log, Hint
 
 OTEL_RANGES = [
     # ((severity level range), severity text)
@@ -92,3 +93,13 @@ def has_logs_enabled(options):
         options.get("enable_logs", False)
         or options["_experiments"].get("enable_logs", False)
     )
+
+
+def get_before_send_log(options):
+    # type: (Optional[dict[str, Any]]) -> Optional[Callable[[Log, Hint], Optional[Log]]]
+    if options is None:
+        return None
+
+    return options.get("before_send_log") or options["_experiments"].get(
+        "before_send_log"
+    )

tests/test_logs.py

@@ -111,11 +111,29 @@ def test_logs_basics(sentry_init, capture_envelopes):
     assert logs[5].get("severity_number") == 21
 
 
+@minimum_python_37
+def test_logs_experimental_option_still_works(sentry_init, capture_envelopes):
+    sentry_init(_experiments={"enable_logs": True})
+    envelopes = capture_envelopes()
+
+    sentry_sdk.logger.error("This is an error log...")
+
+    get_client().flush()
+
+    logs = envelopes_to_logs(envelopes)
+    assert len(logs) == 1
+
+    assert logs[0].get("severity_text") == "error"
+    assert logs[0].get("severity_number") == 17
+
+
 @minimum_python_37
 def test_logs_before_send_log(sentry_init, capture_envelopes):
-    before_log_called = [False]
+    before_log_called = False
 
     def _before_log(record, hint):
+        nonlocal before_log_called
+
         assert set(record.keys()) == {
             "severity_text",
             "severity_number",
@@ -128,15 +146,13 @@ def _before_log(record, hint):
         if record["severity_text"] in ["fatal", "error"]:
             return None
 
-        before_log_called[0] = True
+        before_log_called = True
 
         return record
 
     sentry_init(
-        _experiments={
-            "enable_logs": True,
-            "before_send_log": _before_log,
-        }
+        enable_logs=True,
+        before_send_log=_before_log,
     )
     envelopes = capture_envelopes()
 
@@ -155,7 +171,37 @@ def _before_log(record, hint):
     assert logs[1]["severity_text"] == "debug"
     assert logs[2]["severity_text"] == "info"
     assert logs[3]["severity_text"] == "warn"
-    assert before_log_called[0]
+    assert before_log_called is True
+
+
+@minimum_python_37
+def test_logs_before_send_log_experimental_option_still_works(
+    sentry_init, capture_envelopes
+):
+    before_log_called = False
+
+    def _before_log(record, hint):
+        nonlocal before_log_called
+        before_log_called = True
+
+        return record
+
+    sentry_init(
+        enable_logs=True,
+        _experiments={
+            "before_send_log": _before_log,
+        },
+    )
+    envelopes = capture_envelopes()
+
+    sentry_sdk.logger.error("This is an error log...")
+
+    get_client().flush()
+    logs = envelopes_to_logs(envelopes)
+    assert len(logs) == 1
+
+    assert logs[0]["severity_text"] == "error"
+    assert before_log_called is True
 
 
 @minimum_python_37