metrics

Documentation

Index

• Constants
• func ClosedReasonToNum(reason error) int
• type Metricer
• type Metrics
  • func NewMetrics(procName string) *Metrics
  • func (m *Metrics) Document() []opmetrics.DocumentedMetric
  • func (m *Metrics) RecordBatchTxFailed()
  • func (m *Metrics) RecordBatchTxSubmitted()
  • func (m *Metrics) RecordBatchTxSuccess()
  • func (m *Metrics) RecordBlobUsedBytes(num int)
  • func (m *Metrics) RecordChannelClosed(id derive.ChannelID, numPendingBlocks int, numFrames int, inputBytes int, ...)
  • func (m *Metrics) RecordChannelFullySubmitted(id derive.ChannelID)
  • func (m *Metrics) RecordChannelOpened(id derive.ChannelID, numPendingBlocks int)
  • func (m *Metrics) RecordChannelTimedOut(id derive.ChannelID)
  • func (m *Metrics) RecordInfo(version string)
  • func (m *Metrics) RecordL2BlockInChannel(block *types.Block)
  • func (m *Metrics) RecordL2BlockInPendingQueue(block *types.Block)
  • func (m *Metrics) RecordL2BlocksAdded(l2ref eth.L2BlockRef, ...)
  • func (m *Metrics) RecordL2BlocksLoaded(l2ref eth.L2BlockRef)
  • func (m *Metrics) RecordLatestL1Block(l1ref eth.L1BlockRef)
  • 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 (
	StageLoaded         = "loaded"
	StageOpened         = "opened"
	StageAdded          = "added"
	StageClosed         = "closed"
	StageFullySubmitted = "fully_submitted"
	StageTimedOut       = "timed_out"

	TxStageSubmitted = "submitted"
	TxStageSuccess   = "success"
	TxStageFailed    = "failed"
)

const Namespace = "op_batcher"

Functions

func ClosedReasonToNum

func ClosedReasonToNum(reason error) int

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

	RecordLatestL1Block(l1ref eth.L1BlockRef)
	RecordL2BlocksLoaded(l2ref eth.L2BlockRef)
	RecordChannelOpened(id derive.ChannelID, numPendingBlocks int)
	RecordL2BlocksAdded(l2ref eth.L2BlockRef, numBlocksAdded, numPendingBlocks, inputBytes, outputComprBytes int)
	RecordL2BlockInPendingQueue(block *types.Block)
	RecordL2BlockInChannel(block *types.Block)
	RecordChannelClosed(id derive.ChannelID, numPendingBlocks int, numFrames int, inputBytes int, outputComprBytes int, reason error)
	RecordChannelFullySubmitted(id derive.ChannelID)
	RecordChannelTimedOut(id derive.ChannelID)

	RecordBatchTxSubmitted()
	RecordBatchTxSuccess()
	RecordBatchTxFailed()

	RecordBlobUsedBytes(num int)

	Document() []opmetrics.DocumentedMetric
}

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) RecordBatchTxFailed

func (m *Metrics) RecordBatchTxFailed()

func (*Metrics) RecordBatchTxSubmitted

func (m *Metrics) RecordBatchTxSubmitted()

func (*Metrics) RecordBatchTxSuccess

func (m *Metrics) RecordBatchTxSuccess()

func (*Metrics) RecordBlobUsedBytes

func (m *Metrics) RecordBlobUsedBytes(num int)

func (*Metrics) RecordChannelClosed

func (m *Metrics) RecordChannelClosed(id derive.ChannelID, numPendingBlocks int, numFrames int, inputBytes int, outputComprBytes int, reason error)

func (*Metrics) RecordChannelFullySubmitted

func (m *Metrics) RecordChannelFullySubmitted(id derive.ChannelID)

func (*Metrics) RecordChannelOpened

func (m *Metrics) RecordChannelOpened(id derive.ChannelID, numPendingBlocks int)

func (*Metrics) RecordChannelTimedOut

func (m *Metrics) RecordChannelTimedOut(id derive.ChannelID)

func (*Metrics) RecordInfo

func (m *Metrics) RecordInfo(version string)

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

func (*Metrics) RecordL2BlockInChannel

func (m *Metrics) RecordL2BlockInChannel(block *types.Block)

func (*Metrics) RecordL2BlockInPendingQueue

func (m *Metrics) RecordL2BlockInPendingQueue(block *types.Block)

func (*Metrics) RecordL2BlocksAdded

func (m *Metrics) RecordL2BlocksAdded(l2ref eth.L2BlockRef, numBlocksAdded, numPendingBlocks, inputBytes, outputComprBytes int)

RecordL2BlocksAdded should be called when L2 block were added to the channel builder, with the latest added block.

func (*Metrics) RecordL2BlocksLoaded

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

RecordL2BlocksLoaded should be called when a new L2 block was loaded into the channel manager (but not processed yet).

func (*Metrics) RecordLatestL1Block

func (m *Metrics) RecordLatestL1Block(l1ref eth.L1BlockRef)

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