fix(asyncclick): disable asyncclick for long running processes like servers

Author: lannuttia

CHANGELOG.md

@@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
+- `opentelemetry-instrumentation-asyncclick`: fix issue where servers using asyncclick would not get a separate span per-request
 - `opentelemetry-instrumentation-click`: fix issue where starting uvicorn via `python -m` would cause the click instrumentation to give all requests the same trace id
 - `opentelemetry-instrumentation-botocore`: migrate off the deprecated events API to use the logs API
   ([#3624](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3624))

instrumentation/opentelemetry-instrumentation-asyncclick/src/opentelemetry/instrumentation/asyncclick/__init__.py

@@ -49,28 +49,11 @@ async def hello():
 import sys
 from functools import partial
 from logging import getLogger
-from typing import (
-    TYPE_CHECKING,
-    Any,
-    Awaitable,
-    Callable,
-    Collection,
-    TypeVar,
-)
+from typing import TYPE_CHECKING, Any, Awaitable, Callable, Collection, TypeVar
 
 import asyncclick
-from typing_extensions import ParamSpec, Unpack
-from wrapt import (
-    wrap_function_wrapper,  # type: ignore[reportUnknownVariableType]
-)
-
-from opentelemetry import trace
-from opentelemetry.instrumentation.asyncclick.package import _instruments
-from opentelemetry.instrumentation.asyncclick.version import __version__
 from opentelemetry.instrumentation.instrumentor import BaseInstrumentor
-from opentelemetry.instrumentation.utils import (
-    unwrap,
-)
+from opentelemetry.instrumentation.utils import unwrap
 from opentelemetry.semconv._incubating.attributes.process_attributes import (
     PROCESS_COMMAND_ARGS,
     PROCESS_EXECUTABLE_NAME,
@@ -79,6 +62,12 @@ async def hello():
 )
 from opentelemetry.semconv.attributes.error_attributes import ERROR_TYPE
 from opentelemetry.trace.status import StatusCode
+from typing_extensions import ParamSpec, Unpack
+from wrapt import wrap_function_wrapper  # type: ignore[reportUnknownVariableType]
+
+from opentelemetry import trace
+from opentelemetry.instrumentation.asyncclick.package import _instruments
+from opentelemetry.instrumentation.asyncclick.version import __version__
 
 if TYPE_CHECKING:
     from typing import TypedDict
@@ -112,6 +101,14 @@ async def _command_invoke_wrapper(
 
     ctx = args[0]
 
+    # we don't want to create a root span for long running processes like servers
+    # otherwise all requests would have the same trace id
+    if (
+        "opentelemetry.instrumentation.asgi" in sys.modules
+        or "opentelemetry.instrumentation.wsgi" in sys.modules
+    ):
+        return await wrapped(*args, **kwargs)
+
     span_name = ctx.info_name
     span_attributes = {
         PROCESS_COMMAND_ARGS: sys.argv,
@@ -132,9 +129,7 @@ async def _command_invoke_wrapper(
             span.set_status(StatusCode.ERROR, str(exc))
             if span.is_recording():
                 span.set_attribute(ERROR_TYPE, type(exc).__qualname__)
-                span.set_attribute(
-                    PROCESS_EXIT_CODE, getattr(exc, "exit_code", 1)
-                )
+                span.set_attribute(PROCESS_EXIT_CODE, getattr(exc, "exit_code", 1))
             raise
 
 

instrumentation/opentelemetry-instrumentation-asyncclick/tests/test_asyncclick.py

@@ -16,6 +16,7 @@
 
 import asyncio
 import os
+import sys
 from typing import Any
 from unittest import IsolatedAsyncioTestCase, mock
 
@@ -158,6 +159,36 @@ async def command_raises() -> None:
             },
         )
 
+    @mock.patch("sys.argv", ["command.py"])
+    def test_disabled_when_asgi_instrumentation_loaded(self):
+        @asyncclick.command()
+        async def command():
+            pass
+
+        with mock.patch.dict(
+            sys.modules,
+            {**sys.modules, "opentelemetry.instrumentation.asgi": mock.Mock()},
+        ):
+            result = run_asyncclick_command_test(command)
+        self.assertEqual(result.exit_code, 0)
+
+        self.assertFalse(self.memory_exporter.get_finished_spans())
+
+    @mock.patch("sys.argv", ["command.py"])
+    def test_disabled_when_wsgi_instrumentation_loaded(self):
+        @asyncclick.command()
+        async def command():
+            pass
+
+        with mock.patch.dict(
+            sys.modules,
+            {**sys.modules, "opentelemetry.instrumentation.wsgi": mock.Mock()},
+        ):
+            result = run_asyncclick_command_test(command)
+        self.assertEqual(result.exit_code, 0)
+
+        self.assertFalse(self.memory_exporter.get_finished_spans())
+
     def test_uninstrument(self):
         AsyncClickInstrumentor().uninstrument()