WIP fix: require named MicroService -> HTTPService instances

Creating multiple MicroService()s creates multiple HTTPService()s which creates multiple Prometheus fastapi instrumentor instances. While latter handled that fine for ChatQnA and normal HTTP metrics, that was not the case for its "inprogress" metrics in CI. Therefore MicroService constructor name argument is now mandatory, so that it can be used to make "inprogress" metrics for HTTPService instances unique. PS. instrumentor requires HTTPService instance specific Starlette instance, so it cannot be made singleton. Signed-off-by: Eero Tamminen <[email protected]>
opea-project · Nov 1, 2024 · 1c828f7 · 1c828f7
1 parent 2e2f4a8
commit 1c828f7
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/comps/cores/mega/gateway.py b/comps/cores/mega/gateway.py
@@ -42,6 +42,7 @@ def __init__(
         self.input_datatype = input_datatype
         self.output_datatype = output_datatype
         self.service = MicroService(
+            self.__class__.__name__,
             service_role=ServiceRoleType.MEGASERVICE,
             service_type=ServiceType.GATEWAY,
             host=self.host,

diff --git a/comps/cores/mega/http_service.py b/comps/cores/mega/http_service.py
@@ -33,7 +33,12 @@ def __init__(
         self.uvicorn_kwargs = uvicorn_kwargs or {}
         self.cors = cors
         self._app = self._create_app()
+
+        # remove part before '@', used by register_microservice() callers, and
+        # part after '/', added by MicroService(), to get real service name
+        suffix = self.title.split('/')[0].split('@')[-1].lower()
         instrumentator = Instrumentator(
+            inprogress_name=f"http_requests_inprogress_{suffix}",
             should_instrument_requests_inprogress=True,
             inprogress_labels=True,
         )

diff --git a/comps/cores/mega/micro_service.py b/comps/cores/mega/micro_service.py
@@ -17,7 +17,7 @@ class MicroService:
 
     def __init__(
         self,
-        name: Optional[str] = None,
+        name: str,
         service_role: ServiceRoleType = ServiceRoleType.MICROSERVICE,
         service_type: ServiceType = ServiceType.LLM,
         protocol: str = "http",
@@ -141,7 +141,7 @@ def endpoint_path(self):
 
 
 def register_microservice(
-    name: Optional[str] = None,
+    name: str,
     service_role: ServiceRoleType = ServiceRoleType.MICROSERVICE,
     service_type: ServiceType = ServiceType.UNDEFINED,
     protocol: str = "http",