Merge pull request #8004 from onflow/peter/execdata-metrics-highest-consecutive

[Access] Record the highest consecutive download height

Author: peterargue

module/metrics.go

@@ -801,6 +801,8 @@ type ExecutionDataRequesterMetrics interface {
 	ExecutionDataFetchStarted()
 
 	// ExecutionDataFetchFinished records a completed download
+	// Pass the highest consecutive height to ensure the metrics reflect the height up to which the
+	// requester has completed downloads. This allows us to easily see when downloading gets stuck.
 	ExecutionDataFetchFinished(duration time.Duration, success bool, height uint64)
 
 	// NotificationSent reports that ExecutionData received notifications were sent for a block height

module/metrics/execution_data_requester.go

@@ -85,10 +85,14 @@ func NewExecutionDataRequesterCollector() module.ExecutionDataRequesterMetrics {
 	}
 }
 
+// ExecutionDataFetchStarted records an in-progress download
 func (ec *ExecutionDataRequesterCollector) ExecutionDataFetchStarted() {
 	ec.downloadsInProgress.Inc()
 }
 
+// ExecutionDataFetchFinished records a completed download
+// Pass the highest consecutive height to ensure the metrics reflect the height up to which the
+// requester has completed downloads. This allows us to easily see when downloading gets stuck.
 func (ec *ExecutionDataRequesterCollector) ExecutionDataFetchFinished(duration time.Duration, success bool, height uint64) {
 	ec.downloadsInProgress.Dec()
 	ec.fetchDuration.Observe(float64(duration.Milliseconds()))
@@ -100,11 +104,13 @@ func (ec *ExecutionDataRequesterCollector) ExecutionDataFetchFinished(duration t
 	}
 }
 
+// NotificationSent records that ExecutionData received notifications were sent for a block height
 func (ec *ExecutionDataRequesterCollector) NotificationSent(height uint64) {
 	ec.outstandingNotifications.Dec()
 	ec.highestNotificationHeight.Set(float64(height))
 }
 
+// FetchRetried records that a download retry was processed
 func (ec *ExecutionDataRequesterCollector) FetchRetried() {
 	ec.downloadRetries.Inc()
 }

module/state_synchronization/requester/execution_data_requester.go

@@ -382,7 +382,9 @@ func (e *executionDataRequester) processFetchRequest(parentCtx irrecoverable.Sig
 
 	execData, err := e.execDataCache.ByBlockID(ctx, blockID)
 
-	e.metrics.ExecutionDataFetchFinished(time.Since(start), err == nil, height)
+	// use the last processed index to ensure the metrics reflect the highest _consecutive_ height.
+	// this makes it easier to see when downloading gets stuck at a height.
+	e.metrics.ExecutionDataFetchFinished(time.Since(start), err == nil, e.blockConsumer.LastProcessedIndex())
 
 	if isInvalidBlobError(err) {
 		// This means an execution result was sealed with an invalid execution data id (invalid data).