Merge pull request #837 from onflow/mpeter/add-transactions-dropped-counter

Add metric for the total number of dropped EVM transactions

Author: m-Peter

metrics/collector.go

@@ -41,7 +41,7 @@ var evmBlockIndexedCounter = prometheus.NewCounter(prometheus.CounterOpts{
 
 var evmTxIndexedCounter = prometheus.NewCounter(prometheus.CounterOpts{
 	Name: prefixedName("txs_indexed_total"),
-	Help: "Total number transactions indexed",
+	Help: "Total number of transactions indexed",
 })
 
 var evmAccountCallCounters = prometheus.NewCounterVec(prometheus.CounterOpts{
@@ -77,6 +77,11 @@ var requestRateLimitedCounters = prometheus.NewCounterVec(prometheus.CounterOpts
 	Help: "Total number of rate limits by JSON-RPC method",
 }, []string{"method"})
 
+var transactionsDroppedCounter = prometheus.NewCounter(prometheus.CounterOpts{
+	Name: prefixedName("transactions_dropped_total"),
+	Help: "Total number of EVM transactions dropped due to service errors",
+})
+
 var metrics = []prometheus.Collector{
 	apiErrors,
 	serverPanicsCounters,
@@ -91,6 +96,7 @@ var metrics = []prometheus.Collector{
 	gasEstimationIterations,
 	blockIngestionTime,
 	requestRateLimitedCounters,
+	transactionsDroppedCounter,
 }
 
 type Collector interface {
@@ -106,6 +112,7 @@ type Collector interface {
 	GasEstimationIterations(count int)
 	BlockIngestionTime(blockCreation time.Time)
 	RequestRateLimited(method string)
+	TransactionsDropped(count int)
 }
 
 var _ Collector = &DefaultCollector{}
@@ -125,6 +132,7 @@ type DefaultCollector struct {
 	gasEstimationIterations    prometheus.Gauge
 	blockIngestionTime         prometheus.Histogram
 	requestRateLimitedCounters *prometheus.CounterVec
+	transactionsDroppedCounter prometheus.Counter
 }
 
 func NewCollector(logger zerolog.Logger) Collector {
@@ -147,6 +155,7 @@ func NewCollector(logger zerolog.Logger) Collector {
 		gasEstimationIterations:    gasEstimationIterations,
 		blockIngestionTime:         blockIngestionTime,
 		requestRateLimitedCounters: requestRateLimitedCounters,
+		transactionsDroppedCounter: transactionsDroppedCounter,
 	}
 }
 
@@ -221,6 +230,10 @@ func (c *DefaultCollector) RequestRateLimited(method string) {
 	).Inc()
 }
 
+func (c *DefaultCollector) TransactionsDropped(count int) {
+	c.transactionsDroppedCounter.Add(float64(count))
+}
+
 func prefixedName(name string) string {
 	return fmt.Sprintf("evm_gateway_%s", name)
 }

metrics/nop.go

@@ -24,3 +24,4 @@ func (c *nopCollector) AvailableSigningKeys(count int)             {}
 func (c *nopCollector) GasEstimationIterations(count int)          {}
 func (c *nopCollector) BlockIngestionTime(blockCreation time.Time) {}
 func (c *nopCollector) RequestRateLimited(method string)           {}
+func (c *nopCollector) TransactionsDropped(count int)              {}

services/requester/batch_tx_pool.go

@@ -260,6 +260,9 @@ func (t *BatchTxPool) batchSubmitTransactionsForSameAddress(
 		coinbaseAddress,
 	)
 	if err != nil {
+		// If there was any error during the transaction build
+		// process, we record all transactions as dropped.
+		t.collector.TransactionsDropped(len(hexEncodedTxs))
 		return err
 	}
 
@@ -293,6 +296,9 @@ func (t *BatchTxPool) submitSingleTransaction(
 		coinbaseAddress,
 	)
 	if err != nil {
+		// If there was any error during the transaction build
+		// process, we record it as a dropped transaction.
+		t.collector.TransactionsDropped(1)
 		return err
 	}
 

services/requester/single_tx_pool.go

@@ -107,6 +107,9 @@ func (t *SingleTxPool) Add(
 		coinbaseAddress,
 	)
 	if err != nil {
+		// If there was any error during the transaction build
+		// process, we record it as a dropped transaction.
+		t.collector.TransactionsDropped(1)
 		return err
 	}