Add grpc_health to be able to check the service status

requirements.in

@@ -2,6 +2,7 @@ ensembl-py >= 2.1.0
 ensembl-utils >= 0.5.0
 mysqlclient >= 1.4.6, < 2.3.0
 grpcio
+grpcio-health-checking
 protobuf
 grpcio-tools
 grpcio-reflection

requirements.txt

@@ -19,8 +19,11 @@ greenlet==3.0.3
 grpcio==1.66.1
     # via
     #   -r requirements.in
+    #   grpcio-health-checking
     #   grpcio-reflection
     #   grpcio-tools
+grpcio-health-checking==1.66.1
+    # via -r requirements.in
 grpcio-reflection==1.66.1
     # via -r requirements.in
 grpcio-tools==1.66.1
@@ -38,6 +41,7 @@ pluggy==1.5.0
 protobuf==5.28.0
     # via
     #   -r requirements.in
+    #   grpcio-health-checking
     #   grpcio-reflection
     #   grpcio-tools
 pytest==8.3.3

src/ensembl/production/metadata/grpc/service.py

@@ -13,6 +13,7 @@
 from concurrent import futures
 
 import grpc
+from grpc_health.v1 import health, health_pb2, health_pb2_grpc
 from grpc_reflection.v1alpha import reflection
 
 from ensembl.production.metadata.grpc import ensembl_metadata_pb2_grpc, ensembl_metadata_pb2
@@ -30,17 +31,35 @@ def serve():
         level=log_level,
         format='%(asctime)s - %(name)s - %(levelname)s - %(message)s'
     )
+
+    # Creating gRPC server
     server = grpc.server(futures.ThreadPoolExecutor(max_workers=10))
+
+    # Registering Ensembl metadata service
     ensembl_metadata_pb2_grpc.add_EnsemblMetadataServicer_to_server(
         EnsemblMetadataServicer(), server
     )
+
+    # Adding Health Check Service
+    health_servicer = health.HealthServicer()
+    health_pb2_grpc.add_HealthServicer_to_server(health_servicer, server)
+
+    # Setting service health status to "SERVING"
+    health_servicer.set('', health_pb2.HealthCheckResponse.SERVING)  # Global health check
+    health_servicer.set('EnsemblMetadata', health_pb2.HealthCheckResponse.SERVING)
+
+    # Enabling reflection
     SERVICE_NAMES = (
         ensembl_metadata_pb2.DESCRIPTOR.services_by_name['EnsemblMetadata'].full_name,
+        health_pb2.DESCRIPTOR.services_by_name['Health'].full_name,
         reflection.SERVICE_NAME
     )
     reflection.enable_server_reflection(SERVICE_NAMES, server)
+
+    # Starting the server
     server.add_insecure_port(f"[::]:{cfg.service_port}")
     server.start()
+
     try:
         logger.info(f"Starting GRPC Server on {cfg.service_port} DEBUG: {cfg.debug_mode}")
         server.wait_for_termination()