vertx / io.vertx.ext.healthchecks

Package io.vertx.ext.healthchecks

Types

HealthCheckHandler

interface HealthCheckHandler : Handler<RoutingContext>

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

HealthChecks

interface HealthChecks

Status

open class Status

Represents the outcome of a health check procedure. Each procedure produces a Status indicating either OK or KO. Optionally, it can also provide additional data.

StatusConverter

open class StatusConverter

Converter for io.vertx.ext.healthchecks.Status. NOTE: This class has been automatically generated from the io.vertx.ext.healthchecks.Status original class using Vert.x codegen.