health

package

v0.51.1 Latest Latest Go to latest Published: Nov 6, 2026 License: Apache-2.0 Imports: 2 Imported by: 0

Details

Package health provides HTTP liveness and readiness middleware.

This section is empty.

This section is empty.

This section is empty.

type Handler struct {
	// contains filtered or unexported fields
}

Handler serves health endpoints and delegates all other requests. Readiness is atomic because startup and shutdown race with request handling.

func New(next http.Handler) *Handler

New constructs health middleware around the next request handler.

func NewAll(handlers ...*Handler) *Handler

NewAll serves health endpoints that are ready while every one of handlers is, and answers 404 to everything else.

func (h *Handler) Ready() bool

Ready reports whether the readiness endpoint reports success.

func (h *Handler) ServeHTTP(writer http.ResponseWriter, request *http.Request)

ServeHTTP serves health endpoints and delegates all other requests.

func (h *Handler) SetReady(ready bool)

SetReady changes whether the readiness endpoint reports success.