health

Documentation

Index

• Constants
• type HealthCheckConfig
  • func DefaultHealthConfig() *HealthCheckConfig
• type HealthCheckResult
• type HealthChecker
• type HealthMonitor
• type Status
  • func (s Status) Bad() bool
  • func (s Status) Good() bool
  • func (s Status) Idling() bool
  • func (s Status) MarshalJSON() ([]byte, error)
  • func (s Status) String() string
  • func (s *Status) UnmarshalJSON(data []byte) error
• 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() *types.URL
	Config() *HealthCheckConfig
	UpdateURL(url *types.URL)
}

type HealthMonitor

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

type Status

type Status uint8

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) MarshalJSON

func (s Status) MarshalJSON() ([]byte, error)

func (Status) String

func (s Status) String() string

func (*Status) UnmarshalJSON

func (s *Status) UnmarshalJSON(data []byte) error

type WithHealthInfo

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