health

Documentation

Index

• Constants
• type HealthCheckConfig
  • func DefaultHealthConfig() *HealthCheckConfig
• type HealthCheckResult
• type HealthChecker
• type HealthMonCheck
• type HealthMonitor
• type JSONRepresentation
  • func (jsonRepr *JSONRepresentation) MarshalJSON() ([]byte, error)
• type Status
  • func NewStatus(s string) Status
  • func (s Status) Bad() bool
  • func (s Status) Good() bool
  • func (s Status) Idling() bool
  • func (s Status) String() string
• type WithHealthInfo

Constants

const (
	StatusUnknown Status = 0
	StatusHealthy        = (1 << iota)
	StatusNapping
	StatusStarting
	StatusUnhealthy
	StatusError

	NumStatuses int = iota - 1

	HealthyMask = StatusHealthy | StatusNapping | StatusStarting
	IdlingMask  = StatusNapping | StatusStarting
)

Types

type HealthCheckConfig

type HealthCheckConfig struct {
	Disable  bool          `json:"disable,omitempty" aliases:"disabled"`
	Path     string        `json:"path,omitempty" validate:"omitempty,uri,startswith=/"`
	UseGet   bool          `json:"use_get,omitempty"`
	Interval time.Duration `json:"interval" validate:"omitempty,min=1s"`
	Timeout  time.Duration `json:"timeout" validate:"omitempty,min=1s"`
}

func DefaultHealthConfig

func DefaultHealthConfig() *HealthCheckConfig

type HealthCheckResult

type HealthCheckResult struct {
	Healthy bool          `json:"healthy"`
	Detail  string        `json:"detail"`
	Latency time.Duration `json:"latency"`
}

type HealthChecker

type HealthChecker interface {
	CheckHealth() (result *HealthCheckResult, err error)
	URL() *url.URL
	Config() *HealthCheckConfig
	UpdateURL(url *url.URL)
}

type HealthMonCheck

type HealthMonCheck interface {
	HealthMonitor
	HealthChecker
}

type HealthMonitor

type HealthMonitor interface {
	task.TaskStarter
	task.TaskFinisher
	fmt.Stringer
	WithHealthInfo
	Name() string
	json.Marshaler
}

type JSONRepresentation

type JSONRepresentation struct {
	Name     string
	Config   *HealthCheckConfig
	Status   Status
	Started  time.Time
	Uptime   time.Duration
	Latency  time.Duration
	LastSeen time.Time
	Detail   string
	URL      *url.URL
	Extra    map[string]any
}

func (*JSONRepresentation) MarshalJSON

func (jsonRepr *JSONRepresentation) MarshalJSON() ([]byte, error)

type Status

type Status uint8

func NewStatus

func NewStatus(s string) Status

func (Status) Bad

func (s Status) Bad() bool

func (Status) Good

func (s Status) Good() bool

func (Status) Idling

func (s Status) Idling() bool

func (Status) String

func (s Status) String() string

type WithHealthInfo

type WithHealthInfo interface {
	Status() Status
	Uptime() time.Duration
	Latency() time.Duration
}