metrics

Documentation

Index

• Variables
• func Clear()
• func GetAdminServerInstrumentation() *muxprom.Instrumentation
• func GetRestServerInstrumentation() *muxprom.Instrumentation
• func InitBatchPinMetrics()
• func InitBlockchainMetrics()
• func InitBroadcastMetrics()
• func InitPrivateMsgMetrics()
• func InitTokenBurnMetrics()
• func InitTokenMintMetrics()
• func InitTokenTransferMetrics()
• func NewInstrumentation(subsystem string) *muxprom.Instrumentation
• func RegisterBatchPinMetrics()
• func RegisterBlockchainMetrics()
• func RegisterBroadcastMetrics()
• func RegisterPrivateMsgMetrics()
• func RegisterTokenBurnMetrics()
• func RegisterTokenMintMetrics()
• func RegisterTokenTransferMetrics()
• func Registry() *prometheus.Registry
• type Manager
  • func NewMetricsManager(ctx context.Context) Manager

Variables

var BatchPinCounter prometheus.Counter

var BlockchainEventsCounter *prometheus.CounterVec

var BlockchainEventsCounterName = "ff_blockchain_events_total"

BlockchainEventsCounterName is the prometheus metric for tracking the total number of blockchain events

var BlockchainQueriesCounter *prometheus.CounterVec

var BlockchainQueriesCounterName = "ff_blockchain_queries_total"

BlockchainQueriesCounterName is the prometheus metric for tracking the total number of blockchain queries

var BlockchainTransactionsCounter *prometheus.CounterVec

var BlockchainTransactionsCounterName = "ff_blockchain_transactions_total"

BlockchainTransactionsCounterName is the prometheus metric for tracking the total number of blockchain transactions

var BroadcastConfirmedCounter prometheus.Counter

var BroadcastConfirmedCounterName = "ff_broadcast_confirmed_total"

BroadcastConfirmedCounterName is the prometheus metric for tracking the total number of broadcasts confirmed

var BroadcastHistogram prometheus.Histogram

var BroadcastHistogramName = "ff_broadcast_histogram"

BroadcastHistogramName is the prometheus metric for tracking the total number of broadcast messages - histogram

var BroadcastRejectedCounter prometheus.Counter

var BroadcastRejectedCounterName = "ff_broadcast_rejected_total"

BroadcastRejectedCounterName is the prometheus metric for tracking the total number of broadcasts rejected

var BroadcastSubmittedCounter prometheus.Counter

var BroadcastSubmittedCounterName = "ff_broadcast_submitted_total"

BroadcastSubmittedCounterName is the prometheus metric for tracking the total number of broadcasts submitted

var BurnConfirmedCounter prometheus.Counter

var BurnConfirmedCounterName = "ff_burn_confirmed_total"

BurnConfirmedCounterName is the prometheus metric for tracking the total number of burns confirmed

var BurnHistogram prometheus.Histogram

var BurnHistogramName = "ff_burn_histogram"

BurnHistogramName is the prometheus metric for tracking the total number of burns - histogram

var BurnRejectedCounter prometheus.Counter

var BurnRejectedCounterName = "ff_burn_rejected_total"

BurnRejectedCounterName is the prometheus metric for tracking the total number of burns rejected

var BurnSubmittedCounter prometheus.Counter

var BurnSubmittedCounterName = "ff_burn_submitted_total"

BurnSubmittedCounterName is the prometheus metric for tracking the total number of burns submitted

var LocationLabelName = "location"

var MethodNameLabelName = "methodName"

var MetricsBatchPin = "ff_batchpin_total"

MetricsBatchPin is the prometheus metric for total number of batch pins submitted

var MintConfirmedCounter prometheus.Counter

var MintConfirmedCounterName = "ff_mint_confirmed_total"

MintConfirmedCounterName is the prometheus metric for tracking the total number of mints confirmed

var MintHistogram prometheus.Histogram

var MintHistogramName = "ff_mint_histogram"

MintHistogramName is the prometheus metric for tracking the total number of mints - histogram

var MintRejectedCounter prometheus.Counter

var MintRejectedCounterName = "ff_mint_rejected_total"

MintRejectedCounterName is the prometheus metric for tracking the total number of mints rejected

var MintSubmittedCounter prometheus.Counter

var MintSubmittedCounterName = "ff_mint_submitted_total"

MintSubmittedCounterName is the prometheus metric for tracking the total number of mints submitted

var PrivateMsgConfirmedCounter prometheus.Counter

var PrivateMsgConfirmedCounterName = "ff_private_msg_confirmed_total"

PrivateMsgConfirmedCounterName is the prometheus metric for tracking the total number of private messages confirmed

var PrivateMsgHistogram prometheus.Histogram

var PrivateMsgHistogramName = "ff_private_msg_histogram"

PrivateMsgHistogramName is the prometheus metric for tracking the total number of private messages - histogram

var PrivateMsgRejectedCounter prometheus.Counter

var PrivateMsgRejectedCounterName = "ff_private_msg_rejected_total"

PrivateMsgRejectedCounterName is the prometheus metric for tracking the total number of private messages rejected

var PrivateMsgSubmittedCounter prometheus.Counter

var PrivateMsgSubmittedCounterName = "ff_private_msg_submitted_total"

PrivateMsgSubmittedCounterName is the prometheus metric for tracking the total number of private messages submitted

var SignatureLabelName = "signature"

var TransferConfirmedCounter prometheus.Counter

var TransferConfirmedCounterName = "ff_transfer_confirmed_total"

TransferConfirmedCounterName is the prometheus metric for tracking the total number of transfers confirmed

var TransferHistogram prometheus.Histogram

var TransferHistogramName = "ff_transfer_histogram"

TransferHistogramName is the prometheus metric for tracking the total number of transfers - histogram

var TransferRejectedCounter prometheus.Counter

var TransferRejectedCounterName = "ff_transfer_rejected_total"

TransferRejectedCounterName is the prometheus metric for tracking the total number of transfers rejected

var TransferSubmittedCounter prometheus.Counter

var TransferSubmittedCounterName = "ff_transfer_submitted_total"

TransferSubmittedCounterName is the prometheus metric for tracking the total number of transfers submitted

Functions

func Clear

func Clear()

Clear will reset the Prometheus metrics registry and instrumentations, useful for testing

func GetAdminServerInstrumentation

func GetAdminServerInstrumentation() *muxprom.Instrumentation

GetAdminServerInstrumentation returns the admin server's Prometheus middleware, ensuring its metrics are never registered twice

func GetRestServerInstrumentation

func GetRestServerInstrumentation() *muxprom.Instrumentation

GetRestServerInstrumentation returns the REST server's Prometheus middleware, ensuring its metrics are never registered twice

func InitBatchPinMetrics

func InitBatchPinMetrics()

func InitBlockchainMetrics

func InitBlockchainMetrics()

func InitBroadcastMetrics

func InitBroadcastMetrics()

func InitPrivateMsgMetrics

func InitPrivateMsgMetrics()

func InitTokenBurnMetrics

func InitTokenBurnMetrics()

func InitTokenMintMetrics

func InitTokenMintMetrics()

func InitTokenTransferMetrics

func InitTokenTransferMetrics()

func NewInstrumentation

func NewInstrumentation(subsystem string) *muxprom.Instrumentation

func RegisterBatchPinMetrics

func RegisterBatchPinMetrics()

func RegisterBlockchainMetrics

func RegisterBlockchainMetrics()

func RegisterBroadcastMetrics

func RegisterBroadcastMetrics()

func RegisterPrivateMsgMetrics

func RegisterPrivateMsgMetrics()

func RegisterTokenBurnMetrics

func RegisterTokenBurnMetrics()

func RegisterTokenMintMetrics

func RegisterTokenMintMetrics()

func RegisterTokenTransferMetrics

func RegisterTokenTransferMetrics()

func Registry

func Registry() *prometheus.Registry

Registry returns FireFly's customized Prometheus registry

Types

type Manager

type Manager interface {
	CountBatchPin()
	MessageSubmitted(msg *core.Message)
	MessageConfirmed(msg *core.Message, eventType fftypes.FFEnum)
	TransferSubmitted(transfer *core.TokenTransfer)
	TransferConfirmed(transfer *core.TokenTransfer)
	BlockchainTransaction(location, methodName string)
	BlockchainQuery(location, methodName string)
	BlockchainEvent(location, signature string)
	AddTime(id string)
	GetTime(id string) time.Time
	DeleteTime(id string)
	IsMetricsEnabled() bool
}

func NewMetricsManager

func NewMetricsManager(ctx context.Context) Manager