Merge branch 'open-telemetry:main' into main

Author: jagerzhang

CHANGELOG.md

@@ -23,6 +23,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   ([#2879](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2879))
 - `opentelemetry-instrumentation-redis` Add additional attributes for methods create_index and search, rename those spans
   ([#2635](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2635))
+- `opentelemetry-instrumentation` Add support for string based dotted module paths in unwrap
+  ([#2919](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2919))
 
 ### Fixed
 
@@ -82,6 +84,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   ([#2753](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2753))
 - `opentelemetry-instrumentation-grpc` Fix grpc supported version
   ([#2845](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2845))
+- `opentelemetry-instrumentation-asyncio` fix `AttributeError` in
+  `AsyncioInstrumentor.trace_to_thread` when `func` is a `functools.partial` instance
+  ([#2911](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2911))
 
 ## Version 1.26.0/0.47b0 (2024-07-23)
 
@@ -414,6 +419,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   ([#1879](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1879))
 - Add optional distro and configurator selection for auto-instrumentation
   ([#1823](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1823))
+- `opentelemetry-instrumentation-django` - Add option to add Opentelemetry middleware at specific position in middleware chain
+  ([#2912]https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2912)
 
 ### Added
 

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

@@ -78,6 +78,7 @@ def func():
 """
 
 import asyncio
+import functools
 import sys
 from asyncio import futures
 from timeit import default_timer
@@ -231,14 +232,15 @@ def wrap_taskgroup_create_task(method, instance, args, kwargs) -> None:
     def trace_to_thread(self, func: callable):
         """Trace a function."""
         start = default_timer()
+        func_name = getattr(func, "__name__", None)
+        if func_name is None and isinstance(func, functools.partial):
+            func_name = func.func.__name__
         span = (
-            self._tracer.start_span(
-                f"{ASYNCIO_PREFIX} to_thread-" + func.__name__
-            )
-            if func.__name__ in self._to_thread_name_to_trace
+            self._tracer.start_span(f"{ASYNCIO_PREFIX} to_thread-" + func_name)
+            if func_name in self._to_thread_name_to_trace
             else None
         )
-        attr = {"type": "to_thread", "name": func.__name__}
+        attr = {"type": "to_thread", "name": func_name}
         exception = None
         try:
             attr["state"] = "finished"

instrumentation/opentelemetry-instrumentation-asyncio/tests/test_asyncio_to_thread.py

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 import asyncio
+import functools
 import sys
 from unittest import skipIf
 from unittest.mock import patch
@@ -72,3 +73,37 @@ async def to_thread():
                 for point in metric.data.data_points:
                     self.assertEqual(point.attributes["type"], "to_thread")
                     self.assertEqual(point.attributes["name"], "multiply")
+
+    @skipIf(
+        sys.version_info < (3, 9), "to_thread is only available in Python 3.9+"
+    )
+    def test_to_thread_partial_func(self):
+        def multiply(x, y):
+            return x * y
+
+        double = functools.partial(multiply, 2)
+
+        async def to_thread():
+            result = await asyncio.to_thread(double, 3)
+            assert result == 6
+
+        with self._tracer.start_as_current_span("root"):
+            asyncio.run(to_thread())
+        spans = self.memory_exporter.get_finished_spans()
+
+        self.assertEqual(len(spans), 2)
+        assert spans[0].name == "asyncio to_thread-multiply"
+        for metric in (
+            self.memory_metrics_reader.get_metrics_data()
+            .resource_metrics[0]
+            .scope_metrics[0]
+            .metrics
+        ):
+            if metric.name == "asyncio.process.duration":
+                for point in metric.data.data_points:
+                    self.assertEqual(point.attributes["type"], "to_thread")
+                    self.assertEqual(point.attributes["name"], "multiply")
+            if metric.name == "asyncio.process.created":
+                for point in metric.data.data_points:
+                    self.assertEqual(point.attributes["type"], "to_thread")
+                    self.assertEqual(point.attributes["name"], "multiply")

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

@@ -285,6 +285,30 @@ def _get_django_middleware_setting() -> str:
     return "MIDDLEWARE"
 
 
+def _get_django_otel_middleware_position(
+    middleware_length, default_middleware_position=0
+):
+    otel_position = environ.get("OTEL_PYTHON_DJANGO_MIDDLEWARE_POSITION")
+    try:
+        middleware_position = int(otel_position)
+    except (ValueError, TypeError):
+        _logger.debug(
+            "Invalid OTEL_PYTHON_DJANGO_MIDDLEWARE_POSITION value: (%s). Using default position: %d.",
+            otel_position,
+            default_middleware_position,
+        )
+        middleware_position = default_middleware_position
+
+    if middleware_position < 0 or middleware_position > middleware_length:
+        _logger.debug(
+            "Middleware position %d is out of range (0-%d). Using 0 as the position",
+            middleware_position,
+            middleware_length,
+        )
+        middleware_position = 0
+    return middleware_position
+
+
 class DjangoInstrumentor(BaseInstrumentor):
     """An instrumentor for Django
 
@@ -388,10 +412,18 @@ def _instrument(self, **kwargs):
 
         is_sql_commentor_enabled = kwargs.pop("is_sql_commentor_enabled", None)
 
+        middleware_position = _get_django_otel_middleware_position(
+            len(settings_middleware), kwargs.pop("middleware_position", 0)
+        )
+
         if is_sql_commentor_enabled:
-            settings_middleware.insert(0, self._sql_commenter_middleware)
+            settings_middleware.insert(
+                middleware_position, self._sql_commenter_middleware
+            )
 
-        settings_middleware.insert(0, self._opentelemetry_middleware)
+        settings_middleware.insert(
+            middleware_position, self._opentelemetry_middleware
+        )
 
         setattr(settings, _middleware_setting, settings_middleware)
 

instrumentation/opentelemetry-instrumentation-django/tests/test_middleware.py

@@ -157,6 +157,46 @@ def tearDownClass(cls):
         super().tearDownClass()
         conf.settings = conf.LazySettings()
 
+    def test_middleware_added_at_position(self):
+        _django_instrumentor.uninstrument()
+        if DJANGO_2_0:
+            middleware = conf.settings.MIDDLEWARE
+        else:
+            middleware = conf.settings.MIDDLEWARE_CLASSES
+        # adding two dummy middlewares
+        temprory_middelware = "django.utils.deprecation.MiddlewareMixin"
+        middleware.append(temprory_middelware)
+        middleware.append(temprory_middelware)
+
+        middleware_position = 1
+        _django_instrumentor.instrument(
+            middleware_position=middleware_position
+        )
+        self.assertEqual(
+            middleware[middleware_position],
+            "opentelemetry.instrumentation.django.middleware.otel_middleware._DjangoMiddleware",
+        )
+
+    def test_middleware_added_at_position_if_wrong_position(self):
+        _django_instrumentor.uninstrument()
+        if DJANGO_2_0:
+            middleware = conf.settings.MIDDLEWARE
+        else:
+            middleware = conf.settings.MIDDLEWARE_CLASSES
+        # adding middleware
+        temprory_middelware = "django.utils.deprecation.MiddlewareMixin"
+        middleware.append(temprory_middelware)
+        middleware_position = (
+            756  # wrong position out of bound of middleware length
+        )
+        _django_instrumentor.instrument(
+            middleware_position=middleware_position
+        )
+        self.assertEqual(
+            middleware[0],
+            "opentelemetry.instrumentation.django.middleware.otel_middleware._DjangoMiddleware",
+        )
+
     def test_templated_route_get(self):
         Client().get("/route/2020/template/")
 

instrumentation/opentelemetry-instrumentation-django/tests/test_sqlcommenter.py

@@ -72,6 +72,37 @@ def test_middleware_added(self, sqlcommenter_middleware):
             in middleware
         )
 
+    @patch(
+        "opentelemetry.instrumentation.django.middleware.sqlcommenter_middleware.SqlCommenter"
+    )
+    def test_middleware_added_at_position(self, sqlcommenter_middleware):
+        _django_instrumentor.uninstrument()
+        if DJANGO_2_0:
+            middleware = conf.settings.MIDDLEWARE
+        else:
+            middleware = conf.settings.MIDDLEWARE_CLASSES
+
+        # adding two dummy middlewares
+        temprory_middelware = "django.utils.deprecation.MiddlewareMixin"
+        middleware.append(temprory_middelware)
+        middleware.append(temprory_middelware)
+
+        middleware_position = 1
+        _django_instrumentor.instrument(
+            is_sql_commentor_enabled=True,
+            middleware_position=middleware_position,
+        )
+        instance = sqlcommenter_middleware.return_value
+        instance.get_response = HttpResponse()
+        self.assertEqual(
+            middleware[middleware_position],
+            "opentelemetry.instrumentation.django.middleware.otel_middleware._DjangoMiddleware",
+        )
+        self.assertEqual(
+            middleware[middleware_position + 1],
+            "opentelemetry.instrumentation.django.middleware.sqlcommenter_middleware.SqlCommenter",
+        )
+
     @patch(
         "opentelemetry.instrumentation.django.middleware.sqlcommenter_middleware._get_opentelemetry_values"
     )

opentelemetry-instrumentation/src/opentelemetry/instrumentation/bootstrap.py

@@ -22,12 +22,15 @@
     SubprocessError,
     check_call,
 )
+from typing import Optional
 
 from packaging.requirements import Requirement
 
 from opentelemetry.instrumentation.bootstrap_gen import (
-    default_instrumentations,
-    libraries,
+    default_instrumentations as gen_default_instrumentations,
+)
+from opentelemetry.instrumentation.bootstrap_gen import (
+    libraries as gen_libraries,
 )
 from opentelemetry.instrumentation.version import __version__
 from opentelemetry.util._importlib_metadata import (
@@ -75,7 +78,7 @@ def _sys_pip_install(package):
         print(error)
 
 
-def _pip_check():
+def _pip_check(libraries):
     """Ensures none of the instrumentations have dependency conflicts.
     Clean check reported as:
     'No broken requirements found.'
@@ -113,7 +116,7 @@ def _is_installed(req):
     return True
 
 
-def _find_installed_libraries():
+def _find_installed_libraries(default_instrumentations, libraries):
     for lib in default_instrumentations:
         yield lib
 
@@ -122,18 +125,25 @@ def _find_installed_libraries():
             yield lib["instrumentation"]
 
 
-def _run_requirements():
+def _run_requirements(default_instrumentations, libraries):
     logger.setLevel(logging.ERROR)
-    print("\n".join(_find_installed_libraries()))
+    print(
+        "\n".join(
+            _find_installed_libraries(default_instrumentations, libraries)
+        )
+    )
 
 
-def _run_install():
-    for lib in _find_installed_libraries():
+def _run_install(default_instrumentations, libraries):
+    for lib in _find_installed_libraries(default_instrumentations, libraries):
         _sys_pip_install(lib)
-    _pip_check()
+    _pip_check(libraries)
 
 
-def run() -> None:
+def run(
+    default_instrumentations: Optional[list] = None,
+    libraries: Optional[list] = None,
+) -> None:
     action_install = "install"
     action_requirements = "requirements"
 
@@ -163,8 +173,14 @@ def run() -> None:
     )
     args = parser.parse_args()
 
+    if libraries is None:
+        libraries = gen_libraries
+
+    if default_instrumentations is None:
+        default_instrumentations = gen_default_instrumentations
+
     cmd = {
         action_install: _run_install,
         action_requirements: _run_requirements,
     }[args.action]
-    cmd()
+    cmd(default_instrumentations, libraries)

opentelemetry-instrumentation/src/opentelemetry/instrumentation/utils.py

@@ -14,8 +14,9 @@
 
 import urllib.parse
 from contextlib import contextmanager
+from importlib import import_module
 from re import escape, sub
-from typing import Dict, Iterable, Sequence
+from typing import Dict, Iterable, Sequence, Union
 
 from wrapt import ObjectProxy
 
@@ -80,13 +81,30 @@ def http_status_to_status_code(
     return StatusCode.ERROR
 
 
-def unwrap(obj, attr: str):
+def unwrap(obj: Union[object, str], attr: str):
     """Given a function that was wrapped by wrapt.wrap_function_wrapper, unwrap it
 
+    The object containing the function to unwrap may be passed as dotted module path string.
+
     Args:
-        obj: Object that holds a reference to the wrapped function
+        obj: Object that holds a reference to the wrapped function or dotted import path as string
         attr (str): Name of the wrapped function
     """
+    if isinstance(obj, str):
+        try:
+            module_path, class_name = obj.rsplit(".", 1)
+        except ValueError as exc:
+            raise ImportError(
+                f"Cannot parse '{obj}' as dotted import path"
+            ) from exc
+        module = import_module(module_path)
+        try:
+            obj = getattr(module, class_name)
+        except AttributeError as exc:
+            raise ImportError(
+                f"Cannot import '{class_name}' from '{module}'"
+            ) from exc
+
     func = getattr(obj, attr, None)
     if func and isinstance(func, ObjectProxy) and hasattr(func, "__wrapped__"):
         setattr(obj, attr, func.__wrapped__)