Health Check

Health Check gives the ability to monitor the health of the Campaign 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 Campaign application relies on to function correctly.

Configuration

To configure health check for Campaign Microservice in ms-campaign.yml, set the environment variable named className_getHealthCheck in the API container. Setting the environment variable enables API health check.

Enabling Health Check for API Container

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

API Health Check

Campaign microservices expose API health check endpoint to monitor the health of Microservice APIs. 

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

Sample: http://localhost:8900/ms-campaign-api/api/v1.0.0/health/api

Docker: