metrics

package
v1.18.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 19, 2026 License: Apache-2.0 Imports: 18 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var AppReadinessTier1 *dmetrics.AppReadiness
View Source 
var AppReadinessTier2 *dmetrics.AppReadiness
View Source 
var BlockBeginProcess = MetricSet.NewCounter("substreams_block_process_start_counter", "Counter for total block processes started, used for rate")
View Source 
var BlockEndProcess = MetricSet.NewCounter("substreams_block_process_end_counter", "Counter for total block processes ended, used for rate")
View Source 
var ExecutedWasmModules = MetricSet.NewCounter("substreams_executed_wasm_modules", "Counter for total WASM executions for each module on each block")
View Source 
var MetricSet = dmetrics.NewSet()
View Source 
var SkippedCachedWasmModules = MetricSet.NewCounter("substreams_skipped_cached_wasm_modules", "Counter for total WASM skipped executions for each module on each block due to the shared cache")
View Source 
var Tier1ActiveRequests *dmetrics.Gauge
View Source 
var Tier1ActiveWorkerRequest *dmetrics.Gauge
View Source 
var Tier1OutputHeadBlockRelativeTime *dmetrics.HeadBlockRelativeTime
View Source 
var Tier1RejectedRequestCounter *dmetrics.CounterVec

var Tier1RequestsCounter *dmetrics.Counter

View Source 
var Tier1RequestsCounter *dmetrics.Counter
View Source 
var Tier1SquashersEnded *dmetrics.Counter
View Source 
var Tier1SquashersStarted *dmetrics.Counter
View Source 
var Tier1WorkerRejectedOverloadedCounter *dmetrics.Counter
View Source 
var Tier1WorkerRequestCounter *dmetrics.Counter
View Source 
var Tier1WorkerRetryCounter *dmetrics.Counter
View Source 
var Tier2ActiveRequests *dmetrics.Gauge
View Source 
var Tier2RejectedRequestCounter *dmetrics.CounterVec
View Source 
var Tier2RequestCounter *dmetrics.Counter

Functions

func DeclareTier1Metrics added in v1.17.9 

func DeclareTier1Metrics(zlog *zap.Logger)

func DeclareTier2Metrics added in v1.17.9 

func DeclareTier2Metrics(zlog *zap.Logger)

func IsRejectedRequestError added in v1.12.0 

func IsRejectedRequestError(err error) (metricsReason string, countAsRejected bool)

IsRejectedRequestError returns true if the error is a rejected request error and should be logged as such in metrics.

Types

type Config added in v1.1.8 

type Config struct {
	UserID           string
	ApiKeyID         string
	OutputModule     string
	OutputModuleHash string
	ProductionMode   bool
	Tier2            bool
}

type JobStatus added in v1.14.6 

type JobStatus int

JobStatus represents the final state of a job 

const (
	JobComplete JobStatus = iota
	JobCancelled
	JobFailed
)

type Stats 

type Stats struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func NewReqStats 

func NewReqStats(config *Config, stores []*pbsubstreams.Module, moduleHashes map[string]string, logger *zap.Logger) *Stats

func (*Stats) AggregatedModulesStats added in v1.1.12 

func (s *Stats) AggregatedModulesStats() []*pbsubstreamsrpc.ModuleStats

func (*Stats) GetBlocksProcessed added in v1.15.9 

func (s *Stats) GetBlocksProcessed() uint64

func (*Stats) JobsStats added in v1.1.12 

func (s *Stats) JobsStats() []*pbsubstreamsrpc.Job

func (*Stats) LocalModulesStats added in v1.1.12 

func (s *Stats) LocalModulesStats() []*pbssinternal.ModuleStats

func (*Stats) LogAndClose added in v1.1.8 

func (s *Stats) LogAndClose(ctx context.Context, resolvedStartBlockNum uint64)

func (*Stats) RecordBlock 

func (s *Stats) RecordBlock(ref bstream.BlockRef)

func (*Stats) RecordBlocksProcessed added in v1.15.9 

func (s *Stats) RecordBlocksProcessed(count uint64)

func (*Stats) RecordDataSent added in v1.12.3 

func (s *Stats) RecordDataSent()

func (*Stats) RecordEgress added in v1.15.9 

func (s *Stats) RecordEgress(egressBytes int)

func (*Stats) RecordEndSubrequest added in v1.1.12 

func (s *Stats) RecordEndSubrequest(jobIdx uint64, status JobStatus)

func (*Stats) RecordInitializationComplete added in v1.1.12 

func (s *Stats) RecordInitializationComplete()

func (*Stats) RecordJobDelayed added in v1.14.6 

func (s *Stats) RecordJobDelayed(jobIdx uint64)

RecordJobDelayed should be called when a job is retried without any work done (ex: rejected upon connection to tier2)

func (*Stats) RecordJobRetried added in v1.14.6 

func (s *Stats) RecordJobRetried(jobIdx uint64)

RecordJobRetried should be called when a job is retried after having possibly done some work

func (*Stats) RecordJobUpdate added in v1.1.12 

func (s *Stats) RecordJobUpdate(jobIdx uint64, upd *pbssinternal.Update)

RecordJobUpdate will be called each time a job sends an update message

func (*Stats) RecordModuleMergeComplete added in v1.1.12 

func (s *Stats) RecordModuleMergeComplete(module string)

func (*Stats) RecordModuleMerging added in v1.1.12 

func (s *Stats) RecordModuleMerging(module string)

func (*Stats) RecordModuleWasmBlockBegin added in v1.1.19 

func (s *Stats) RecordModuleWasmBlockBegin(moduleName string) uint64

RecordModuleWasmBlockBegin should be called once per module per block

func (*Stats) RecordModuleWasmBlockEnd added in v1.1.19 

func (s *Stats) RecordModuleWasmBlockEnd(moduleName string, uniqueID uint64)

RecordModuleWasmBlockEnd should be called once per module per block. `elapsed` is the time spent in executing the WASM code, including store and extension calls

func (*Stats) RecordModuleWasmExternalCallBegin added in v1.1.19 

func (s *Stats) RecordModuleWasmExternalCallBegin(moduleName string, extension string) uint64

RecordModuleWasmExternalCallBegin can be called multiple times per module per block, for each external module call (ex: eth_call).

func (*Stats) RecordModuleWasmExternalCallEnd added in v1.1.19 

func (s *Stats) RecordModuleWasmExternalCallEnd(moduleName string, extension string, uniqueID uint64)

RecordModuleWasmExternalCallEnd can be called multiple times per module per block, for each external module call (ex: eth_call). `elapsed` is the time spent in executing that call.

func (*Stats) RecordModuleWasmStoreDeletePrefix added in v1.1.12 

func (s *Stats) RecordModuleWasmStoreDeletePrefix(moduleName string, sizeBytes uint64, elapsed time.Duration)

RecordModuleWasmStoreDeletePrefix can be called multiple times per module per block `elapsed` is the time spent in executing that operation.

func (*Stats) RecordModuleWasmStoreRead added in v1.1.12 

func (s *Stats) RecordModuleWasmStoreRead(moduleName string, elapsed time.Duration)

RecordModuleWasmStoreRead can be called multiple times per module per block `elapsed` is the time spent in executing that operation.

func (*Stats) RecordModuleWasmStoreWrite added in v1.1.12 

func (s *Stats) RecordModuleWasmStoreWrite(moduleName string, sizeBytes uint64, elapsed time.Duration)

RecordModuleWasmStoreWrite can be called multiple times per module per block `elapsed` is the time spent in executing that operation.

func (*Stats) RecordNewSubrequest added in v1.1.12 

func (s *Stats) RecordNewSubrequest(stage uint32, startBlock, stopBlock uint64) (id uint64)

func (*Stats) RecordReadTime added in v1.16.5 

func (s *Stats) RecordReadTime(since time.Time)

func (*Stats) RecordStages added in v1.1.12 

func (s *Stats) RecordStages(stages []*pbsubstreamsrpc.Stage)

func (*Stats) RemoteBytesConsumption added in v1.1.12 

func (s *Stats) RemoteBytesConsumption() (read uint64, written uint64)

func (*Stats) SetError added in v1.12.3 

func (s *Stats) SetError(err error)

func (*Stats) Stages added in v1.1.12 

func (s *Stats) Stages() []*pbsubstreamsrpc.Stage

type WasmExtensionStats added in v1.13.0 

type WasmExtensionStats interface {
	RecordModuleWasmExternalCallBegin(moduleName string, extension string) uint64
	RecordModuleWasmExternalCallEnd(moduleName string, extension string, uniqueID uint64)
}

type WasmMetricsGatherer added in v1.13.0 

type WasmMetricsGatherer struct {
	sync.Mutex
	// contains filtered or unexported fields
}

this is used to gather metrics, then merge them into the Stats struct

func (*WasmMetricsGatherer) ApplyToStats added in v1.13.0 

func (m *WasmMetricsGatherer) ApplyToStats(stats *Stats)

func (*WasmMetricsGatherer) RecordModuleWasmExternalCallBegin added in v1.13.0 

func (m *WasmMetricsGatherer) RecordModuleWasmExternalCallBegin(moduleName string, extension string) uint64

func (*WasmMetricsGatherer) RecordModuleWasmExternalCallEnd added in v1.13.0 

func (m *WasmMetricsGatherer) RecordModuleWasmExternalCallEnd(moduleName string, extension string, uniqueID uint64)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.