Versions Compared

Key

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

...

The status returned is one of below:

  • UP →  The -  The component or subsystem is working as expected.
  • DOWN → The - The component is not working.
  • OUT_OF_SERVICE → The - The component is out of service temporarily.
  • UNKNOWN →  The - 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)

...

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

  • /manage/health/readiness - indicates the application completed the initialization state stage 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

Logging: /manage/loggers

The endpoint allows to retrieve information about and update the log level setting on per logger identifier basis.

The following endpoints are exposed

  • /manage/loggers - provides information about all the loggers configured
  • /manage/loggers/{logger-id} GET - retrieves log level settings for requested logger identifier
  • /manage/loggers/{logger-id} POST - updates or resets the log level settings for requested logger identifier

Getting log level information :

Code Block
languagebash
$ curl http://localhost:8080/manage/loggers -i -X GET
$ curl http://localhost:8080/manage/loggers/org.onap.cps -i -X GET

Loggers

...

Updating log level:

Code Block
languagebash
$ curl http://localhost:8080/manage/loggers/org.onap.cps -i -X POST -H 'Content-Type: application/json' -d '{"configuredLevel": "DEBUG"}'

Resetting log level:

Code Block
languagebash
$ curl http://localhost:8080/manage/loggers/org.onap.cps -i -X POST -H 'Content-Type: application/json' -d '{}'

Resources

Documentation:

Tutorials: