Add OVERALL_HEALTH

src/python/grpcio_health_checking/grpc_health/v1/_async.py

@@ -22,7 +22,7 @@ from grpc_health.v1 import health_pb2 as _health_pb2
 from grpc_health.v1 import health_pb2_grpc as _health_pb2_grpc
 
 
-class AsyncHealthServicer(_health_pb2_grpc.HealthServicer):
+class HealthServicer(_health_pb2_grpc.HealthServicer):
     """An AsyncIO implementation of health checking servicer."""
     _server_status: MutableMapping[
         str, '_health_pb2.HealthCheckResponse.ServingStatus']
@@ -88,7 +88,7 @@ class AsyncHealthServicer(_health_pb2_grpc.HealthServicer):
         """Sets the status of a service.
 
         Args:
-          service: string, the name of the service. NOTE, '' must be set.
+          service: string, the name of the service.
           status: HealthCheckResponse.status enum value indicating the status of
             the service
         """
@@ -103,8 +103,6 @@ class AsyncHealthServicer(_health_pb2_grpc.HealthServicer):
         This should be invoked when the server is entering a graceful shutdown
         period. After this method is invoked, future attempts to set the status
         of a service will be ignored.
-
-        This is an EXPERIMENTAL API.
         """
         if self._gracefully_shutting_down:
             return

src/python/grpcio_health_checking/grpc_health/v1/health.py

@@ -23,9 +23,12 @@ from grpc_health.v1 import health_pb2_grpc as _health_pb2_grpc
 
 if sys.version_info[0] >= 3 and sys.version_info[1] >= 6:
     # Exposes AsyncHealthServicer as public API.
-    from ._async import AsyncHealthServicer  # pylint: disable=unused-import
+    from . import _async as aio  # pylint: disable=unused-import
 
+# The service name of the health checking servicer.
 SERVICE_NAME = _health_pb2.DESCRIPTOR.services_by_name['Health'].full_name
+# The entry of overall health for the entire server.
+OVERALL_HEALTH = ''
 
 
 class _Watcher():
@@ -135,7 +138,7 @@ class HealthServicer(_health_pb2_grpc.HealthServicer):
         """Sets the status of a service.
 
         Args:
-          service: string, the name of the service. NOTE, '' must be set.
+          service: string, the name of the service.
           status: HealthCheckResponse.status enum value indicating the status of
             the service
         """

src/python/grpcio_tests/tests_aio/health_check/health_servicer_test.py

@@ -46,8 +46,9 @@ async def _pipe_to_queue(call, queue):
 class HealthServicerTest(AioTestBase):
 
     async def setUp(self):
-        self._servicer = health.AsyncHealthServicer()
-        await self._servicer.set('', health_pb2.HealthCheckResponse.SERVING)
+        self._servicer = health.aio.HealthServicer()
+        await self._servicer.set(health.OVERALL_HEALTH,
+                                 health_pb2.HealthCheckResponse.SERVING)
         await self._servicer.set(_SERVING_SERVICE,
                                  health_pb2.HealthCheckResponse.SERVING)
         await self._servicer.set(_UNKNOWN_SERVICE,
@@ -99,7 +100,7 @@ class HealthServicerTest(AioTestBase):
         self.assertEqual(health.SERVICE_NAME, 'grpc.health.v1.Health')
 
     async def test_watch_empty_service(self):
-        request = health_pb2.HealthCheckRequest(service='')
+        request = health_pb2.HealthCheckRequest(service=health.OVERALL_HEALTH)
 
         call = self._stub.Watch(request)
         queue = asyncio.Queue()
@@ -206,7 +207,7 @@ class HealthServicerTest(AioTestBase):
         self.assertTrue(queue.empty())
 
     async def test_graceful_shutdown(self):
-        request = health_pb2.HealthCheckRequest(service='')
+        request = health_pb2.HealthCheckRequest(service=health.OVERALL_HEALTH)
         call = self._stub.Watch(request)
         queue = asyncio.Queue()
         task = self.loop.create_task(_pipe_to_queue(call, queue))
@@ -219,7 +220,8 @@ class HealthServicerTest(AioTestBase):
                          (await queue.get()).status)
 
         # This should be a no-op.
-        await self._servicer.set('', health_pb2.HealthCheckResponse.SERVING)
+        await self._servicer.set(health.OVERALL_HEALTH,
+                                 health_pb2.HealthCheckResponse.SERVING)
 
         resp = await self._stub.Check(request)
         self.assertEqual(health_pb2.HealthCheckResponse.NOT_SERVING,