metrics

Documentation

Index

• type Metrics
  • func (m *Metrics) Accepted(id ids.ID)
  • func (m *Metrics) Initialize(metricName, descriptionName string, log logging.Logger, namespace string, ...) error
  • func (m *Metrics) Issued(id ids.ID)
  • func (m *Metrics) Rejected(id ids.ID)

Types

type Metrics

type Metrics struct {
	// Clock gives access to the current wall clock time
	Clock timer.Clock

	// ProcessingEntries keeps track of the time that each item was issued into
	// the consensus instance. This is used to calculate the amount of time to
	// accept or reject the item.
	ProcessingEntries linkedhashmap.LinkedHashmap
	// contains filtered or unexported fields
}

Metrics reports commonly used consensus metrics.

func (*Metrics) Accepted

func (m *Metrics) Accepted(id ids.ID)

Accepted marks the item as having been accepted.

func (*Metrics) Initialize

func (m *Metrics) Initialize(metricName, descriptionName string, log logging.Logger, namespace string, registerer prometheus.Registerer) error

Initialize the metrics with the provided names.

func (*Metrics) Issued

func (m *Metrics) Issued(id ids.ID)

Issued marks the item as having been issued.

func (*Metrics) Rejected

func (m *Metrics) Rejected(id ids.ID)

Rejected marks the item as having been rejected.