health

Documentation

Index

• func InitHeartbeat(parent tally.Scope, config Config, candidate leader.Candidate)
• type Config
• type Heartbeat
• type Metrics
  • func NewMetrics(scope tally.Scope) *Metrics

Functions

func InitHeartbeat

func InitHeartbeat(
	parent tally.Scope,
	config Config,
	candidate leader.Candidate)

InitHeartbeat inits heartbeat

Types

type Config

type Config struct {
	// Heartbeat interval
	HeartbeatInterval time.Duration `yaml:"heartbeat_interval"`
}

Config is the placeholder for health related configs

type Heartbeat

type Heartbeat interface {
	Start()
	Stop()
}

Heartbeat is the heartbeat interface

type Metrics

type Metrics struct {
	Init      tally.Counter
	Heartbeat tally.Gauge
	Leader    tally.Gauge
}

Metrics is a placeholder for all metrics in health package.

func NewMetrics

func NewMetrics(scope tally.Scope) *Metrics

NewMetrics returns a new instance of Metrics.