Merge pull request #3281 from amadeuppereira/use-name-in-requests-trace

Forward explicitly set request name to OTEL span

Author: cyberw

locust/clients.py

@@ -3,6 +3,7 @@
 from locust.event import EventHook
 
 import re
+import sys
 import time
 from contextlib import contextmanager
 from typing import TYPE_CHECKING, cast
@@ -17,8 +18,13 @@
 
 from .exception import CatchResponseError, LocustError, ResponseError
 
+if sys.version_info >= (3, 12):
+    from typing import override
+else:
+    from typing_extensions import override
+
+
 if TYPE_CHECKING:
-    import sys
     from collections.abc import Callable, Generator, Iterable, Mapping, MutableMapping
     from typing import Any, TypedDict
 
@@ -177,6 +183,8 @@ def request(  # type: ignore[override]
         if self.request_name and not name:
             name = self.request_name
 
+        self.explicit_name = name
+
         # prepend url with hostname unless it's already an absolute URL
         complete_url = self._build_url(url)
 
@@ -235,6 +243,13 @@ def _send_request_safe_mode(self, method, url, **kwargs) -> Response:
         except RequestException as e:
             return ResponseContextManager(e)  # this is inconsistent, we should fix this some time
 
+    @override
+    def prepare_request(self, request) -> requests.PreparedRequest:
+        prep = super().prepare_request(request)
+        if self.explicit_name:
+            prep._explicit_name = self.explicit_name  # type: ignore
+        return prep
+
     def get(
         self, url: str | bytes, *, data: Any = None, json: Any = None, **kwargs: Unpack[RESTKwargs]
     ) -> ResponseContextManager:

locust/opentelemetry.py

@@ -1,5 +1,6 @@
 import logging
 import os
+from urllib.parse import urlparse
 
 from ._version import __version__
 
@@ -134,8 +135,11 @@ def _setup_auto_instrumentation():
         from opentelemetry.sdk.trace import Span
 
         def request_hook(span: Span, request: requests.PreparedRequest):
-            span.update_name(f"{request.method} {request.url}")
-            return
+            if name := getattr(request, "_explicit_name", None):
+                span.update_name(f"{request.method} {name}")
+            else:
+                parsed = urlparse(request.url)
+                span.update_name(f"{request.method} {str(parsed.path) or '/'}")
 
         RequestsInstrumentor().instrument(request_hook=request_hook)
     except ImportError: