Health Check Endpoint

Germain service health endpoint is a way of representing germain service health for monitoring and alerting purposes. Germain UX exposes metrics for the following services and their respective paths.

All these endpoints are exposed with authentication, so user needs to have a valid session to consume these endpoints.

Action: <HOST>:<PORT>/actuator/health
Aggregation: <HOST>:<PORT>/actuator/health
Analytics: <HOST>:<PORT>/actuator/health
Server REST: <HOST>:<PORT>/actuator/health
Server Ingestion: <HOST>:<PORT>/ingestion/actuator/health
Session: <HOST>:<PORT>/actuator/health
Storage: <HOST>:<PORT>/actuator/health

It exposes a high-level health metric for each as a whole, and also some individual metrics for components:

The output of the endpoint is shown below as an example

CODE

{
  "status": "UP",
  "components": {
    "db": {
      "status": "UP",
      "details": {
        "database": "MySQL",
        "validationQuery": "isValid()"
      }
    },
    "discoveryComposite": {
      "status": "UP",
      "components": {
        "discoveryClient": {
          "description": "Discovery Client not initialized",
          "status": "UNKNOWN"
        },
        "zookeeper": {
          "status": "UP",
          "details": {
            "services": []
          }
        }
      }
    },
    "diskSpace": {
      "status": "UP",
      "details": {
        "total": 260143104000,
        "free": 193304309760,
        "threshold": 10485760,
        "path": "/opt/tomcat/.",
        "exists": true
      }
    },
    "mail": {
      "status": "UP",
      "details": {
        "location": "email-smtp.yourdomain.com:587"
      }
    },
    "ping": {
      "status": "UP"
    },
    "refreshScope": {
      "status": "UP"
    },
    "zookeeper": {
      "status": "UP",
      "details": {
        "connectionString": "germainapm-zookeeper:2181",
        "state": "STARTED"
      }
    }
  }
}

Feature Availability: 2023.1 or later