feat: Add support to disable log collection.

Disabling log spans collection at the tracer level to prevent duplication in the backend when both the application tracer and an OpenTelemetry collector are running on the same system.

Signed-off-by: Paulo Vital <[email protected]>

Author: pvital

src/instana/instrumentation/logging.py

@@ -10,6 +10,7 @@
 import wrapt
 
 from instana.log import logger
+from instana.singletons import agent
 from instana.util.runtime import get_runtime_env_info
 from instana.util.traceutils import get_tracer_tuple, tracing_is_off
 
@@ -27,12 +28,18 @@ def log_with_instana(
 
     # We take into consideration if `stacklevel` is already present in `kwargs`.
     # This prevents the error `_log() got multiple values for keyword argument 'stacklevel'`
-    stacklevel_in = kwargs.pop("stacklevel", 1 if get_runtime_env_info()[0] not in ["ppc64le", "s390x"] else 2)
+    stacklevel_in = kwargs.pop(
+        "stacklevel", 1 if get_runtime_env_info()[0] not in ["ppc64le", "s390x"] else 2
+    )
     stacklevel = stacklevel_in + 1 + (sys.version_info >= (3, 14))
 
     try:
-        # Only needed if we're tracing and serious log
-        if tracing_is_off() or argv[0] < logging.WARN:
+        # Only needed if we're tracing and serious log and logging spans are not disabled
+        if (
+            tracing_is_off()
+            or argv[0] < logging.WARN
+            or agent.options.is_span_disabled(category="logging")
+        ):
             return wrapped(*argv, **kwargs, stacklevel=stacklevel)
 
         tracer, parent_span, _ = get_tracer_tuple()

tests/clients/test_logging.py

@@ -70,7 +70,7 @@ def test_parameters(self) -> None:
             try:
                 a = 42
                 b = 0
-                c = a / b
+                c = a / b  # noqa: F841
             except Exception as e:
                 self.logger.exception("Exception: %s", str(e))
 
@@ -168,3 +168,78 @@ def main():
         assert spans[0].k is SpanKind.CLIENT
 
         assert spans[0].data["log"].get("message") == "foo bar"
+
+
+class TestLoggingDisabling:
+    @pytest.fixture(autouse=True)
+    def _resource(self) -> Generator[None, None, None]:
+        # Setup
+        self.recorder = tracer.span_processor
+        self.recorder.clear_spans()
+        self.logger = logging.getLogger("unit test")
+
+        # Save original options
+        self.original_options = agent.options
+
+        yield
+
+        # Teardown
+        agent.options = self.original_options
+        agent.options.allow_exit_as_root = False
+
+    def test_logging_enabled(self) -> None:
+        with tracer.start_as_current_span("test"):
+            self.logger.warning("test message")
+
+        spans = self.recorder.queued_spans()
+        assert len(spans) == 2
+        assert spans[0].k is SpanKind.CLIENT
+        assert spans[0].data["log"].get("message") == "test message"
+
+    def test_logging_disabled(self) -> None:
+        # Disable logging spans
+        agent.options.disabled_spans = ["logging"]
+
+        with tracer.start_as_current_span("test"):
+            self.logger.warning("test message")
+
+        spans = self.recorder.queued_spans()
+        assert len(spans) == 1  # Only the parent span, no logging span
+
+    def test_logging_disabled_via_env_var(self, monkeypatch):
+        # Disable logging spans via environment variable
+        monkeypatch.setenv("INSTANA_TRACING_DISABLE", "logging")
+
+        # Create new options to read from environment
+        original_options = agent.options
+        agent.options = type(original_options)()
+
+        with tracer.start_as_current_span("test"):
+            self.logger.warning("test message")
+
+        spans = self.recorder.queued_spans()
+        assert len(spans) == 1  # Only the parent span, no logging span
+
+        # Restore original options
+        agent.options = original_options
+
+    def test_logging_disabled_via_yaml(self) -> None:
+        # Disable logging spans via YAML configuration
+        original_options = agent.options
+        agent.options = type(original_options)()
+
+        # Simulate YAML configuration
+        tracing_config = {"disable": [{"logging": True}]}
+        agent.options.set_tracing(tracing_config)
+
+        with tracer.start_as_current_span("test"):
+            self.logger.warning("test message")
+
+        spans = self.recorder.queued_spans()
+        assert len(spans) == 1  # Only the parent span, no logging span
+
+        # Restore original options
+        agent.options = original_options
+
+
+# Made with Bob