github.com/Oyster-zx/tendermint@v0.34.24-fork/mempool/metrics.go (about)

     1  package mempool
     2  
     3  import (
     4  	"github.com/go-kit/kit/metrics"
     5  	"github.com/go-kit/kit/metrics/discard"
     6  	"github.com/go-kit/kit/metrics/prometheus"
     7  	stdprometheus "github.com/prometheus/client_golang/prometheus"
     8  )
     9  
    10  const (
    11  	// MetricsSubsystem is a subsystem shared by all metrics exposed by this
    12  	// package.
    13  	MetricsSubsystem = "mempool"
    14  )
    15  
    16  // Metrics contains metrics exposed by this package.
    17  // see MetricsProvider for descriptions.
    18  type Metrics struct {
    19  	// Size of the mempool.
    20  	Size metrics.Gauge
    21  
    22  	// Histogram of transaction sizes, in bytes.
    23  	TxSizeBytes metrics.Histogram
    24  
    25  	// Number of failed transactions.
    26  	FailedTxs metrics.Counter
    27  
    28  	// RejectedTxs defines the number of rejected transactions. These are
    29  	// transactions that passed CheckTx but failed to make it into the mempool
    30  	// due to resource limits, e.g. mempool is full and no lower priority
    31  	// transactions exist in the mempool.
    32  	RejectedTxs metrics.Counter
    33  
    34  	// EvictedTxs defines the number of evicted transactions. These are valid
    35  	// transactions that passed CheckTx and existed in the mempool but were later
    36  	// evicted to make room for higher priority valid transactions that passed
    37  	// CheckTx.
    38  	EvictedTxs metrics.Counter
    39  
    40  	// Number of times transactions are rechecked in the mempool.
    41  	RecheckTimes metrics.Counter
    42  }
    43  
    44  // PrometheusMetrics returns Metrics build using Prometheus client library.
    45  // Optionally, labels can be provided along with their values ("foo",
    46  // "fooValue").
    47  func PrometheusMetrics(namespace string, labelsAndValues ...string) *Metrics {
    48  	labels := []string{}
    49  	for i := 0; i < len(labelsAndValues); i += 2 {
    50  		labels = append(labels, labelsAndValues[i])
    51  	}
    52  	return &Metrics{
    53  		Size: prometheus.NewGaugeFrom(stdprometheus.GaugeOpts{
    54  			Namespace: namespace,
    55  			Subsystem: MetricsSubsystem,
    56  			Name:      "size",
    57  			Help:      "Size of the mempool (number of uncommitted transactions).",
    58  		}, labels).With(labelsAndValues...),
    59  
    60  		TxSizeBytes: prometheus.NewHistogramFrom(stdprometheus.HistogramOpts{
    61  			Namespace: namespace,
    62  			Subsystem: MetricsSubsystem,
    63  			Name:      "tx_size_bytes",
    64  			Help:      "Transaction sizes in bytes.",
    65  			Buckets:   stdprometheus.ExponentialBuckets(1, 3, 17),
    66  		}, labels).With(labelsAndValues...),
    67  
    68  		FailedTxs: prometheus.NewCounterFrom(stdprometheus.CounterOpts{
    69  			Namespace: namespace,
    70  			Subsystem: MetricsSubsystem,
    71  			Name:      "failed_txs",
    72  			Help:      "Number of failed transactions.",
    73  		}, labels).With(labelsAndValues...),
    74  
    75  		RejectedTxs: prometheus.NewCounterFrom(stdprometheus.CounterOpts{
    76  			Namespace: namespace,
    77  			Subsystem: MetricsSubsystem,
    78  			Name:      "rejected_txs",
    79  			Help:      "Number of rejected transactions.",
    80  		}, labels).With(labelsAndValues...),
    81  
    82  		EvictedTxs: prometheus.NewCounterFrom(stdprometheus.CounterOpts{
    83  			Namespace: namespace,
    84  			Subsystem: MetricsSubsystem,
    85  			Name:      "evicted_txs",
    86  			Help:      "Number of evicted transactions.",
    87  		}, labels).With(labelsAndValues...),
    88  
    89  		RecheckTimes: prometheus.NewCounterFrom(stdprometheus.CounterOpts{
    90  			Namespace: namespace,
    91  			Subsystem: MetricsSubsystem,
    92  			Name:      "recheck_times",
    93  			Help:      "Number of times transactions are rechecked in the mempool.",
    94  		}, labels).With(labelsAndValues...),
    95  	}
    96  }
    97  
    98  // NopMetrics returns no-op Metrics.
    99  func NopMetrics() *Metrics {
   100  	return &Metrics{
   101  		Size:         discard.NewGauge(),
   102  		TxSizeBytes:  discard.NewHistogram(),
   103  		FailedTxs:    discard.NewCounter(),
   104  		RejectedTxs:  discard.NewCounter(),
   105  		EvictedTxs:   discard.NewCounter(),
   106  		RecheckTimes: discard.NewCounter(),
   107  	}
   108  }