health

package

v0.0.0-...-c0686e8 Latest Latest Go to latest Published: Dec 10, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

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

InitHeartbeat inits heartbeat

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

Config is the placeholder for health related configs

type Heartbeat interface {
	Start()
	Stop()
}

Heartbeat is the heartbeat interface

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

Metrics is a placeholder for all metrics in health package.

func NewMetrics(scope tally.Scope) *Metrics

NewMetrics returns a new instance of Metrics.