controller-runtime: Index | Files

package healthz

import ""

Package healthz contains helpers from supporting liveness and readiness endpoints. (often referred to as healthz and readyz, respectively).

This package draws heavily from the apiserver's healthz package ( ) but has some changes to bring it in line with controller-runtime's style.

The main entrypoint is the Handler -- this serves both aggregated health status and individual health check endpoints.


Package Files

doc.go healthz.go

type CheckHandler Uses

type CheckHandler struct {

CheckHandler is an http.Handler that serves a health check endpoint at the root path, based on its checker.

func (CheckHandler) ServeHTTP Uses

func (h CheckHandler) ServeHTTP(resp http.ResponseWriter, req *http.Request)

type Checker Uses

type Checker func(req *http.Request) error

Checker knows how to perform a health check.

var Ping Checker = func(_ *http.Request) error { return nil }

Ping returns true automatically when checked

type Handler Uses

type Handler struct {
    Checks map[string]Checker

Handler is an http.Handler that aggregates the results of the given checkers to the root path, and supports calling individual checkers on subpaths of the name of the checker.

Adding checks on the fly is *not* threadsafe -- use a wrapper.

func (*Handler) ServeHTTP Uses

func (h *Handler) ServeHTTP(resp http.ResponseWriter, req *http.Request)

Package healthz imports 7 packages (graph) and is imported by 58 packages. Updated 2020-12-04. Refresh now. Tools for package owners.