Docker Configuration

To configure the Holding Microservice Health Check in Docker, following are the steps to configure in holdings.yml:

1. Set the className_getHealthCheck environment variable in API container to enable API health check.
   Enabling Health Check for API Container

   api:
     ports:
       - "8302:8080"
       - "8303:40500"
     environment:
       #--- API Health Check ---
       className_getHealthCheck: com.temenos.microservice.framework.core.health.GetHealthCheckImpl
   

2. Enable a port for health check API in Ingester .
   Setting Port for Health Check in Ingester

   ingester:
     build:
       context: ${INGESTER_CONTEXT}
       dockerfile: Dockerfile
       args:
         BASE_IMAGE: ${INGESTER_APP_BASE_IMAGE}
         artifactid: ${ingester_artifactid}
         java_options: ${java_options} ${REMOTE_DEBUG}
     image: ${INGESTER_IMAGE}
     depends_on:
       - db-service1
       - db-service2
       - db-service3
     ports:
       - "12504:8080"
       - "12505:40500"  

3. Set the healthcheck.base.path environment variable in the ingester container.
   Setting healthcheck.base.path

   ingester:
     build:
       context: ${INGESTER_CONTEXT}
       dockerfile: Dockerfile
       args:
         BASE_IMAGE: ${INGESTER_APP_BASE_IMAGE}
         artifactid: ${ingester_artifactid}
         java_options: ${java_options} ${REMOTE_DEBUG}
     image: ${INGESTER_IMAGE}
     depends_on:
       - db-service1
       - db-service2
       - db-service3
     ports:
       - "12500:8080"
       - "12501:40500"
     environment:
       healthcheck.base.path: ms-holdings-data-ingester

API Health Check

Holdings Microservices expose API health check endpoint to monitor the health of Microservice APIs.

Pattern: http://<host>:<port>/<context-root>/api/health/api

Sample: http://localhost:8302/ms-holdings-api/api/v1.0.0/health/api/

Ingester Health Check

Holdings Microservices expose Ingester health check endpoint to monitor the health of ingester to consume and process incoming messages from Kafka or Kinesis topic.

Pattern: http://<host>:<port>/<Ingester-base-path>/api/health/ingester

Sample: http://localhost:12504/ms-holdings-data-ingester/v1.0.0/health/ingester

Docker: