healthz

Documentation

Overview

Package healthz implements basic http server health checking. Usage:

import _ "healthz" registers a handler on the path '/healthz', that serves 200s

Index

• func DefaultHealthz(checks ...HealthzChecker)
• func InstallHandler(mux mux, checks ...HealthzChecker)
• type HealthzChecker
  • func NamedCheck(name string, check func(r *http.Request) error) HealthzChecker

Functions

func DefaultHealthz

func DefaultHealthz(checks ...HealthzChecker)

DefaultHealthz installs the default healthz check to the http.DefaultServeMux.

func InstallHandler

func InstallHandler(mux mux, checks ...HealthzChecker)

InstallHandler registers a handler for health checking on the path "/healthz" to mux.

Types

type HealthzChecker

type HealthzChecker interface {
	Name() string
	Check(req *http.Request) error
}

HealthzChecker is a named healthz check.

var PingHealthz HealthzChecker = ping{}

PingHealthz returns true automatically when checked

func NamedCheck

func NamedCheck(name string, check func(r *http.Request) error) HealthzChecker

NamedCheck returns a health checker for the given name and function.