feat(taiko-client): add more preconfirmation metrics (#19523)

Author: davidtaikocha

packages/taiko-client/driver/preconf_blocks/api.go

@@ -17,6 +17,7 @@ import (
 	"github.com/modern-go/reflect2"
 
 	"github.com/taikoxyz/taiko-mono/packages/taiko-client/bindings/encoding"
+	"github.com/taikoxyz/taiko-mono/packages/taiko-client/internal/metrics"
 	"github.com/taikoxyz/taiko-mono/packages/taiko-client/pkg/utils"
 )
 
@@ -232,6 +233,8 @@ func (s *PreconfBlockAPIServer) BuildPreconfBlock(c echo.Context) error {
 		)
 	}
 
+	metrics.DriverL2PreconfBlocksFromRPCGauge.Inc()
+
 	return c.JSON(http.StatusOK, BuildPreconfBlockResponseBody{BlockHeader: header})
 }
 

packages/taiko-client/driver/preconf_blocks/queue.go

@@ -6,6 +6,7 @@ import (
 
 	"github.com/ethereum-optimism/optimism/op-service/eth"
 	"github.com/ethereum/go-ethereum/common"
+	"github.com/taikoxyz/taiko-mono/packages/taiko-client/internal/metrics"
 )
 
 // maxTrackedPayloads is the maximum number of prepared payloads the execution
@@ -45,6 +46,7 @@ func (q *payloadQueue) put(id uint64, payload *eth.ExecutionPayload) {
 		payload: payload,
 	}
 	q.totalCached++
+	metrics.DriverPreconfEnvelopeCachedCounter.Inc()
 }
 
 // get retrieves a previously stored payload item or nil if it does not exist.

packages/taiko-client/driver/preconf_blocks/server.go

@@ -209,6 +209,7 @@ func (s *PreconfBlockAPIServer) OnUnsafeL2Payload(
 
 	if msg == nil || msg.ExecutionPayload == nil {
 		log.Warn("Empty preconfirmation block payload", "peer", from)
+		metrics.DriverPreconfInvalidEnvelopeCounter.Inc()
 		return nil
 	}
 
@@ -223,6 +224,7 @@ func (s *PreconfBlockAPIServer) OnUnsafeL2Payload(
 		"gasUsed", uint64(msg.ExecutionPayload.GasUsed),
 		"endOfSequencing", msg.EndOfSequencing != nil,
 	)
+	metrics.DriverPreconfEnvelopeCounter.Inc()
 
 	// Check if the payload is valid.
 	if err := s.ValidateExecutionPayload(msg.ExecutionPayload); err != nil {
@@ -234,7 +236,7 @@ func (s *PreconfBlockAPIServer) OnUnsafeL2Payload(
 			"parentHash", msg.ExecutionPayload.ParentHash.Hex(),
 			"error", err,
 		)
-		metrics.DriverPreconfP2PInvalidEnvelopeCounter.Inc()
+		metrics.DriverPreconfInvalidEnvelopeCounter.Inc()
 		return nil
 	}
 
@@ -260,8 +262,6 @@ func (s *PreconfBlockAPIServer) OnUnsafeL2Payload(
 		return nil
 	}
 
-	metrics.DriverPreconfP2PEnvelopeCounter.Inc()
-
 	// Ensure the preconfirmation block number is greater than the current head L1 origin block ID.
 	headL1Origin, err := checkMessageBlockNumber(ctx, s.rpc, msg)
 	if err != nil {
@@ -303,6 +303,8 @@ func (s *PreconfBlockAPIServer) OnUnsafeL2Response(
 		return nil
 	}
 
+	metrics.DriverPreconfOnL2UnsafeResponseCounter.Inc()
+
 	// Ignore the message if it is in the cache already.
 	if s.payloadsCache.has(uint64(msg.ExecutionPayload.BlockNumber), msg.ExecutionPayload.BlockHash) {
 		log.Debug(
@@ -324,7 +326,7 @@ func (s *PreconfBlockAPIServer) OnUnsafeL2Response(
 			"parentHash", msg.ExecutionPayload.ParentHash.Hex(),
 			"error", err,
 		)
-		metrics.DriverPreconfP2PInvalidEnvelopeCounter.Inc()
+		metrics.DriverPreconfInvalidEnvelopeCounter.Inc()
 		return nil
 	}
 
@@ -355,8 +357,6 @@ func (s *PreconfBlockAPIServer) OnUnsafeL2Response(
 		"transactions", len(msg.ExecutionPayload.Transactions),
 	)
 
-	metrics.DriverPreconfP2PResponseEnvelopeCounter.Inc()
-
 	// Ensure the preconfirmation block number is greater than the current head L1 origin block ID.
 	headL1Origin, err := checkMessageBlockNumber(ctx, s.rpc, msg)
 	if err != nil {
@@ -401,6 +401,8 @@ func (s *PreconfBlockAPIServer) OnUnsafeL2Request(
 
 	log.Info("🔊 New preconfirmation block request from P2P network", "peer", from, "hash", hash.Hex())
 
+	metrics.DriverPreconfOnL2UnsafeRequestCounter.Inc()
+
 	headL1Origin, err := s.rpc.L2.HeadL1Origin(ctx)
 	if err != nil && err.Error() != ethereum.NotFound.Error() {
 		return fmt.Errorf("failed to fetch head L1 origin: %w", err)
@@ -476,6 +478,8 @@ func (s *PreconfBlockAPIServer) OnUnsafeL2EndOfSequencingRequest(
 		"epoch", epoch,
 	)
 
+	metrics.DriverPreconfOnEndOfSequencingRequestCounter.Inc()
+
 	hash, ok := s.sequencingEndedForEpochCache.Get(epoch)
 	if !ok {
 		return fmt.Errorf("failed to find the end of sequencing block for the given epoch: %d", epoch)
@@ -635,6 +639,8 @@ func (s *PreconfBlockAPIServer) ImportMissingAncientsFromCache(
 		return fmt.Errorf("failed to insert ancient preconfirmation blocks from cache: %w", err)
 	}
 
+	metrics.DriverImportedPreconBlocksFromCacheCounter.Add(float64(len(payloadsToImport)))
+
 	return nil
 }
 
@@ -663,6 +669,8 @@ func (s *PreconfBlockAPIServer) ImportChildBlocksFromCache(
 		return fmt.Errorf("failed to insert child preconfirmation blocks from cache: %w", err)
 	}
 
+	metrics.DriverImportedPreconBlocksFromCacheCounter.Add(float64(len(childPayloads)))
+
 	return nil
 }
 
@@ -794,7 +802,7 @@ func (s *PreconfBlockAPIServer) GetLookahead() *Lookahead {
 }
 
 // CheckLookaheadHandover returns nil if feeRecipient is allowed to build at slot globalSlot (absolute L1 slot).
-// and checks the  handover window to see if we need to request the end of sequencing
+// and checks the handover window to see if we need to request the end of sequencing
 // block.
 func (s *PreconfBlockAPIServer) CheckLookaheadHandover(feeRecipient common.Address, globalSlot uint64) error {
 	s.lookaheadMutex.Lock()
@@ -868,6 +876,8 @@ func (s *PreconfBlockAPIServer) recordLatestSeenProposal(proposal *encoding.Last
 		"lastBlockID", proposal.Pacaya().GetLastBlockID(),
 	)
 	s.latestSeenProposal = proposal
+	metrics.DriverLastSeenBlockInProposalGauge.Set(float64(proposal.Pacaya().GetLastBlockID()))
+
 	// If the latest seen proposal is reorged, reset the highest unsafe L2 payload block ID.
 	if s.latestSeenProposal.PreconfChainReorged {
 		s.highestUnsafeL2PayloadBlockID = proposal.Pacaya().GetLastBlockID()
@@ -877,6 +887,7 @@ func (s *PreconfBlockAPIServer) recordLatestSeenProposal(proposal *encoding.Last
 			"lastBlockID", s.highestUnsafeL2PayloadBlockID,
 			"highestUnsafeL2PayloadBlockID", s.highestUnsafeL2PayloadBlockID,
 		)
+		metrics.DriverReorgsByProposalCounter.Inc()
 	}
 }
 
@@ -1018,6 +1029,7 @@ func (s *PreconfBlockAPIServer) updateHighestUnsafeL2Payload(blockID uint64) {
 		)
 	}
 	s.highestUnsafeL2PayloadBlockID = blockID
+	metrics.DriverHighestPreconfUnsafePayloadGauge.Set(float64(blockID))
 }
 
 // webSocketSever is a WebSocket server that handles incoming connections,

packages/taiko-client/internal/metrics/metrics.go

@@ -26,21 +26,36 @@ var (
 	DriverL1CurrentHeightGauge             = factory.NewGauge(prometheus.GaugeOpts{Name: "driver_l1Current_height"})
 	DriverL2HeadIDGauge                    = factory.NewGauge(prometheus.GaugeOpts{Name: "driver_l2Head_id"})
 	DriverL2VerifiedHeightGauge            = factory.NewGauge(prometheus.GaugeOpts{Name: "driver_l2Verified_id"})
-	DriverPreconfP2PEnvelopeCounter        = factory.NewCounter(prometheus.CounterOpts{Name: "driver_p2p_envelope"})
-	DriverPreconfP2PInvalidEnvelopeCounter = factory.NewCounter(prometheus.CounterOpts{
+	DriverHighestPreconfUnsafePayloadGauge = factory.NewGauge(prometheus.GaugeOpts{Name: "driver_highest_unsafe_payload"})
+	DriverReorgsByProposalCounter          = factory.NewCounter(prometheus.CounterOpts{Name: "driver_reorgs_by_proposal"})
+	DriverPreconfEnvelopeCounter           = factory.NewCounter(prometheus.CounterOpts{Name: "driver_p2p_envelope"})
+	DriverLastSeenBlockInProposalGauge     = factory.NewGauge(prometheus.GaugeOpts{
+		Name: "driver_last_seen_block_in_proposal",
+	})
+	DriverL2PreconfBlocksFromRPCGauge = factory.NewGauge(prometheus.GaugeOpts{
+		Name: "driver_preconf_blocks_from_rpc",
+	})
+	DriverPreconfInvalidEnvelopeCounter = factory.NewCounter(prometheus.CounterOpts{
 		Name: "driver_p2p_invalid_envelope",
 	})
-	DriverPreconfP2POutdatedEnvelopeCounter = factory.NewCounter(prometheus.CounterOpts{
+	DriverPreconfOutdatedEnvelopeCounter = factory.NewCounter(prometheus.CounterOpts{
 		Name: "driver_p2p_outdated_envelope",
 	})
-	DriverPreconfP2PEnvelopeCachedCounter = factory.NewCounter(prometheus.CounterOpts{
+	DriverPreconfEnvelopeCachedCounter = factory.NewCounter(prometheus.CounterOpts{
 		Name: "driver_p2p_envelope_cached",
 	})
-	DriverPreconfP2PResponseEnvelopeCounter = factory.NewCounter(
-		prometheus.CounterOpts{
-			Name: "driver_p2p_response_envelope",
-		},
-	)
+	DriverPreconfOnL2UnsafeRequestCounter = factory.NewCounter(prometheus.CounterOpts{
+		Name: "driver_on_l2_unsafe_request",
+	})
+	DriverPreconfOnL2UnsafeResponseCounter = factory.NewCounter(prometheus.CounterOpts{
+		Name: "driver_on_l2_unsafe_response",
+	})
+	DriverPreconfOnEndOfSequencingRequestCounter = factory.NewCounter(prometheus.CounterOpts{
+		Name: "driver_on_end_of_sequencing_request",
+	})
+	DriverImportedPreconBlocksFromCacheCounter = factory.NewCounter(prometheus.CounterOpts{
+		Name: "driver_imported_preconf_blocks_from_cache",
+	})
 
 	// Proposer
 	ProposerProposeEpochCounter    = factory.NewCounter(prometheus.CounterOpts{Name: "proposer_epoch"})