API Documentation
Back to top  

Classes, interfaces and traits

HealthCheckHandler

A Vert.x Web handler on which you register health check procedure. It computes the outcome status (`UP` or `DOWN`)

. When the handler process a HTTP request, it computes the global outcome and build a HTTP response as follows:

  • 204 - status is `UP` but no procedures installed (no payload)
  • 200 - status is `UP`, the payload contains the result of the installed procedures
  • 503 - status is `DOWN`, the payload contains the result of the installed procedures
  • 500 - status is `DOWN`, the payload contains the result of the installed procedures, one of the procedure has failed
« More »

HealthChecks

« More »

Status

Represents the outcome of a health check procedure. Each procedure produces a @see \io\vertx\jphp\ext\healthchecks\Status indicating either OK or KO. Optionally, it can also provide additional data.

« More »