metrics

Documentation

Index

• Variables
• func RegisterMetricSet(zlog *zap.Logger)
• type Config
• type Stats
  • func NewReqStats(config *Config, logger *zap.Logger) *Stats
  • func (s *Stats) AggregatedModulesStats() []*pbsubstreamsrpc.ModuleStats
  • func (s *Stats) JobsStats() []*pbsubstreamsrpc.Job
  • func (s *Stats) LocalModulesStats() []*pbssinternal.ModuleStats
  • func (s *Stats) LogAndClose()
  • func (s *Stats) RecordBlock(ref bstream.BlockRef)
  • func (s *Stats) RecordEndSubrequest(jobIdx uint64)
  • func (s *Stats) RecordInitializationComplete()
  • func (s *Stats) RecordJobUpdate(jobIdx uint64, upd *pbssinternal.Update)
  • func (s *Stats) RecordModuleMergeComplete(module string)
  • func (s *Stats) RecordModuleMerging(module string)
  • func (s *Stats) RecordModuleWasmBlockBegin(moduleName string) uint64
  • func (s *Stats) RecordModuleWasmBlockEnd(moduleName string, uniqueID uint64)
  • func (s *Stats) RecordModuleWasmExternalCallBegin(moduleName string, extension string) uint64
  • func (s *Stats) RecordModuleWasmExternalCallEnd(moduleName string, extension string, uniqueID uint64)
  • func (s *Stats) RecordModuleWasmStoreDeletePrefix(moduleName string, sizeBytes uint64, elapsed time.Duration)
  • func (s *Stats) RecordModuleWasmStoreRead(moduleName string, elapsed time.Duration)
  • func (s *Stats) RecordModuleWasmStoreWrite(moduleName string, sizeBytes uint64, elapsed time.Duration)
  • func (s *Stats) RecordNewSubrequest(stage uint32, startBlock, stopBlock uint64) (id uint64)
  • func (s *Stats) RecordStages(stages []*pbsubstreamsrpc.Stage)
  • func (s *Stats) RemoteBytesConsumption() (read uint64, written uint64)
  • func (s *Stats) Stages() []*pbsubstreamsrpc.Stage

Variables

var ActiveSubstreams = MetricSet.NewGauge("substreams_active_requests", "Number of active Substreams requests")

var AppReadinessTier1 = MetricSet.NewAppReadiness("substreams_tier1")

var AppReadinessTier2 = MetricSet.NewAppReadiness("substreams_tier2")

var BlockBeginProcess = MetricSet.NewCounter("substreams_block_process_start_counter", "Counter for total block processes started, used for rate")

var BlockEndProcess = MetricSet.NewCounter("substreams_block_process_end_counter", "Counter for total block processes ended, used for rate")

var MetricSet = dmetrics.NewSet()

var SquashersEnded = MetricSet.NewCounter("substreams_total_squash_processes_closed", "Counter for Total squash processes closed, used for active processes")

var SquashersStarted = MetricSet.NewCounter("substreams_total_squash_processes_launched", "Counter for Total squash processes launched, used for rate")

var SquashesLaunched = MetricSet.NewCounter("substreams_total_squashes_launched", "Counter for Total squashes launched, used for rate")

var SubstreamsCounter = MetricSet.NewCounter("substreams_counter", "Substreams requests count")

var Tier1ActiveWorkerRequest = MetricSet.NewGauge("substreams_tier1_active_worker_requests", "Number of active Substreams worker requests a tier1 app is currently doing against tier2 nodes")

var Tier1WorkerRejectedOverloadedCounter = MetricSet.NewCounter("substreams_tier1_worker_rejected_overloaded_counter", "Counter for number of times a worker rejected a request because it was overloaded (included in RetryCounter)")

var Tier1WorkerRequestCounter = MetricSet.NewCounter("substreams_tier1_worker_request_counter", "Counter for total Substreams worker requests a tier1 app made against tier2 nodes")

var Tier1WorkerRetryCounter = MetricSet.NewCounter("substreams_tier1_worker_retry_counter", "Counter for total retryable errors returned from tier2")

var Tier2ActiveRequests = MetricSet.NewGauge("substreams_tier2_active_requests", "Number of active Substreams requests the tier2 is currently serving")

var Tier2RequestCounter = MetricSet.NewCounter("substreams_tier2_request_counter", "Counter for total Substreams requests the tier2 served")

Functions

func RegisterMetricSet

func RegisterMetricSet(zlog *zap.Logger)

Types

type Config

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

type Stats

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

func NewReqStats

func NewReqStats(config *Config, logger *zap.Logger) *Stats

func (*Stats) AggregatedModulesStats

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

func (*Stats) JobsStats

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

func (*Stats) LocalModulesStats

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

func (*Stats) LogAndClose

func (s *Stats) LogAndClose()

func (*Stats) RecordBlock

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

func (*Stats) RecordEndSubrequest

func (s *Stats) RecordEndSubrequest(jobIdx uint64)

func (*Stats) RecordInitializationComplete

func (s *Stats) RecordInitializationComplete()

func (*Stats) RecordJobUpdate

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

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

func (*Stats) RecordModuleMergeComplete

func (s *Stats) RecordModuleMergeComplete(module string)

func (*Stats) RecordModuleMerging

func (s *Stats) RecordModuleMerging(module string)

func (*Stats) RecordModuleWasmBlockBegin

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

RecordModuleWasmBlockBegin should be called once per module per block

func (*Stats) RecordModuleWasmBlockEnd

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

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

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

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

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

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

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

func (*Stats) RecordStages

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

func (*Stats) RemoteBytesConsumption

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

func (*Stats) Stages

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