healthz

Documentation

Index

• func RegisterCheck(name string, check HealthCheck)
• func Status(ctx context.Context) map[string]error
• type HealthCheck

Functions

func RegisterCheck

func RegisterCheck(name string, check HealthCheck)

RegisterCheck adds a new check to the global register. If a check with the given name already exists, the function will panic.

func Status

func Status(ctx context.Context) map[string]error

Status runs all of the currently registered health checks and returns a map of the results.

Types

type HealthCheck

type HealthCheck func(ctx context.Context) error

HealthCheck is a function that returns an error if a component is unhealthy. The application's overall health depends on the set of registered HealthChecks returning nil errors.