consensus

Documentation

Index

• type Metrics
  • func PrometheusMetrics() *Metrics
  • func (cs *Metrics) RecordMetrics(ctx tools.Context, cdc *wire.Codec, block *types.Block, storeName string)
  • func (cs *Metrics) Start(ctx tools.Context)

Types

type Metrics

type Metrics struct {
	// Height of the chain.
	Height metrics.Gauge

	// Number of rounds.
	Rounds metrics.Gauge

	// Number of validators.
	Validators metrics.Gauge
	// Number of Candidates
	Candidates metrics.Gauge
	// Total power of all validators.
	ValidatorsPower metrics.Gauge
	// Number of validators who did not sign.
	MissingValidators metrics.Gauge
	// Total power of the missing validators.
	MissingValidatorsPower metrics.Gauge
	// Number of validators who tried to double sign.
	ByzantineValidators metrics.Gauge
	// Total power of the byzantine validators.
	ByzantineValidatorsPower metrics.Gauge

	// Time between this and the last block.
	BlockIntervalSeconds metrics.Histogram

	// Number of transactions.
	NumTxs metrics.Gauge
	// Size of the block.
	BlockSizeBytes metrics.Gauge
	// Total number of transactions.
	TotalTxs metrics.Gauge
}

Metrics contains metrics exposed by this package.

func PrometheusMetrics

func PrometheusMetrics() *Metrics

PrometheusMetrics returns Metrics build using Prometheus client library.

func (*Metrics) RecordMetrics

func (cs *Metrics) RecordMetrics(ctx tools.Context, cdc *wire.Codec, block *types.Block, storeName string)

func (*Metrics) Start

func (cs *Metrics) Start(ctx tools.Context)