Fix ASGI instrumentation default span name

Fixes ASGI default span name for SERVER spans, to be `HTTP <method>`. Fixes open-telemetry#146.
adamantike · May 25, 2021 · 66928d2 · 66928d2
1 parent f4a2b61
commit 66928d2
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 20 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,12 +8,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Fixed cases where description was used with non-error status code when creating Status objects.
   ([#504](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/504))
+- Fix ASGI instrumentation default span name.
+  ([#418](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/418))
 
 ### Added
 - `opentelemetry-instrumentation-botocore` now supports
-  context propagation for lambda invoke via Payload embedded headers. 
+  context propagation for lambda invoke via Payload embedded headers.
   ([#458](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/458))
-  
+
 ## [0.21b0](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v1.2.0-0.21b0) - 2021-05-11
 ### Changed
 
@@ -77,7 +79,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   ([#436](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/436))
 - `opentelemetry-instrumentation-grpc` Keep client interceptor in sync with grpc client interceptors.
   ([#442](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/442))
-  
+
 ### Removed
 - Remove `http.status_text` from span attributes
   ([#406](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/406))

diff --git a/...ion/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py b/...ion/opentelemetry-instrumentation-asgi/src/opentelemetry/instrumentation/asgi/__init__.py
@@ -147,12 +147,12 @@ def get_default_span_details(scope: dict) -> Tuple[str, dict]:
         scope: the asgi scope dictionary
 
     Returns:
-        a tuple of the span, and any attributes to attach to the
-        span.
+        a tuple of the span name, and any attributes to attach to the span.
     """
     method_or_path = scope.get("method") or scope.get("path")
+    span_name = "HTTP {}".format(method_or_path.strip())
 
-    return method_or_path, {}
+    return span_name, {}
 
 
 class OpenTelemetryMiddleware:
@@ -205,7 +205,7 @@ async def __call__(self, scope, receive, send):
 
         try:
             with self.tracer.start_as_current_span(
-                span_name + " asgi", kind=trace.SpanKind.SERVER,
+                span_name, kind=trace.SpanKind.SERVER,
             ) as span:
                 if span.is_recording():
                     attributes = collect_request_attributes(scope)

diff --git a/instrumentation/opentelemetry-instrumentation-asgi/tests/test_asgi_middleware.py b/instrumentation/opentelemetry-instrumentation-asgi/tests/test_asgi_middleware.py
@@ -116,25 +116,25 @@ def validate_outputs(self, outputs, error=None, modifiers=None):
         self.assertEqual(len(span_list), 4)
         expected = [
             {
-                "name": "GET asgi.http.receive",
+                "name": "HTTP GET asgi.http.receive",
                 "kind": trace_api.SpanKind.INTERNAL,
                 "attributes": {"type": "http.request"},
             },
             {
-                "name": "GET asgi.http.send",
+                "name": "HTTP GET asgi.http.send",
                 "kind": trace_api.SpanKind.INTERNAL,
                 "attributes": {
                     SpanAttributes.HTTP_STATUS_CODE: 200,
                     "type": "http.response.start",
                 },
             },
             {
-                "name": "GET asgi.http.send",
+                "name": "HTTP GET asgi.http.send",
                 "kind": trace_api.SpanKind.INTERNAL,
                 "attributes": {"type": "http.response.body"},
             },
             {
-                "name": "GET asgi",
+                "name": "HTTP GET",
                 "kind": trace_api.SpanKind.SERVER,
                 "attributes": {
                     SpanAttributes.HTTP_METHOD: "GET",
@@ -200,9 +200,12 @@ def get_predefined_span_details(_):
 
         def update_expected_span_name(expected):
             for entry in expected:
-                entry["name"] = " ".join(
-                    [span_name] + entry["name"].split(" ")[-1:]
-                )
+                if entry["kind"] == trace_api.SpanKind.SERVER:
+                    entry["name"] = span_name
+                else:
+                    entry["name"] = " ".join(
+                        [span_name] + entry["name"].split(" ")[-1:]
+                    )
             return expected
 
         app = otel_asgi.OpenTelemetryMiddleware(
@@ -303,12 +306,12 @@ def test_websocket(self):
         span_list = self.memory_exporter.get_finished_spans()
         self.assertEqual(len(span_list), 6)
         expected = [
-            "/ asgi.websocket.receive",
-            "/ asgi.websocket.send",
-            "/ asgi.websocket.receive",
-            "/ asgi.websocket.send",
-            "/ asgi.websocket.receive",
-            "/ asgi",
+            "HTTP / asgi.websocket.receive",
+            "HTTP / asgi.websocket.send",
+            "HTTP / asgi.websocket.receive",
+            "HTTP / asgi.websocket.send",
+            "HTTP / asgi.websocket.receive",
+            "HTTP /",
         ]
         actual = [span.name for span in span_list]
         self.assertListEqual(actual, expected)