heartbeat

README

heartbeat

A simple NATS Heartbeat lib

Documentation

Index

• Constants
• type Handler
  • func NewHandler(id string, nc *nats.Conn, hos ...Option) *Handler
  • func (h *Handler) Close()
  • func (h *Handler) GetConsumers() []string
  • func (h *Handler) ListenForConsumers()
  • func (h *Handler) ListenForHeartbeatPublisher()
  • func (h *Handler) StartHeartbeatPublisher()
• type MetricsHandler
• type NilMetrics
  • func NewNilMetrics() *NilMetrics
  • func (m *NilMetrics) RecordConsumerRegistered(ctx context.Context, id string, current int)
  • func (m *NilMetrics) ResetConsumerRegistered(ctx context.Context)
• type Option
  • func SetConsumerRegisterTopic(topic string) Option
  • func SetCurrentConsumersTopic(topic string) Option
  • func SetHeartbeatTickerTime(ti time.Duration) Option
  • func SetHeartbeatTopic(topic string) Option
  • func SetLogger(l logrus.FieldLogger) Option
  • func SetMetrics(m MetricsHandler) Option
  • func SetMetricsTimeout(t time.Duration) Option

Constants

const (
	PublisherTopic        = "peer-heartbeat"
	ConsumerRegisterTopic = "peer-consumer-register"
	CurrentConsumersTopic = "peer-consumers"
	TickerTime            = 30 * time.Second
	MetricsTimeout        = 2 * time.Second
)

Types

type Handler

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

func NewHandler

func NewHandler(id string, nc *nats.Conn, hos ...Option) *Handler

func (*Handler) Close

func (h *Handler) Close()

func (*Handler) GetConsumers

func (h *Handler) GetConsumers() []string

func (*Handler) ListenForConsumers

func (h *Handler) ListenForConsumers()

func (*Handler) ListenForHeartbeatPublisher

func (h *Handler) ListenForHeartbeatPublisher()

func (*Handler) StartHeartbeatPublisher

func (h *Handler) StartHeartbeatPublisher()

type MetricsHandler

type MetricsHandler interface {
	RecordConsumerRegistered(ctx context.Context, id string, current int)
	ResetConsumerRegistered(ctx context.Context)
}

type NilMetrics

type NilMetrics struct {
}

func NewNilMetrics

func NewNilMetrics() *NilMetrics

func (*NilMetrics) RecordConsumerRegistered

func (m *NilMetrics) RecordConsumerRegistered(ctx context.Context, id string, current int)

func (*NilMetrics) ResetConsumerRegistered

func (m *NilMetrics) ResetConsumerRegistered(ctx context.Context)

type Option

type Option func(h *Handler)

func SetConsumerRegisterTopic

func SetConsumerRegisterTopic(topic string) Option

func SetCurrentConsumersTopic

func SetCurrentConsumersTopic(topic string) Option

func SetHeartbeatTickerTime

func SetHeartbeatTickerTime(ti time.Duration) Option

func SetHeartbeatTopic

func SetHeartbeatTopic(topic string) Option

func SetLogger

func SetLogger(l logrus.FieldLogger) Option

func SetMetrics

func SetMetrics(m MetricsHandler) Option

func SetMetricsTimeout

func SetMetricsTimeout(t time.Duration) Option