metrics

package

v1.7.4 Latest Latest Go to latest Published: Apr 23, 2024 License: MIT Imports: 10 Imported by: 3

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/ethereum-optimism/optimism

Documentation ¶

Index ¶

Constants
func ClosedReasonToNum(reason error) int
type Metricer
type Metrics
- func NewMetrics(procName string) *Metrics

Constants ¶

View Source

const (
	StageLoaded         = "loaded"
	StageOpened         = "opened"
	StageAdded          = "added"
	StageClosed         = "closed"
	StageFullySubmitted = "fully_submitted"
	StageTimedOut       = "timed_out"

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

View Source

const Namespace = "op_batcher"

Variables ¶

This section is empty.

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 ¶ added in v1.5.0

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 ¶ added in v1.1.2

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

func (*Metrics) RecordL2BlockInPendingQueue ¶ added in v1.1.2

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 ¶ added in v1.4.2

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

func (*Metrics) StartBalanceMetrics ¶

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL