healthcheck

Documentation

Index

• Constants
• func Register(hc *HealthCheck)
• func Status() *hcproto.Response
• type HealthCheck
• type Sample

Constants

const (
	StandardInterval = time.Minute
	StandardPriority = hc.Warning
)

Functions

func Register

func Register(hc *HealthCheck)

Register will add a healthcheck to our registry, causing it to be tested periodically and reported on

func Status

func Status() *hcproto.Response

Status

Types

type HealthCheck

type HealthCheck struct {
	Id             string        `json:"-"`
	ServiceName    string        `json:"-"`
	ServiceVersion uint64        `json:"-"`
	Hostname       string        `json:"-"`
	InstanceId     string        `json:"-"`
	Checker        hc.Checker    `json:"-"`
	Interval       time.Duration `json:"interval"`
	Priority       hc.Priority   `json:"priority"`
}

HealthCheck represents a single health check

type Sample

type Sample struct {
	At               time.Time
	IsHealthy        bool
	ErrorDescription string
	Measurements     map[string]string
}

Sample represents the results of a single health check sample