heartbeats

Documentation

Index

• func Invoke(*Heartbeats)
• func Module() fx.Option
• func PeersWatcherModule() fx.Option
• type ConstructorIn
• type Heartbeats
  • func Provide(in ConstructorIn) (*Heartbeats, error)
  • func (h *Heartbeats) GetControllerInfo() *heartbeatv1.ControllerInfo
• type PeersOut

Functions

func Invoke

func Invoke(*Heartbeats)

Invoke enables heartbeats in FX.

func Module

func Module() fx.Option

Module returns the module for heartbeats.

func PeersWatcherModule

func PeersWatcherModule() fx.Option

PeersWatcherModule is a fx module that watches all agent peers.

Types

type ConstructorIn

type ConstructorIn struct {
	fx.In

	Lifecycle                  fx.Lifecycle
	Unmarshaller               config.Unmarshaller
	JobGroup                   *jobs.JobGroup                     `name:"heartbeats-job-group"`
	GRPClientConnectionBuilder grpcclient.ClientConnectionBuilder `name:"heartbeats-grpc-client"`
	HTTPClient                 *http.Client                       `name:"heartbeats-http-client"`
	StatusRegistry             status.Registry
	EntityCache                *entitycache.EntityCache `optional:"true"`
	AgentInfo                  *agentinfo.AgentInfo     `optional:"true"`
	PeersWatcher               *peers.PeerDiscovery     `name:"fluxninja-peers-watcher" optional:"true"`
	EtcdClient                 *etcdclient.Client
}

ConstructorIn injects dependencies into the Heartbeats constructor.

type Heartbeats

type Heartbeats struct {
	APIKey string
	// contains filtered or unexported fields
}

func Provide

func Provide(in ConstructorIn) (*Heartbeats, error)

Provide provides a new instance of Heartbeats.

func (*Heartbeats) GetControllerInfo

func (h *Heartbeats) GetControllerInfo() *heartbeatv1.ControllerInfo

type PeersOut

type PeersOut struct {
	fx.Out
	PeerWatcher *peers.PeerDiscovery `name:"fluxninja-peers-watcher" optional:"true"`
}

PeersOut is a return struct provided to fx.