health

Documentation

Index

• type Aggregator
  • func NewAggregator(opts ...AggregatorOption) *Aggregator
  • func (h *Aggregator) AddClient(name string, client controlv1.HealthClient)
  • func (h *Aggregator) GetHealth(ctx context.Context, _ *emptypb.Empty) (*corev1.Health, error)
  • func (h *Aggregator) RemoveClient(name string)
• type AggregatorOption
  • func WithStaticAnnotations(staticAnnotations map[string]string) AggregatorOption
• type AggregatorOptions
• type HealthClientSet
• type HealthStatusQuerier
• type HealthStatusUpdater
• type HealthUpdate
• type Listener
  • func NewListener(opts ...ListenerOption) *Listener
  • func (l *Listener) AlertDisconnectLoop(agentId string)
  • func (l *Listener) Close()
  • func (l *Listener) HandleAgentConnection(ctx context.Context, clientset agentv1.ClientSet)
  • func (l *Listener) HandleConnection(ctx context.Context, clientset HealthClientSet)
  • func (l *Listener) HealthC() chan HealthUpdate
  • func (l *Listener) StatusC() chan StatusUpdate
  • func (l *Listener) UpdateHealth(ctx context.Context, req *corev1.Health) (*emptypb.Empty, error)
• type ListenerOption
  • func WithAlertProvider(alertProvider *alerting.Provider) ListenerOption
  • func WithAlertToggle() ListenerOption
  • func WithDefaultAlertCondition() ListenerOption
  • func WithDisconnectTimeout(timeout time.Duration) ListenerOption
  • func WithMaxConnections(max int64) ListenerOption
  • func WithMaxJitter(duration time.Duration) ListenerOption
  • func WithPollInterval(interval time.Duration) ListenerOption
  • func WithUpdateQueueCap(cap int) ListenerOption
• type ListenerOptions
• type Monitor
  • func NewMonitor(opts ...MonitorOption) *Monitor
  • func (m *Monitor) GetHealthStatus(id string) *corev1.HealthStatus
  • func (m *Monitor) Run(ctx context.Context, updater HealthStatusUpdater)
  • func (m *Monitor) WatchHealthStatus(ctx context.Context, id string) <-chan *corev1.HealthStatus
• type MonitorOption
  • func WithLogger(lg *zap.SugaredLogger) MonitorOption
• type MonitorOptions
• type StatusUpdate

Types

type Aggregator

type Aggregator struct {
	controlv1.UnsafeHealthServer
	AggregatorOptions
	// contains filtered or unexported fields
}

Aggregator implements a HealthServer that queries one or more HealthClients and aggregates the results. This server will report as ready if and only if all clients report as ready.

func NewAggregator

func NewAggregator(opts ...AggregatorOption) *Aggregator

func (*Aggregator) AddClient

func (h *Aggregator) AddClient(name string, client controlv1.HealthClient)

func (*Aggregator) GetHealth

func (h *Aggregator) GetHealth(ctx context.Context, _ *emptypb.Empty) (*corev1.Health, error)

func (*Aggregator) RemoveClient

func (h *Aggregator) RemoveClient(name string)

type AggregatorOption

type AggregatorOption func(*AggregatorOptions)

func WithStaticAnnotations

func WithStaticAnnotations(staticAnnotations map[string]string) AggregatorOption

type AggregatorOptions

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

type HealthClientSet

type HealthClientSet interface {
	// rpc GetHealth(emptypb.Empty) returns (core.Health)
	GetHealth(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*corev1.Health, error)
}

type HealthStatusQuerier

type HealthStatusQuerier interface {
	GetHealthStatus(id string) *corev1.HealthStatus
	WatchHealthStatus(ctx context.Context, id string) <-chan *corev1.HealthStatus
}

type HealthStatusUpdater

type HealthStatusUpdater interface {
	StatusC() chan StatusUpdate
	HealthC() chan HealthUpdate
}

type HealthUpdate

type HealthUpdate struct {
	ID     string         `json:"id"`
	Health *corev1.Health `json:"health"`
}

type Listener

type Listener struct {
	controlv1.UnsafeHealthListenerServer
	ListenerOptions

	AlertProvider *alerting.Provider
	// contains filtered or unexported fields
}

func NewListener

func NewListener(opts ...ListenerOption) *Listener

func (*Listener) AlertDisconnectLoop

func (l *Listener) AlertDisconnectLoop(agentId string)

func (*Listener) Close

func (l *Listener) Close()

func (*Listener) HandleAgentConnection

func (l *Listener) HandleAgentConnection(ctx context.Context, clientset agentv1.ClientSet)

Implements gateway.ConnectionHandler

func (*Listener) HandleConnection

func (l *Listener) HandleConnection(ctx context.Context, clientset HealthClientSet)

func (*Listener) HealthC

func (l *Listener) HealthC() chan HealthUpdate

func (*Listener) StatusC

func (l *Listener) StatusC() chan StatusUpdate

func (*Listener) UpdateHealth

func (l *Listener) UpdateHealth(ctx context.Context, req *corev1.Health) (*emptypb.Empty, error)

Implements controlv1.HealthListenerServer

type ListenerOption

type ListenerOption func(*ListenerOptions)

func WithAlertProvider

func WithAlertProvider(alertProvider *alerting.Provider) ListenerOption

func WithAlertToggle

func WithAlertToggle() ListenerOption

func WithDefaultAlertCondition

func WithDefaultAlertCondition() ListenerOption

func WithDisconnectTimeout

func WithDisconnectTimeout(timeout time.Duration) ListenerOption

func WithMaxConnections

func WithMaxConnections(max int64) ListenerOption

Max concurrent connections. Defaults to math.MaxInt64

func WithMaxJitter

func WithMaxJitter(duration time.Duration) ListenerOption

func WithPollInterval

func WithPollInterval(interval time.Duration) ListenerOption

func WithUpdateQueueCap

func WithUpdateQueueCap(cap int) ListenerOption

Max concurrent queued updates before blocking. Defaults to 1000

type ListenerOptions

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

type Monitor

type Monitor struct {
	MonitorOptions
	// contains filtered or unexported fields
}

func NewMonitor

func NewMonitor(opts ...MonitorOption) *Monitor

func (*Monitor) GetHealthStatus

func (m *Monitor) GetHealthStatus(id string) *corev1.HealthStatus

func (*Monitor) Run

func (m *Monitor) Run(ctx context.Context, updater HealthStatusUpdater)

func (*Monitor) WatchHealthStatus

func (m *Monitor) WatchHealthStatus(ctx context.Context, id string) <-chan *corev1.HealthStatus

type MonitorOption

type MonitorOption func(*MonitorOptions)

func WithLogger

func WithLogger(lg *zap.SugaredLogger) MonitorOption

type MonitorOptions

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

type StatusUpdate

type StatusUpdate struct {
	ID     string         `json:"id"`
	Status *corev1.Status `json:"status"`
}