health

Documentation

Index

• Variables
• type DefaultHealthEventManager
  • func NewDefaultHealthEventManager(listeners ...ReadinessProbe) (*DefaultHealthEventManager, error)
  • func (h *DefaultHealthEventManager) Dispatch(event ReadinessProbeEvent)
  • func (h *DefaultHealthEventManager) HealthxReadyCheckers() healthx.ReadyCheckers
  • func (h *DefaultHealthEventManager) Watch(ctx context.Context)
• type EventManager
• type ReadinessProbe
• type ReadinessProbeEvent

Variables

var ErrEventTypeAlreadyRegistered = errors.New("event type already registered")

Types

type DefaultHealthEventManager

type DefaultHealthEventManager struct {
	// contains filtered or unexported fields
}

func NewDefaultHealthEventManager

func NewDefaultHealthEventManager(listeners ...ReadinessProbe) (*DefaultHealthEventManager, error)

func (*DefaultHealthEventManager) Dispatch

func (h *DefaultHealthEventManager) Dispatch(event ReadinessProbeEvent)

func (*DefaultHealthEventManager) HealthxReadyCheckers

func (h *DefaultHealthEventManager) HealthxReadyCheckers() healthx.ReadyCheckers

func (*DefaultHealthEventManager) Watch

func (h *DefaultHealthEventManager) Watch(ctx context.Context)

type EventManager

type EventManager interface {
	Dispatch(event ReadinessProbeEvent)
	Watch(ctx context.Context)
	HealthxReadyCheckers() healthx.ReadyCheckers
}

type ReadinessProbe

type ReadinessProbe interface {
	ID() string
	Validate() error

	EventTypes() []ReadinessProbeEvent
	EventsReceiver(event ReadinessProbeEvent)
}

type ReadinessProbeEvent

type ReadinessProbeEvent interface {
	ReadinessProbeListenerID() string
}