metrics

Documentation

Index

• Constants
• type Metricer
• type Metrics
  • func NewMetrics(procName string) *Metrics
  • func (m *Metrics) Document() []opmetrics.DocumentedMetric
  • func (m *Metrics) RecordInfo(version string)
  • func (m *Metrics) RecordL2BlocksProposed(l2ref eth.L2BlockRef)
  • func (m *Metrics) RecordUp()
  • func (m *Metrics) Registry() *prometheus.Registry
  • func (m *Metrics) StartBalanceMetrics(l log.Logger, client *ethclient.Client, account common.Address) io.Closer

Constants

const (
	BlockProposed = "proposed"
)

const Namespace = "op_proposer"

Types

type Metricer

type Metricer interface {
	RecordInfo(version string)
	RecordUp()

	// Records all L1 and L2 block events
	opmetrics.RefMetricer

	// Record Tx metrics
	txmetrics.TxMetricer

	opmetrics.RPCMetricer

	StartBalanceMetrics(l log.Logger, client *ethclient.Client, account common.Address) io.Closer

	RecordL2BlocksProposed(l2ref eth.L2BlockRef)
}

var NoopMetrics Metricer = new(noopMetrics)

type Metrics

type Metrics struct {
	opmetrics.RefMetrics
	txmetrics.TxMetrics
	opmetrics.RPCMetrics
	// contains filtered or unexported fields
}

func NewMetrics

func NewMetrics(procName string) *Metrics

func (*Metrics) Document

func (m *Metrics) Document() []opmetrics.DocumentedMetric

func (*Metrics) RecordInfo

func (m *Metrics) RecordInfo(version string)

RecordInfo sets a pseudo-metric that contains versioning and config info for the op-proposer.

func (*Metrics) RecordL2BlocksProposed

func (m *Metrics) RecordL2BlocksProposed(l2ref eth.L2BlockRef)

RecordL2BlocksProposed should be called when new L2 block is proposed

func (*Metrics) RecordUp

func (m *Metrics) RecordUp()

RecordUp sets the up metric to 1.

func (*Metrics) Registry

func (m *Metrics) Registry() *prometheus.Registry

func (*Metrics) StartBalanceMetrics

func (m *Metrics) StartBalanceMetrics(l log.Logger, client *ethclient.Client, account common.Address) io.Closer