Documentation
¶
Index ¶
- Constants
- type Handler
- func (h *Handler) Alive(rw http.ResponseWriter, r *http.Request, _ httprouter.Params)
- func (h *Handler) Ready(rw http.ResponseWriter, r *http.Request, _ httprouter.Params)
- func (h *Handler) SetRoutes(r *httprouter.Router)
- func (h *Handler) Version(rw http.ResponseWriter, r *http.Request, _ httprouter.Params)
- type ReadyChecker
Constants ¶
const ( AliveCheckPath = "/health/alive" ReadyCheckPath = "/health/ready" VersionPath = "/version" MetricsPrometheusPath = "/metrics/prometheus" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Handler ¶
type Handler struct {
H *herodot.JSONWriter
VersionString string
ReadyChecks map[string]ReadyChecker
}
func (*Handler) Alive ¶ added in v0.11.13
func (h *Handler) Alive(rw http.ResponseWriter, r *http.Request, _ httprouter.Params)
swagger:route GET /health/alive health isInstanceAlive
Check the Alive Status ¶
This endpoint returns a 200 status code when the HTTP server is up running. This status does currently not include checks whether the database connection is working. This endpoint does not require the `X-Forwarded-Proto` header when TLS termination is set.
Be aware that if you are running multiple nodes of ORY Hydra, the health status will never refer to the cluster state, only to a single instance.
Responses: 200: healthStatus 500: genericError
func (*Handler) Ready ¶ added in v0.11.13
func (h *Handler) Ready(rw http.ResponseWriter, r *http.Request, _ httprouter.Params)
swagger:route GET /health/ready health isInstanceReady
Check the Readiness Status ¶
This endpoint returns a 200 status code when the HTTP server is up running and the environment dependencies (e.g. the database) are responsive as well.
This status does currently not include checks whether the database connection is working. This endpoint does not require the `X-Forwarded-Proto` header when TLS termination is set.
Be aware that if you are running multiple nodes of ORY Hydra, the health status will never refer to the cluster state, only to a single instance.
Responses: 200: healthStatus 503: healthNotReadyStatus
func (*Handler) SetRoutes ¶
func (h *Handler) SetRoutes(r *httprouter.Router)
func (*Handler) Version ¶ added in v0.11.13
func (h *Handler) Version(rw http.ResponseWriter, r *http.Request, _ httprouter.Params)
swagger:route GET /version version getVersion
Get the version of Hydra ¶
This endpoint returns the version as `{ "version": "VERSION" }`. The version is only correct with the prebuilt binary and not custom builds.
Responses: 200: version
type ReadyChecker ¶ added in v0.11.13
type ReadyChecker func() error
Source Files