Application Health Check Endpoints

Every Oracle Health Insurance application exposes Application Health Check endpoints. You can access these endpoints without authentication.

Health Check Endpoint

The Health Check endpoint provides the basic information (JSON document) about the deployment and state of the Oracle Health Insurance application.

By default, this endpoint is available at:

http://[hostName]:[portNumber]/[api-context-root]/health

You can change this URL context root by changing the deployment plan of the application’s Healthcheck WEB module.

Sample Response

{
  "status": "UP"
}

If the application is running, it is in the UP status.

The Health Check endpoint returns the following statuses:

  • 200: The node is healthy.

  • 429: The node is busy with existing requests.

Readiness Check Endpoint

The Readiness Check endpoint checks whether the application is able to process requests or not. It provides the readiness information (JSON document) about the deployment and state of the Oracle Health Insurance application.

A number of readiness checks are available, such as memory, database connectivity, and CPU utilisation. You can define the threshold limit for CPU utilisation by the optional system property ohi.system.cpu.threshold.high.

By default, the Readiness Check endpoint is available at:

http://[hostName]:[portNumber]/[api-context-root]/health/ready

Sample Response

{
  "status": "UP",
  "checks": [
    {
      "name": "db-connection",
      "state": "UP"
    },
    {
      "name": "cpu",
      "state": "UP"
    },
    {
      "name": "memory",
      "state": "UP"
    }
  ]
}

If the application is running, and all the readiness checks report UP, it is in the UP status.

The Readiness Check endpoint returns the following statuses:

  • 200: The node is healthy.

  • 429: The node is busy with existing requests.

Liveliness Check Endpoint

The Liveliness Check endpoint checks whether the application is still alive or not. It provides the liveliness information (JSON document) about the deployment and state of the Oracle Health Insurance application.

The liveliness check uses the Coherence Health Check API. See Using the Health Check API for more info.

By default, the Liveliness Check endpoint is available at:

 http://[hostName]:[portNumber]/[api-context-root]/health/live

Sample Response

{
  "status": "UP",
  "checks": [
    {
      "name": "cluster",
      "state": "UP"
    }
  ]
}

If the application is running, and all the liveliness checks report UP, it is in the UP status.

The Liveliness Check endpoint returns the following statuses:

  • 200: The node is healthy.

  • 429: The node is dead.