eth/catalyst: add getBlobs metrics

Author: MariusVanDerWijden

core/txpool/blobpool/blobpool.go

@@ -1332,17 +1332,19 @@ func (p *BlobPool) GetBlobs(vhashes []common.Hash) []*types.BlobTxSidecar {
 	return sidecars
 }
 
-func (p *BlobPool) HasBlobs(vhashes []common.Hash) bool {
+// AvailableBlobs returns the number of blobs that are available in the subpool.
+func (p *BlobPool) AvailableBlobs(vhashes []common.Hash) int {
+	available := 0
 	for _, vhash := range vhashes {
 		// Retrieve the datastore item (in a short lock)
 		p.lock.RLock()
 		_, exists := p.lookup.storeidOfBlob(vhash)
 		p.lock.RUnlock()
-		if !exists {
-			return false
+		if exists {
+			available++
 		}
 	}
-	return true
+	return available
 }
 
 // Add inserts a set of blob transactions into the pool if they pass validation (both

core/txpool/legacypool/legacypool.go

@@ -1068,10 +1068,10 @@ func (pool *LegacyPool) GetBlobs(vhashes []common.Hash) []*types.BlobTxSidecar {
 	return nil
 }
 
-// HasBlobs is not supported by the legacy transaction pool, it is just here to
+// AvailableBlobs is not supported by the legacy transaction pool, it is just here to
 // implement the txpool.SubPool interface.
-func (pool *LegacyPool) HasBlobs(vhashes []common.Hash) bool {
-	return false
+func (pool *LegacyPool) AvailableBlobs(vhashes []common.Hash) int {
+	return 0
 }
 
 // Has returns an indicator whether txpool has a transaction cached with the

core/txpool/subpool.go

@@ -137,9 +137,9 @@ type SubPool interface {
 	// retrieve blobs from the pools directly instead of the network.
 	GetBlobs(vhashes []common.Hash) []*types.BlobTxSidecar
 
-	// HasBlobs returns true if all blobs corresponding to the versioned hashes
-	// are in the sub pool.
-	HasBlobs(vhashes []common.Hash) bool
+	// AvailableBlobs returns number of blobs corresponding to the  versioned hashes
+	// that are available in the sub pool.
+	AvailableBlobs(vhashes []common.Hash) int
 
 	// ValidateTxBasics checks whether a transaction is valid according to the consensus
 	// rules, but does not check state-dependent validation such as sufficient balance.

core/txpool/txpool.go

@@ -323,18 +323,18 @@ func (p *TxPool) GetBlobs(vhashes []common.Hash) []*types.BlobTxSidecar {
 	return nil
 }
 
-// HasBlobs will return true if all the vhashes are available in the same subpool.
-func (p *TxPool) HasBlobs(vhashes []common.Hash) bool {
+// AvailableBlobs will return the number of vhashes that are available in the same subpool.
+func (p *TxPool) AvailableBlobs(vhashes []common.Hash) int {
 	for _, subpool := range p.subpools {
 		// It's an ugly to assume that only one pool will be capable of returning
 		// anything meaningful for this call, but anything else requires merging
 		// partial responses and that's too annoying to do until we get a second
 		// blobpool (probably never).
-		if subpool.HasBlobs(vhashes) {
-			return true
+		if count := subpool.AvailableBlobs(vhashes); count != 0 {
+			return count
 		}
 	}
-	return false
+	return 0
 }
 
 // Add enqueues a batch of transactions into the pool if they are valid. Due

eth/catalyst/api.go

@@ -36,6 +36,7 @@ import (
 	"github.com/ethereum/go-ethereum/eth/ethconfig"
 	"github.com/ethereum/go-ethereum/internal/version"
 	"github.com/ethereum/go-ethereum/log"
+	"github.com/ethereum/go-ethereum/metrics"
 	"github.com/ethereum/go-ethereum/miner"
 	"github.com/ethereum/go-ethereum/node"
 	"github.com/ethereum/go-ethereum/params"
@@ -116,6 +117,17 @@ var caps = []string{
 	"engine_getClientVersionV1",
 }
 
+var (
+	// Number of blobs requested via getBlobsV2
+	getBlobsRequestedCounter = metrics.NewRegisteredCounter("engine/getblobs/requested", nil)
+	// Number of blobs requested via getBlobsV2 that are present in the blobpool
+	getBlobsAvailableCounter = metrics.NewRegisteredCounter("engine/getblobs/available", nil)
+	// Number of times getBlobsV2 responded with “hit”
+	getBlobsV2RequestHit = metrics.NewRegisteredCounter("engine/getblobs/hit", nil)
+	// Number of times getBlobsV2 responded with “miss”
+	getBlobsV2RequestMiss = metrics.NewRegisteredCounter("engine/getblobs/miss", nil)
+)
+
 type ConsensusAPI struct {
 	eth *eth.Ethereum
 
@@ -510,10 +522,15 @@ func (api *ConsensusAPI) GetBlobsV2(hashes []common.Hash) ([]*engine.BlobAndProo
 		return nil, engine.TooLargeRequest.With(fmt.Errorf("requested blob count too large: %v", len(hashes)))
 	}
 
+	available := api.eth.TxPool().AvailableBlobs(hashes)
+	getBlobsRequestedCounter.Inc(int64(len(hashes)))
+	getBlobsAvailableCounter.Inc(int64(available))
 	// Optimization: check first if all blobs are available, if not, return empty response
-	if !api.eth.TxPool().HasBlobs(hashes) {
+	if available != len(hashes) {
+		getBlobsV2RequestMiss.Inc(1)
 		return nil, nil
 	}
+	getBlobsV2RequestMiss.Inc(1)
 
 	// pull up the blob hashes
 	var (