metrics

Documentation

Overview

Package metrics provides metrics functionalities for the zetaclient

Index

• Constants
• Variables
• type BurnRate
  • func NewBurnRate(windowSize int64) *BurnRate
  • func (br *BurnRate) AddFee(amount int64, block int64) error
  • func (br *BurnRate) GetBurnRate() sdkmath.Int
• type Metrics
  • func NewMetrics() (*Metrics, error)
  • func (m *Metrics) Start()
  • func (m *Metrics) Stop() error
• type TelemetryServer
  • func NewTelemetryServer() *TelemetryServer
  • func (t *TelemetryServer) AddFeeEntry(block int64, amount int64)
  • func (t *TelemetryServer) GetCoreBlockNumber() int64
  • func (t *TelemetryServer) GetIPAddress() string
  • func (t *TelemetryServer) GetLastScannedBlockNumber(chainID int64) uint64
  • func (t *TelemetryServer) GetLastStartTimestamp() time.Time
  • func (t *TelemetryServer) GetP2PID() string
  • func (t *TelemetryServer) Handlers() http.Handler
  • func (t *TelemetryServer) SetCoreBlockNumber(blockNumber int64)
  • func (t *TelemetryServer) SetIPAddress(ip string)
  • func (t *TelemetryServer) SetLastScannedBlockNumber(chain chains.Chain, blockNumber uint64)
  • func (t *TelemetryServer) SetNumberOfUTXOs(numberOfUTXOs int)
  • func (t *TelemetryServer) SetP2PID(p2pid string)
  • func (t *TelemetryServer) Start() error
  • func (t *TelemetryServer) Stop() error

Constants

const ZetaClientNamespace = "zetaclient"

ZetaClientNamespace is the namespace for the metrics

Variables

var (
	// PendingTxsPerChain is a gauge that contains the number of pending transactions per chain
	PendingTxsPerChain = promauto.NewGaugeVec(prometheus.GaugeOpts{
		Namespace: ZetaClientNamespace,
		Name:      "pending_txs_total",
		Help:      "Number of pending transactions per chain",
	}, []string{"chain"})

	// GetFilterLogsPerChain is a counter that contains the number of getLogs per chain
	GetFilterLogsPerChain = promauto.NewCounterVec(prometheus.CounterOpts{
		Namespace: ZetaClientNamespace,
		Name:      "rpc_getFilterLogs_count",
		Help:      "Count of getLogs per chain",
	}, []string{"chain"})

	// GetBlockByNumberPerChain is a counter that contains the number of getBlockByNumber per chain
	GetBlockByNumberPerChain = promauto.NewCounterVec(prometheus.CounterOpts{
		Namespace: ZetaClientNamespace,
		Name:      "rpc_getBlockByNumber_count",
		Help:      "Count of getLogs per chain",
	}, []string{"chain"})

	// TssNodeBlamePerPubKey is a counter that contains the number of tss node blame per pubkey
	TssNodeBlamePerPubKey = promauto.NewCounterVec(prometheus.CounterOpts{
		Namespace: ZetaClientNamespace,
		Name:      "tss_node_blame_count",
		Help:      "Tss node blame counter per pubkey",
	}, []string{"pubkey"})

	// HotKeyBurnRate is a gauge that contains the fee burn rate of the hotkey
	HotKeyBurnRate = promauto.NewGauge(prometheus.GaugeOpts{
		Namespace: ZetaClientNamespace,
		Name:      "hotkey_burn_rate",
		Help:      "Fee burn rate of the hotkey",
	})

	// NumberOfUTXO is a gauge that contains the number of UTXOs
	NumberOfUTXO = promauto.NewGauge(prometheus.GaugeOpts{
		Namespace: ZetaClientNamespace,
		Name:      "utxo_number",
		Help:      "Number of UTXOs",
	})

	// LastScannedBlockNumber is a gauge that contains the last scanned block number per chain
	LastScannedBlockNumber = promauto.NewGaugeVec(prometheus.GaugeOpts{
		Namespace: ZetaClientNamespace,
		Name:      "last_scanned_block_number",
		Help:      "Last scanned block number per chain",
	}, []string{"chain"})

	// LastCoreBlockNumber is a gauge that contains the last core block number
	LastCoreBlockNumber = promauto.NewGauge(prometheus.GaugeOpts{
		Namespace: ZetaClientNamespace,
		Name:      "last_core_block_number",
		Help:      "Last core block number",
	})

	// Info is a gauge that contains information about the zetaclient environment
	Info = promauto.NewGaugeVec(prometheus.GaugeOpts{
		Namespace: ZetaClientNamespace,
		Name:      "info",
		Help:      "Information about Zetaclient environment",
	}, []string{"version"})

	// LastStartTime is a gauge that contains the start time in Unix time
	LastStartTime = promauto.NewGauge(prometheus.GaugeOpts{
		Namespace: ZetaClientNamespace,
		Name:      "last_start_timestamp_seconds",
		Help:      "Start time in Unix time",
	})

	// NumActiveMsgSigns is a gauge that contains the number of concurrent key signs
	NumActiveMsgSigns = promauto.NewGauge(prometheus.GaugeOpts{
		Namespace: ZetaClientNamespace,
		Name:      "num_active_message_signs",
		Help:      "Number of concurrent key signs",
	})

	// PercentageOfRateReached is a gauge that contains the percentage of the rate limiter rate reached
	PercentageOfRateReached = promauto.NewGauge(prometheus.GaugeOpts{
		Namespace: ZetaClientNamespace,
		Name:      "percentage_of_rate_reached",
		Help:      "Percentage of the rate limiter rate reached",
	})
)

Types

type BurnRate

type BurnRate struct {
	// contains filtered or unexported fields
}

BurnRate calculates the average burn rate for a range of blocks.

func NewBurnRate

func NewBurnRate(windowSize int64) *BurnRate

NewBurnRate creates a new BurnRate instance with a window size.

func (*BurnRate) AddFee

func (br *BurnRate) AddFee(amount int64, block int64) error

AddFee adds fee amount spent on a tx for a particular block. It is added to a queue which is used to calculate the average burn rate for a range of blocks determined by the window size.

func (*BurnRate) GetBurnRate

func (br *BurnRate) GetBurnRate() sdkmath.Int

GetBurnRate calculates current burn rate and return the value.

type Metrics

type Metrics struct {
	// contains filtered or unexported fields
}

Metrics is a struct that contains the http server for metrics

func NewMetrics

func NewMetrics() (*Metrics, error)

NewMetrics creates a new Metrics instance

func (*Metrics) Start

func (m *Metrics) Start()

Start starts the metrics server

func (*Metrics) Stop

func (m *Metrics) Stop() error

Stop stops the metrics server

type TelemetryServer

type TelemetryServer struct {
	HotKeyBurnRate *BurnRate
	// contains filtered or unexported fields
}

TelemetryServer provides http endpoint for Tss server

func NewTelemetryServer

func NewTelemetryServer() *TelemetryServer

NewTelemetryServer should only listen to the loopback

func (*TelemetryServer) AddFeeEntry

func (t *TelemetryServer) AddFeeEntry(block int64, amount int64)

AddFeeEntry adds fee entry

func (*TelemetryServer) GetCoreBlockNumber

func (t *TelemetryServer) GetCoreBlockNumber() int64

GetCoreBlockNumber returns core block number

func (*TelemetryServer) GetIPAddress

func (t *TelemetryServer) GetIPAddress() string

GetIPAddress gets p2pid

func (*TelemetryServer) GetLastScannedBlockNumber

func (t *TelemetryServer) GetLastScannedBlockNumber(chainID int64) uint64

GetLastScannedBlockNumber returns last scanned block number for chain

func (*TelemetryServer) GetLastStartTimestamp

func (t *TelemetryServer) GetLastStartTimestamp() time.Time

GetLastStartTimestamp returns last start timestamp

func (*TelemetryServer) GetP2PID

func (t *TelemetryServer) GetP2PID() string

GetP2PID gets p2pid

func (*TelemetryServer) Handlers

func (t *TelemetryServer) Handlers() http.Handler

Handlers registers the API routes and returns a new HTTP handler

func (*TelemetryServer) SetCoreBlockNumber

func (t *TelemetryServer) SetCoreBlockNumber(blockNumber int64)

SetCoreBlockNumber sets core block number in telemetry and metrics

func (*TelemetryServer) SetIPAddress

func (t *TelemetryServer) SetIPAddress(ip string)

SetIPAddress sets p2pid

func (*TelemetryServer) SetLastScannedBlockNumber

func (t *TelemetryServer) SetLastScannedBlockNumber(chain chains.Chain, blockNumber uint64)

SetLastScannedBlockNumber last scanned block number for chain in telemetry and metrics

func (*TelemetryServer) SetNumberOfUTXOs

func (t *TelemetryServer) SetNumberOfUTXOs(numberOfUTXOs int)

SetNumberOfUTXOs sets number of UTXOs in telemetry and metrics

func (*TelemetryServer) SetP2PID

func (t *TelemetryServer) SetP2PID(p2pid string)

SetP2PID sets p2pid

func (*TelemetryServer) Start

func (t *TelemetryServer) Start() error

Start starts telemetry server

func (*TelemetryServer) Stop

func (t *TelemetryServer) Stop() error

Stop stops telemetry server