Merge branch 'master' into potel-base

Author: sentrivana

sentry_sdk/client.py

@@ -22,6 +22,8 @@
     get_default_release,
     handle_in_app,
     logger,
+    get_before_send_log,
+    has_logs_enabled,
 )
 from sentry_sdk.serializer import serialize
 from sentry_sdk.tracing import trace
@@ -322,9 +324,9 @@ def _capture_envelope(envelope: Envelope) -> None:
 
             self.session_flusher = SessionFlusher(capture_func=_capture_envelope)
 
-            experiments = self.options.get("_experiments", {})
             self.log_batcher = None
-            if experiments.get("enable_logs", False):
+
+            if has_logs_enabled(self.options):
                 from sentry_sdk._log_batcher import LogBatcher
 
                 self.log_batcher = LogBatcher(capture_func=_capture_envelope)
@@ -820,9 +822,8 @@ def capture_event(
 
         return return_value
 
-    def _capture_experimental_log(self, log: Log) -> None:
-        logs_enabled = self.options["_experiments"].get("enable_logs", False)
-        if not logs_enabled:
+    def _capture_experimental_log(self, log: Optional[Log]) -> None:
+        if not has_logs_enabled(self.options) or log is None:
             return
 
         current_scope = sentry_sdk.get_current_scope()
@@ -877,9 +878,10 @@ def _capture_experimental_log(self, log: Log) -> None:
                 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:
             return
 

sentry_sdk/consts.py

@@ -854,6 +854,8 @@ def __init__(
         custom_repr: Optional[Callable[..., Optional[str]]] = None,
         add_full_stack: bool = DEFAULT_ADD_FULL_STACK,
         max_stack_frames: Optional[int] = DEFAULT_MAX_STACK_FRAMES,
+        enable_logs: bool = False,
+        before_send_log: Optional[Callable[[Log, Hint], Optional[Log]]] = None,
     ) -> None:
         """Initialize the Sentry SDK with the given parameters. All parameters described here can be used in a call to `sentry_sdk.init()`.
 
@@ -1240,6 +1242,14 @@ def __init__(
 
         :param instrumenter:
 
+        :param enable_logs: Set `enable_logs` to True to enable the SDK to emit
+            Sentry logs. Defaults to False.
+
+        :param before_send_log: An optional function to modify or filter out logs
+            before they're sent to Sentry. Any modifications to the log in this
+            function will be retained. If the function returns None, the log will
+            not be sent to Sentry.
+
         :param _experiments:
         """
         pass

sentry_sdk/integrations/logging.py

@@ -13,6 +13,7 @@
     event_from_exception,
     current_stacktrace,
     capture_internal_exceptions,
+    has_logs_enabled,
 )
 from sentry_sdk.integrations import Integration
 
@@ -336,7 +337,7 @@ def emit(self, record: LogRecord) -> Any:
             if not client.is_active():
                 return
 
-            if not client.options["_experiments"].get("enable_logs", False):
+            if not has_logs_enabled(client.options):
                 return
 
             self._capture_log_from_record(client, record)

sentry_sdk/integrations/loguru.py

@@ -9,6 +9,7 @@
     _BaseHandler,
 )
 from sentry_sdk.logger import _log_level_to_otel
+from sentry_sdk.utils import has_logs_enabled
 
 from typing import TYPE_CHECKING
 
@@ -147,7 +148,7 @@ def loguru_sentry_logs_handler(message: Message) -> None:
     if not client.is_active():
         return
 
-    if not client.options["_experiments"].get("enable_logs", False):
+    if not has_logs_enabled(client.options):
         return
 
     record = message.record

sentry_sdk/utils.py

@@ -59,7 +59,7 @@
     from gevent.hub import Hub as GeventHub
     from opentelemetry.util.types import AttributeValue
 
-    from sentry_sdk._types import Event, ExcInfo
+    from sentry_sdk._types import Event, ExcInfo, Log, Hint
 
     P = ParamSpec("P")
     R = TypeVar("R")
@@ -1919,3 +1919,24 @@ def serialize_item(item):
         return json.dumps(serialized, default=str)
     except Exception:
         return str(data)
+
+
+def has_logs_enabled(options):
+    # type: (Optional[dict[str, Any]]) -> bool
+    if options is None:
+        return False
+
+    return bool(
+        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/integrations/logging/test_logging.py

@@ -357,7 +357,7 @@ def test_sentry_logs_warning(sentry_init, capture_envelopes):
     """
     The python logger module should create 'warn' sentry logs if the flag is on.
     """
-    sentry_init(_experiments={"enable_logs": True})
+    sentry_init(enable_logs=True)
     envelopes = capture_envelopes()
 
     python_logger = logging.Logger("test-logger")
@@ -382,7 +382,7 @@ def test_sentry_logs_debug(sentry_init, capture_envelopes):
     """
     The python logger module should not create 'debug' sentry logs if the flag is on by default
     """
-    sentry_init(_experiments={"enable_logs": True})
+    sentry_init(enable_logs=True)
     envelopes = capture_envelopes()
 
     python_logger = logging.Logger("test-logger")
@@ -397,7 +397,7 @@ def test_no_log_infinite_loop(sentry_init, capture_envelopes):
     If 'debug' mode is true, and you set a low log level in the logging integration, there should be no infinite loops.
     """
     sentry_init(
-        _experiments={"enable_logs": True},
+        enable_logs=True,
         integrations=[LoggingIntegration(sentry_logs_level=logging.DEBUG)],
         debug=True,
     )
@@ -414,7 +414,7 @@ def test_logging_errors(sentry_init, capture_envelopes):
     """
     The python logger module should be able to log errors without erroring
     """
-    sentry_init(_experiments={"enable_logs": True})
+    sentry_init(enable_logs=True)
     envelopes = capture_envelopes()
 
     python_logger = logging.Logger("test-logger")
@@ -449,7 +449,7 @@ def test_log_strips_project_root(sentry_init, capture_envelopes):
     The python logger should strip project roots from the log record path
     """
     sentry_init(
-        _experiments={"enable_logs": True},
+        enable_logs=True,
         project_root="/custom/test",
     )
     envelopes = capture_envelopes()
@@ -478,7 +478,7 @@ def test_logger_with_all_attributes(sentry_init, capture_envelopes):
     """
     The python logger should be able to log all attributes, including extra data.
     """
-    sentry_init(_experiments={"enable_logs": True})
+    sentry_init(enable_logs=True)
     envelopes = capture_envelopes()
 
     python_logger = logging.Logger("test-logger")
@@ -551,7 +551,7 @@ def test_sentry_logs_named_parameters(sentry_init, capture_envelopes):
     """
     The python logger module should capture named parameters from dictionary arguments in Sentry logs.
     """
-    sentry_init(_experiments={"enable_logs": True})
+    sentry_init(enable_logs=True)
     envelopes = capture_envelopes()
 
     python_logger = logging.Logger("test-logger")
@@ -596,7 +596,7 @@ def test_sentry_logs_named_parameters_complex_values(sentry_init, capture_envelo
     """
     The python logger module should handle complex values in named parameters using safe_repr.
     """
-    sentry_init(_experiments={"enable_logs": True})
+    sentry_init(enable_logs=True)
     envelopes = capture_envelopes()
 
     python_logger = logging.Logger("test-logger")

tests/integrations/loguru/test_loguru.py

@@ -141,7 +141,7 @@ def test_sentry_logs_warning(
     uninstall_integration("loguru")
     request.addfinalizer(logger.remove)
 
-    sentry_init(_experiments={"enable_logs": True})
+    sentry_init(enable_logs=True)
     envelopes = capture_envelopes()
 
     logger.warning("this is {} a {}", "just", "template")
@@ -165,7 +165,7 @@ def test_sentry_logs_debug(
     uninstall_integration("loguru")
     request.addfinalizer(logger.remove)
 
-    sentry_init(_experiments={"enable_logs": True})
+    sentry_init(enable_logs=True)
     envelopes = capture_envelopes()
 
     logger.debug("this is %s a template %s", "1", "2")
@@ -182,7 +182,7 @@ def test_sentry_log_levels(
 
     sentry_init(
         integrations=[LoguruIntegration(sentry_logs_level=LoggingLevels.SUCCESS)],
-        _experiments={"enable_logs": True},
+        enable_logs=True,
     )
     envelopes = capture_envelopes()
 
@@ -216,7 +216,7 @@ def test_disable_loguru_logs(
 
     sentry_init(
         integrations=[LoguruIntegration(sentry_logs_level=None)],
-        _experiments={"enable_logs": True},
+        enable_logs=True,
     )
     envelopes = capture_envelopes()
 
@@ -267,7 +267,7 @@ def test_no_log_infinite_loop(
     request.addfinalizer(logger.remove)
 
     sentry_init(
-        _experiments={"enable_logs": True},
+        enable_logs=True,
         integrations=[LoguruIntegration(sentry_logs_level=LoggingLevels.DEBUG)],
         debug=True,
     )
@@ -284,7 +284,7 @@ def test_logging_errors(sentry_init, capture_envelopes, uninstall_integration, r
     uninstall_integration("loguru")
     request.addfinalizer(logger.remove)
 
-    sentry_init(_experiments={"enable_logs": True})
+    sentry_init(enable_logs=True)
     envelopes = capture_envelopes()
 
     logger.error(Exception("test exc 1"))
@@ -313,7 +313,7 @@ def test_log_strips_project_root(
     request.addfinalizer(logger.remove)
 
     sentry_init(
-        _experiments={"enable_logs": True},
+        enable_logs=True,
         project_root="/custom/test",
     )
     envelopes = capture_envelopes()
@@ -362,7 +362,7 @@ def test_log_keeps_full_path_if_not_in_project_root(
     request.addfinalizer(logger.remove)
 
     sentry_init(
-        _experiments={"enable_logs": True},
+        enable_logs=True,
         project_root="/custom/test",
     )
     envelopes = capture_envelopes()
@@ -410,7 +410,7 @@ def test_logger_with_all_attributes(
     uninstall_integration("loguru")
     request.addfinalizer(logger.remove)
 
-    sentry_init(_experiments={"enable_logs": True})
+    sentry_init(enable_logs=True)
     envelopes = capture_envelopes()
 
     logger.warning("log #{}", 1)