healthz

Documentation

Overview

Package healthz provides HTTP healthz handling.

Index

• func Handler(name string, errFn func(string), checks ...HealthChecker) http.Handler
• type HealthChecker
  • func NamedCheck(name string, check func(*http.Request) error) HealthChecker

Functions

func Handler

func Handler(name string, errFn func(string), checks ...HealthChecker) http.Handler

Handler returns an HTTP check handler.

Types

type HealthChecker

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

HealthChecker represents a named health checker.

var PingHealth HealthChecker = ping{}

PingHealth returns true when called.

func NamedCheck

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

NamedCheck returns a named health check.