fix: Improved getting active tracer and current span mechanism

Signed-off-by: Cagri Yonca <cagri@ibm.com>

Author: CagriYonca

src/instana/util/traceutils.py

@@ -16,9 +16,9 @@
 from instana.log import logger
 from instana.singletons import agent, get_tracer
 from instana.span.span import get_current_span
+from instana.span.span import InstanaSpan
 
 if TYPE_CHECKING:
-    from instana.span.span import InstanaSpan
     from instana.tracer import InstanaTracer
 
 
@@ -62,22 +62,6 @@ def extract_custom_headers(
         logger.debug("extract_custom_headers: ", exc_info=True)
 
 
-def get_active_tracer() -> Optional["InstanaTracer"]:
-    """Get the currently active tracer if one exists."""
-    try:
-        current_span = get_current_span()
-        if current_span:
-            # asyncio Spans are used as NonRecording Spans solely for context propagation
-            if current_span.is_recording() or current_span.name == "asyncio":
-                return get_tracer()
-            return None
-        return None
-    except Exception:
-        # Do not try to log this with instana, as there is no active tracer and there will be an infinite loop at least
-        # for PY2
-        return None
-
-
 def get_tracer_tuple() -> (
     Tuple[
         Optional["InstanaTracer"],
@@ -86,15 +70,17 @@ def get_tracer_tuple() -> (
     ]
 ):
     """Get a tuple of (tracer, span, span_name) for the current context."""
-    active_tracer = get_active_tracer()
-    current_span = get_current_span()
-    if active_tracer:
-        return (active_tracer, current_span, current_span.name)
-    elif agent.options.allow_exit_as_root:
-        return (get_tracer(), None, None)
-    return (None, None, None)
-
-
-def tracing_is_off() -> bool:
-    """Check if tracing is currently disabled."""
-    return not (bool(get_active_tracer()) or agent.options.allow_exit_as_root)
+    try:
+        active_tracer = get_tracer()
+        current_span = get_current_span()
+        # asyncio Spans are used as NonRecording Spans solely for context propagation
+        if current_span and isinstance(current_span, InstanaSpan):
+            if current_span.is_recording() or current_span.name == "asyncio":
+                return (active_tracer, current_span, current_span.name)
+        elif agent.options.allow_exit_as_root:
+            return (active_tracer, None, None)
+        return (None, None, None)
+    except Exception:
+        # Do not try to log this with instana, as there is no active tracer and there will be an infinite loop at least
+        # for PY2
+        return (None, None, None)

tests/util/test_traceutils.py

@@ -4,13 +4,10 @@
 from typing import Generator
 import pytest
 
-from instana.singletons import agent, get_tracer
-from instana.tracer import InstanaTracer
+from instana.singletons import agent, tracer
 from instana.util.traceutils import (
     extract_custom_headers,
-    get_active_tracer,
     get_tracer_tuple,
-    tracing_is_off,
 )
 
 
@@ -66,41 +63,16 @@ def test_extract_custom_headers(self, span, custom_headers, format) -> None:
         assert span.attributes["http.header.X-Capture-This-Too"] == "this too"
         assert span.attributes["http.header.X-Capture-That-Too"] == "that too"
 
-    def test_get_activate_tracer(self, mocker) -> None:
-        assert not get_active_tracer()
 
-        with self.tracer.start_as_current_span("test"):
-            response = get_active_tracer()
-            assert isinstance(response, InstanaTracer)
-            assert response == self.tracer
-            with mocker.patch(
-                "instana.span.span.InstanaSpan.is_recording", return_value=False
-            ):
-                assert not get_active_tracer()
+def test_get_tracer_tuple() -> None:
+    response = get_tracer_tuple()
+    assert response == (None, None, None)
 
-    def test_get_tracer_tuple(
-        self,
-    ) -> None:
-        response = get_tracer_tuple()
-        assert response == (None, None, None)
+    agent.options.allow_exit_as_root = True
+    response = get_tracer_tuple()
+    assert response == (tracer, None, None)
+    agent.options.allow_exit_as_root = False
 
-        agent.options.allow_exit_as_root = True
+    with tracer.start_as_current_span("test") as span:
         response = get_tracer_tuple()
-        assert response == (self.tracer, None, None)
-        agent.options.allow_exit_as_root = False
-
-        with self.tracer.start_as_current_span("test") as span:
-            response = get_tracer_tuple()
-            assert response == (self.tracer, span, span.name)
-
-    def test_tracing_is_off(self) -> None:
-        response = tracing_is_off()
-        assert response
-        with self.tracer.start_as_current_span("test"):
-            response = tracing_is_off()
-            assert not response
-
-        agent.options.allow_exit_as_root = True
-        response = tracing_is_off()
-        assert not response
-        agent.options.allow_exit_as_root = False
+        assert response == (tracer, span, span.name)