Check application health

IDE Services provides the /actuator/health endpoint to monitor the operational status of your application instance. It relies on Spring Boot Actuator to expose the health status, readiness, and liveliness of the application. To learn more, refer to the Spring documentation.

If the endpoint returns HTTP code 200, the result will look similar to this example:

    {
      "status":"UP",
      "groups": [
        "liveness",
        "readiness"
      ]
    }
  

In case you require more details, for example, if the endpoint returned HTTP code 503, you can add the Authorization header containing an automation token to the request and try again. The endpoint will return an extended response.

    {
      "status": "UP",
      "components": {
        "codeWithMeHealthCheck": {
          "status": "UP"
        },
        "licenseVaultHealthCheck": {
          "status": "UP"
        },
        "livenessState": {
          "status": "UP"
        },
        "ping": {
          "status": "UP"
        },
        "r2dbc": {
          "status": "UP",
          "details": {
            "database": "PostgreSQL",
            "validationQuery": "validate(REMOTE)"
          }
        },
        "readinessState": {
          "status": "UP"
        },
        "refreshScope": {
          "status": "UP"
        }
      },
      "groups": [
        "liveness",
        "readiness"
      ]
    }
  

Configure readiness and liveness probes

Follow this example to enable health checks and configure readiness and liveness probes in your Kubernetes infrastructure:

            probes:
                readinessProbe:
                    httpGet:
                        path: "/actuator/health/readiness"
                        port: http
                    initialDelaySeconds: 30
                    periodSeconds: 10
                    timeoutSeconds: 3

                livenessProbe:
                    httpGet:
                        path: "/actuator/health/liveness"
                        port: http
                    initialDelaySeconds: 30
                    periodSeconds: 10
                    timeoutSeconds: 3
        

For more information, refer to the Kubernetes documentation.

Last modified: 15 July 2024