Health Check

Health Check gives the ability to monitor the health of the Account Aggregation application. This is useful not only to test the internal health of an application but also it’s external dependencies such as a third party API which Account Aggregation application relies on to function correctly.

Microservices health check helps to monitor the health of Account Aggregation Microservice APIs and Ingester as classified below:

• API health check
  • Database check
  • Third-party API check
• Ingester health check
  • Stream check
  • Database check

Configuration

Follow the steps below to configure health check for Account Aggregation Microservice in <filename>.yml.

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

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

2. Enable a port for health check API in Ingester Eg: 12514 as shown below:
   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}
     .....
     ports:
       - "12514:8080"
       - "12515: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}
     .....
     ports:
       - "12514:8080"
       - "12515:40500"
     environment:
       healthcheck.base.path: ms-accountaggregate-data-ingester

API Health Check

Account Aggregation 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:8306/ms-accountaggregate-api/api/v1.0.0/health/api

K8:

Ingester Health Check

Account aggregation microservices expose ingester health check endpoint to monitor the health of ingester to consume and process incoming messages from Kafka/kinesis topic.

Pattern: http://<host>:<port>/<Ingester-base-path>/v1.0.0/health/ingester

Sample: http://localhost:12514/ms-accountaggregate-data-ingester/v1.0.0/health/ingester

K8: