Merge pull request #141 from GetStream/otel-rtc

Add opentelemetry for webrtc

Author: tbarbugli

getstream/base.py

@@ -54,7 +54,26 @@ def _parse_response(
         return StreamResponse(response, data)
 
 
-class TelemetryEndpointMixin:
+class TelemetryEndpointMixin(ABC):
+    """
+    Mixin that prepares request metadata for telemetry/tracing.
+
+    Note for type-checkers/IDEs:
+    - This mixin is designed to be used alongside clients that provide
+      `base_url`, `api_key`, and an `_endpoint_name(path)` method
+      (see `BaseClient` and `AsyncBaseClient`).
+    - We declare these attributes here so static analysis tools understand
+      they are available at runtime via the concrete client classes.
+    """
+
+    # Provided by BaseConfig in concrete clients
+    base_url: Optional[str]
+    api_key: Optional[str]
+
+    # Provided by concrete clients (e.g. BaseClient/AsyncBaseClient)
+    def _endpoint_name(self, path: str) -> str:  # pragma: no cover - interface hint
+        raise NotImplementedError
+
     def _normalize_endpoint_from_path(self, path: str) -> str:
         # Convert /api/v2/video/call/{type}/{id} -> api.v2.video.call.$type.$id
         norm_parts = []
@@ -82,6 +101,13 @@ def _prepare_request(self, method: str, path: str, query_params, kwargs):
             method=method,
             url=url_full,
         )
+        # Enrich with contextual IDs when available (set by decorators)
+        call_cid = getattr(self, "_call_cid", None)
+        if call_cid:
+            span_attrs["stream.call_cid"] = call_cid
+        channel_cid = getattr(self, "_channel_cid", None)
+        if channel_cid:
+            span_attrs["stream.channel_cid"] = channel_cid
         return url_path, url_full, endpoint, span_attrs
 
 
@@ -113,10 +139,8 @@ def __exit__(self, exc_type, exc_val, exc_tb):
         self.close()
 
     def _endpoint_name(self, path: str) -> str:
-        op = current_operation(None)
-        if op:
-            return op
-        return self._normalize_endpoint_from_path(path)
+        op = getattr(self, "_operation_name", None)
+        return op or current_operation(self._normalize_endpoint_from_path(path))
 
     def _request_sync(
         self, method: str, path: str, *, query_params=None, args=(), kwargs=None
@@ -281,10 +305,8 @@ async def aclose(self):
         await self.client.aclose()
 
     def _endpoint_name(self, path: str) -> str:
-        op = current_operation(None)
-        if op:
-            return op
-        return self._normalize_endpoint_from_path(path)
+        op = getattr(self, "_operation_name", None)
+        return op or current_operation(self._normalize_endpoint_from_path(path))
 
     async def _request_async(
         self, method: str, path: str, *, query_params=None, args=(), kwargs=None