[DOP-24616] Add healthcheck endpoint for consumer (#195)

* [DOP-24616] add healtcheck endpoint for consumer

* [DOP-24616] add healtcheck endpoint for consumer

* [DOP-24616] update lines in docs

Author: TiGrib

.env.docker

@@ -8,7 +8,7 @@ POSTGRES_INITDB_ARGS=--encoding=UTF-8 --lc-collate=C --lc-ctype=C
 KAFKA_CFG_NODE_ID=0
 KAFKA_CFG_PROCESS_ROLES=controller,broker
 KAFKA_CFG_LISTENERS=DOCKER://:9092,LOCALHOST://:9093,CONTROLLER://:9094,INTERBROKER://:9095
-KAFKA_CFG_ADVERTISED_LISTENERS=DOCKER://kafka:9092,LOCALHOST://localhost:9093,INTERBROKER://broker:9095
+KAFKA_CFG_ADVERTISED_LISTENERS=DOCKER://broker:9092,LOCALHOST://localhost:9093,INTERBROKER://broker:9095
 KAFKA_CFG_LISTENER_SECURITY_PROTOCOL_MAP=CONTROLLER:PLAINTEXT,INTERBROKER:PLAINTEXT,DOCKER:SASL_PLAINTEXT,LOCALHOST:SASL_PLAINTEXT
 KAFKA_CFG_CONTROLLER_QUORUM_VOTERS=0@broker:9094
 KAFKA_CFG_INTER_BROKER_LISTENER_NAME=DOCKER

data_rentgen/consumer/__init__.py

@@ -3,11 +3,13 @@
 
 import logging
 from contextlib import asynccontextmanager
+from typing import Any
 
 import anyio
 from fast_depends import dependency_provider
 from faststream import ContextRepo, FastStream
 from faststream._compat import ExceptionGroup
+from faststream.asgi import AsgiFastStream, AsgiResponse, get
 from faststream.kafka import KafkaBroker
 from sqlalchemy.ext.asyncio import AsyncSession
 
@@ -20,6 +22,11 @@
 logger = logging.getLogger(__name__)
 
 
+@get  # type: ignore[arg-type]
+async def liveness(scope: dict[str, Any]) -> AsgiResponse:
+    return AsgiResponse(b"", status_code=204)
+
+
 def broker_factory(settings: ConsumerApplicationSettings) -> KafkaBroker:
     broker = KafkaBroker(
         bootstrap_servers=settings.kafka.bootstrap_servers,
@@ -43,7 +50,7 @@ def broker_factory(settings: ConsumerApplicationSettings) -> KafkaBroker:
     return broker
 
 
-def application_factory(settings: ConsumerApplicationSettings) -> FastStream:
+def application_factory(settings: ConsumerApplicationSettings) -> AsgiFastStream:
     @asynccontextmanager
     async def security_lifespan(context: ContextRepo):
         try:
@@ -66,7 +73,7 @@ async def security_lifespan(context: ContextRepo):
         description="Data.Rentgen is a nextgen DataLineage service",
         version=data_rentgen.__version__,
         logger=logger,
-    )
+    ).as_asgi(asgi_routes=[("/internal/healthcheck/liveness", liveness)])
 
 
 def get_application():

docker-compose.yml

@@ -59,6 +59,12 @@ services:
     command: python -m data_rentgen.consumer
     restart: unless-stopped
     env_file: .env.docker
+    healthcheck:
+      test: [CMD-SHELL, curl -f http://localhost:8000/internal/healthcheck/liveness]
+      interval: 30s
+      timeout: 5s
+      retries: 3
+      start_period: 5s
     depends_on:
       broker:
         condition: service_healthy

docs/reference/consumer/index.rst

@@ -27,7 +27,7 @@ With docker
   .. dropdown:: ``docker-compose.yml``
 
       .. literalinclude:: ../../../docker-compose.yml
-          :emphasize-lines: 57-66
+          :emphasize-lines: 57-72
 
   .. dropdown:: ``.env.docker``
 

docs/reference/database/index.rst

@@ -64,7 +64,7 @@ With Docker
   .. dropdown:: ``docker-compose.yml``
 
       .. literalinclude:: ../../../docker-compose.yml
-          :emphasize-lines: 1-15,102-103
+          :emphasize-lines: 1-15,108-110
 
   .. dropdown:: ``.env.docker``
 

docs/reference/frontend/index.rst

@@ -28,7 +28,7 @@ With Docker
   .. dropdown:: ``docker-compose.yml``
 
       .. literalinclude:: ../../../docker-compose.yml
-          :emphasize-lines: 86-100
+          :emphasize-lines: 92-106
 
   .. dropdown:: ``.env.docker``