hc

Documentation

Overview

Package hc provides a basic type for generic checks. With this packages, components can provide their own HealthChecker and register then for later use.

Index

• Constants
• Variables
• func AddChecker(name string, check func() error)
• type Result
  • func Check() []Result

Constants

const HealthCheckOK = "WORKING"

HealthCheckOK is the status returned when the healthcheck works.

Variables

var ErrDisabledComponent = errors.New("disabled component")

Functions

func AddChecker

func AddChecker(name string, check func() error)

AddChecker adds a new checker to the internal list of checkers. Checkers added to this list can then be checked using the Check function.

Types

type Result

type Result struct {
	Name     string
	Status   string
	Duration time.Duration
}

Result represents a result of a processed healthcheck call. It will contain the name of the healthchecker and the status returned in the checker call.

func Check

func Check() []Result

Check check the status of all registered checkers and return a list of results.