metrics

Documentation

Index

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

Constants

const (
	NodeIdentityDXCertMismatch = "ff_multiparty_node_identity_dx_mismatch"
	NodeIdentityDXCertExpiry   = "ff_multiparty_node_identity_dx_expiry_epoch"
)

Variables

var BatchPinCounter *prometheus.CounterVec

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.CounterVec

var BroadcastConfirmedCounterName = "ff_broadcast_confirmed_total"

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

var BroadcastHistogram *prometheus.HistogramVec

var BroadcastHistogramName = "ff_broadcast_histogram"

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

var BroadcastRejectedCounter *prometheus.CounterVec

var BroadcastRejectedCounterName = "ff_broadcast_rejected_total"

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

var BroadcastSubmittedCounter *prometheus.CounterVec

var BroadcastSubmittedCounterName = "ff_broadcast_submitted_total"

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

var BurnConfirmedCounter *prometheus.CounterVec

var BurnConfirmedCounterName = "ff_burn_confirmed_total"

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

var BurnHistogram *prometheus.HistogramVec

var BurnHistogramName = "ff_burn_histogram"

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

var BurnRejectedCounter *prometheus.CounterVec

var BurnRejectedCounterName = "ff_burn_rejected_total"

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

var BurnSubmittedCounter *prometheus.CounterVec

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.CounterVec

var MintConfirmedCounterName = "ff_mint_confirmed_total"

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

var MintHistogram *prometheus.HistogramVec

var MintHistogramName = "ff_mint_histogram"

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

var MintRejectedCounter *prometheus.CounterVec

var MintRejectedCounterName = "ff_mint_rejected_total"

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

var MintSubmittedCounter *prometheus.CounterVec

var MintSubmittedCounterName = "ff_mint_submitted_total"

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

var NodeIdentityDXCertExpiryGauge *prometheus.GaugeVec

var NodeIdentityDXCertMismatchGauge *prometheus.GaugeVec

var PrivateMsgConfirmedCounter *prometheus.CounterVec

var PrivateMsgConfirmedCounterName = "ff_private_msg_confirmed_total"

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

var PrivateMsgHistogram *prometheus.HistogramVec

var PrivateMsgHistogramName = "ff_private_msg_histogram"

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

var PrivateMsgRejectedCounter *prometheus.CounterVec

var PrivateMsgRejectedCounterName = "ff_private_msg_rejected_total"

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

var PrivateMsgSubmittedCounter *prometheus.CounterVec

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.CounterVec

var TransferConfirmedCounterName = "ff_transfer_confirmed_total"

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

var TransferHistogram *prometheus.HistogramVec

var TransferHistogramName = "ff_transfer_histogram"

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

var TransferRejectedCounter *prometheus.CounterVec

var TransferRejectedCounterName = "ff_transfer_rejected_total"

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

var TransferSubmittedCounter *prometheus.CounterVec

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 InitIdentityMetrics

func InitIdentityMetrics()

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 RegisterIdentityMetrics

func RegisterIdentityMetrics()

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(namespace string)
	MessageSubmitted(msg *core.Message)
	MessageConfirmed(msg *core.Message, eventType fftypes.FFEnum)
	TransferSubmitted(transfer *core.TokenTransfer)
	TransferConfirmed(transfer *core.TokenTransfer)
	BlockchainContractDeployment()
	BlockchainTransaction(location, methodName string)
	BlockchainQuery(location, methodName string)
	BlockchainEvent(location, signature string)
	NodeIdentityDXCertMismatch(namespace string, mismatch NodeIdentityDXCertMismatchStatus)
	NodeIdentityDXCertExpiry(namespace string, expiry time.Time)
	AddTime(id string)
	GetTime(id string) time.Time
	DeleteTime(id string)
	IsMetricsEnabled() bool
}

func NewMetricsManager

func NewMetricsManager(ctx context.Context) Manager

type NodeIdentityDXCertMismatchStatus

type NodeIdentityDXCertMismatchStatus string

TODO should this type live elsewhere ??

const (
	NodeIdentityDXCertMismatchStatusMismatched NodeIdentityDXCertMismatchStatus = "mismatched"
	NodeIdentityDXCertMismatchStatusHealthy    NodeIdentityDXCertMismatchStatus = "healthy"
	NodeIdentityDXCertMismatchStatusUnknown    NodeIdentityDXCertMismatchStatus = "unknown"
)