health

Documentation

Index

• type Action
• type ActionDefinition
  • func (self *ActionDefinition) CreateAction() (Action, error)
  • func (self *ActionDefinition) Description() string
• type BaseCheckDefinition
  • func (self *BaseCheckDefinition) CreateActions() ([]Action, error)
  • func (self *BaseCheckDefinition) GetInterval() time.Duration
  • func (self *BaseCheckDefinition) GetTimeout() time.Duration
• type Check
• type CheckDefinition
• type HttpCheckDefinition
  • func (self *HttpCheckDefinition) CreateCheck(name string) (Check, error)
  • func (self *HttpCheckDefinition) GetType() string
  • func (self *HttpCheckDefinition) String() string
• type Manager
  • func NewManager() Manager
• type PortCheckDefinition
  • func (self *PortCheckDefinition) CreateCheck(name string) (Check, error)
  • func (self *PortCheckDefinition) GetType() string
  • func (self *PortCheckDefinition) String() string
• type ServiceState
  • func NewServiceState(service string, precedence ziti.Precedence, cost uint16, ...) *ServiceState
  • func NewServiceStateWithContext(service, hostContext string, precedence ziti.Precedence, cost uint16, ...) *ServiceState
  • func (self *ServiceState) HandleActionResults(healthy bool)
  • func (self *ServiceState) IsChanged() bool
• type ServiceUpdater

Types

type Action

type Action interface {
	Matches(result *health.Result) bool
	Invoke(state *ServiceState)
	Description() string
}

type ActionDefinition

type ActionDefinition struct {
	Trigger           string
	ConsecutiveEvents *uint16
	Duration          *time.Duration
	Action            string
}

func (*ActionDefinition) CreateAction

func (self *ActionDefinition) CreateAction() (Action, error)

func (*ActionDefinition) Description

func (self *ActionDefinition) Description() string

type BaseCheckDefinition

type BaseCheckDefinition struct {
	Interval time.Duration
	Timeout  time.Duration
	Actions  []*ActionDefinition
}

func (*BaseCheckDefinition) CreateActions

func (self *BaseCheckDefinition) CreateActions() ([]Action, error)

func (*BaseCheckDefinition) GetInterval

func (self *BaseCheckDefinition) GetInterval() time.Duration

func (*BaseCheckDefinition) GetTimeout

func (self *BaseCheckDefinition) GetTimeout() time.Duration

type Check

type Check interface {
	Name() string
	Execute(context context.Context) (details interface{}, err error)
}

type CheckDefinition

type CheckDefinition interface {
	GetType() string
	GetInterval() time.Duration
	GetTimeout() time.Duration
	CreateCheck(name string) (Check, error)
	CreateActions() ([]Action, error)
	fmt.Stringer
}

type HttpCheckDefinition

type HttpCheckDefinition struct {
	BaseCheckDefinition `mapstructure:",squash"`
	Url                 string
	Method              string
	Body                string
	ExpectStatus        int
	ExpectBody          string
}

func (*HttpCheckDefinition) CreateCheck

func (self *HttpCheckDefinition) CreateCheck(name string) (Check, error)

func (*HttpCheckDefinition) GetType

func (self *HttpCheckDefinition) GetType() string

func (*HttpCheckDefinition) String

func (self *HttpCheckDefinition) String() string

type Manager

type Manager interface {
	RegisterServiceChecks(service *ServiceState, checkDefinitions []CheckDefinition) error
	UnregisterServiceChecks(service string)
	UnregisterServiceContextChecks(service, context string)
	Shutdown()
}

func NewManager

func NewManager() Manager

type PortCheckDefinition

type PortCheckDefinition struct {
	BaseCheckDefinition `mapstructure:",squash"`
	Address             string
}

func (*PortCheckDefinition) CreateCheck

func (self *PortCheckDefinition) CreateCheck(name string) (Check, error)

func (*PortCheckDefinition) GetType

func (self *PortCheckDefinition) GetType() string

func (*PortCheckDefinition) String

func (self *PortCheckDefinition) String() string

type ServiceState

type ServiceState struct {
	Service     string
	HostContext string

	BaselinePrecedence edge.Precedence

	BaselineCost uint16
	Updater      ServiceUpdater
	// contains filtered or unexported fields
}

func NewServiceState

func NewServiceState(service string, precedence ziti.Precedence, cost uint16, updater ServiceUpdater) *ServiceState

func NewServiceStateWithContext

func NewServiceStateWithContext(service, hostContext string, precedence ziti.Precedence, cost uint16, updater ServiceUpdater) *ServiceState

func (*ServiceState) HandleActionResults

func (self *ServiceState) HandleActionResults(healthy bool)

func (*ServiceState) IsChanged

func (self *ServiceState) IsChanged() bool

type ServiceUpdater

type ServiceUpdater interface {
	UpdateCostAndPrecedence(cost uint16, precedence edge.Precedence) error
	SendHealthEvent(pass bool) error
}