consensus

Documentation

Index

• type MetricsConsumer
  • func NewMetricsConsumer(metrics module.HotstuffMetrics) *MetricsConsumer
  • func (c *MetricsConsumer) OnEnteringView(view uint64, leader flow.Identifier)
  • func (c *MetricsConsumer) OnQcIncorporated(qc *flow.QuorumCertificate)
  • func (c *MetricsConsumer) OnQcTriggeredViewChange(qc *flow.QuorumCertificate, newView uint64)
  • func (c *MetricsConsumer) OnReachedTimeout(info *model.TimerInfo)
  • func (c *MetricsConsumer) OnStartingTimeout(info *model.TimerInfo)

Types

type MetricsConsumer

type MetricsConsumer struct {
	// inherit from noop consumer in order to satisfy the full interface
	notifications.NoopConsumer
	// contains filtered or unexported fields
}

MetricsConsumer is a consumer that subscribes to hotstuff events and collects metrics data when certain events trigger. It depends on Metrics module to report metrics data.

func NewMetricsConsumer

func NewMetricsConsumer(metrics module.HotstuffMetrics) *MetricsConsumer

func (*MetricsConsumer) OnEnteringView

func (c *MetricsConsumer) OnEnteringView(view uint64, leader flow.Identifier)

func (*MetricsConsumer) OnQcIncorporated

func (c *MetricsConsumer) OnQcIncorporated(qc *flow.QuorumCertificate)

func (*MetricsConsumer) OnQcTriggeredViewChange

func (c *MetricsConsumer) OnQcTriggeredViewChange(qc *flow.QuorumCertificate, newView uint64)

func (*MetricsConsumer) OnReachedTimeout

func (c *MetricsConsumer) OnReachedTimeout(info *model.TimerInfo)

func (*MetricsConsumer) OnStartingTimeout

func (c *MetricsConsumer) OnStartingTimeout(info *model.TimerInfo)