Health Check

This section explains the Health Check, which provides the ability to monitor the health of the Arrangement 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) on which Arrangement application relies to function correctly.

Microservices health check helps to monitor the health of Arrangement Microservice APIs and ingester as classified below:

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

Doocker

Configuration

To configure health check for Arrangement Microservice in arrangement.yml,

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

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

2. Enable a port for health check API in Ingester (For example, 12500 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}
     depends_on:
       - db-service1
       - db-service2
       - db-service3
     ports:
       - "12500:8080"
       - "12501: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-arrangement-data-ingester

API Health Check

Arrangement 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:8300/ms-arrangement-api/api/v1.0.0/health/api/

Ingester Health Check

Arrangement 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:12500/ms-arrangement-data-ingester/v1.0.0/health/ingester

K8

Follow the steps below to configure health check for Arrangements Microservice in values.yaml and arrangement-api-config.yaml (Configurations are enabled by default from the Product Team).

API Container

Set the environment variable className_getHealthCheck and port to enable API health check.

Ingester Container