Use canonical name for aiohttp request span name

Author: krnr

CHANGELOG.md

@@ -11,6 +11,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+- `opentelemetry-instrumentation-aiohttp-server`: Use `canonical` attribute of the `Resource` as a span name.
+
 ### Added 
 
 - `opentelemetry-instrumentation-aiohttp-client`: add support for url exclusions via `OTEL_PYTHON_EXCLUDED_URLS` / `OTEL_PYTHON_AIOHTTP_CLIENT_EXCLUDED_URLS`

instrumentation/opentelemetry-instrumentation-aiohttp-server/src/opentelemetry/instrumentation/aiohttp_server/__init__.py

@@ -245,6 +245,10 @@ def get_default_span_name(request: web.Request) -> str:
  The span name.
  """
  span_name = request.path.strip() or f"HTTP {request.method}"
+ if request.match_info and request.match_info.route.resource:
+ resource = request.match_info.route.resource
+ if resource.canonical:
+ span_name = resource.canonical
  return span_name
 
 

instrumentation/opentelemetry-instrumentation-aiohttp-server/tests/test_aiohttp_server_integration.py

@@ -29,6 +29,7 @@
 from opentelemetry.semconv._incubating.attributes.http_attributes import (
  HTTP_METHOD,
  HTTP_STATUS_CODE,
+ HTTP_TARGET,
  HTTP_URL,
 )
 from opentelemetry.test.globals_test import (
@@ -106,7 +107,15 @@ async def fixture_server_fixture(tracer, aiohttp_server, suppress):
  AioHttpServerInstrumentor().instrument()
 
  app = aiohttp.web.Application()
- app.add_routes([aiohttp.web.get("/test-path", default_handler)])
+ app.add_routes(
+ [
+ aiohttp.web.get("/test-path", default_handler),
+ aiohttp.web.get("/test-path/{url_param}", default_handler),
+ aiohttp.web.get(
+ "/object/{object_id}/action/{another_param}", default_handler
+ ),
+ ]
+ )
  if suppress:
  with suppress_http_instrumentation():
  server = await aiohttp_server(app)
@@ -170,6 +179,53 @@ async def test_status_code_instrumentation(
  )
 
 
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+ "url, example_paths",
+ [
+ (
+ "/test-path/{url_param}",
+ (
+ "/test-path/foo",
+ "/test-path/bar",
+ ),
+ ),
+ (
+ "/object/{object_id}/action/{another_param}",
+ (
+ "/object/1/action/bar",
+ "/object/234/action/baz",
+ ),
+ ),
+ ],
+)
+async def test_url_params_instrumentation(
+ tracer,
+ server_fixture,
+ aiohttp_client,
+ url,
+ example_paths,
+):
+ _, memory_exporter = tracer
+ server, _ = server_fixture
+
+ assert len(memory_exporter.get_finished_spans()) == 0
+
+ client = await aiohttp_client(server)
+ for path in example_paths:
+ await client.get(path)
+
+ assert len(memory_exporter.get_finished_spans()) == 2
+
+ for request_path, span in zip(
+ example_paths, memory_exporter.get_finished_spans()
+ ):
+ assert url == span.name
+ assert request_path == span.attributes[HTTP_TARGET]
+ full_url = f"http://{server.host}:{server.port}{request_path}"
+ assert full_url == span.attributes[HTTP_URL]
+
+
 @pytest.mark.asyncio
 @pytest.mark.parametrize("suppress", [True])
 async def test_suppress_instrumentation(