health

Documentation

Index

• Constants
• type Handler
  • func (h *Handler) Health(rw http.ResponseWriter, r *http.Request, _ httprouter.Params)
  • func (h *Handler) PrefixResource(resource string) string
  • func (h *Handler) SetRoutes(r *httprouter.Router)

Constants

const (
	HealthStatusPath = "/health/status"
)

Types

type Handler

type Handler struct {
	Metrics        *metrics.MetricsManager
	H              *herodot.JSONWriter
	W              firewall.Firewall
	ResourcePrefix string
}

func (*Handler) Health

func (h *Handler) Health(rw http.ResponseWriter, r *http.Request, _ httprouter.Params)

swagger:route GET /health/status health getInstanceStatus

Check the Health Status

This endpoint returns a 200 status code when the HTTP server is up running. `{ "status": "ok" }`. 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) PrefixResource

func (h *Handler) PrefixResource(resource string) string

func (*Handler) SetRoutes

func (h *Handler) SetRoutes(r *httprouter.Router)