Skip to content

Commit

Permalink
Support functools.partial functions in AsyncioInstrumentor.trace_to_t…
Browse files Browse the repository at this point in the history
  • Loading branch information
ecarrara authored and xrmx committed Jan 24, 2025
1 parent 189566d commit 77d5ee1
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 5 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,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)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ def func():
"""

import asyncio
import functools
import sys
from asyncio import futures
from timeit import default_timer
Expand Down Expand Up @@ -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"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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")

0 comments on commit 77d5ee1

Please sign in to comment.