Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Below is the list of endpoints configured with examples of usage (curl using localhost:8080 as host example). 

Endpoints

Info: /manage/info

The endpoint provides information about the application build (content of /META-INF/build-info.properties files)

Code Block
languagebash
themeDJango
$ curl http://localhost:8080/manage/info -i -X GET

Health: /manage/health

The set of endpoints providing the current status of various components and the application in general.

The status returned is one of below:

  • UP →  The component or subsystem is working as expected.
  • DOWN → The component is not working.
  • OUT_OF_SERVICE → The component is out of service temporarily.
  • UNKNOWN →  The component state is unknown.

The following separate components are configured for health status check

  • /manage/health/db - provides information on database type and connectivity state
  • /manage health/diskSpace - provides information on current disk space usage and threshold configured
  • /manage/health/ping - ability to be pinged (always UP)
Code Block
languagebash
$ curl http://localhost:8080/manage/health -i -X GET
$ curl http://localhost:8080/manage/health/db -i -X GET
$ curl http://localhost:8080/manage/health/diskSpace -i -X GET
$ curl http://localhost:8080/manage/health/infoping -i -X GET

...

The following endpoints are exposed to provide readiness and liveness probes for containerized application management
systems like kubernetes

  • /manage/health/readiness - indicates the application completed the initialization state and ready to accept the requests
  • /manage/health/liveness - indicates the application is up and running, no need to restart the container
Code Block
languagebash
$ curl http://localhost:8080/manage/health/readiness -i -X GET
$ curl http://localhost:8080/manage/health/liveness -i -X GET

Loggers

Resources