health

Documentation

Index

• type Handler
  • func (h *Handler) Health(rw http.ResponseWriter, r *http.Request, _ httprouter.Params)
  • func (h *Handler) SetRoutes(r *httprouter.Router)
  • func (h *Handler) Statistics(w http.ResponseWriter, r *http.Request, ps httprouter.Params)

Types

type Handler

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

func (*Handler) Health

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

swagger:route GET /health health

Check health status of instance

This endpoint does not require the `X-Forwarded-Proto` header when TLS termination is set.

Responses:
  200: healthStatus
  500: genericError

func (*Handler) SetRoutes

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

func (*Handler) Statistics

func (h *Handler) Statistics(w http.ResponseWriter, r *http.Request, ps httprouter.Params)

swagger:route GET /health/stats health getStatistics

Show instance statistics

This endpoint returns information on the instance's health. It is currently not documented.

The subject making the request needs to be assigned to a policy containing:

```

{
  "resources": ["rn:hydra:health:stats"],
  "actions": ["get"],
  "effect": "allow"
}

```

Consumes:
- application/json

Produces:
- application/json

Schemes: http, https

Security:
  oauth2: hydra.health

Responses:
  200: emptyResponse
  401: genericError
  403: genericError
  500: genericError