kvpb,kvserver: add range id, span to BatchTimestampBeforeGCError

Currently, debugging a `BatchTimestampBeforeGCError` is difficult, as
there information is lacking as to replica / range tried to touch
underneath the GC threshold.

Add the range ID and span to the error message.

Fixes #131256.

Release note: None.

Author: nicktrav

pkg/kv/kvpb/errors.go

@@ -1354,7 +1354,11 @@ func (e *BatchTimestampBeforeGCError) Error() string {
 }
 
 func (e *BatchTimestampBeforeGCError) SafeFormatError(p errors.Printer) (next error) {
-	p.Printf("batch timestamp %v must be after replica GC threshold %v", e.Timestamp, e.Threshold)
+	p.Printf(
+		"batch timestamp %v must be after replica GC threshold %v (r%d: %s)",
+		e.Timestamp, e.Threshold, e.RangeID,
+		roachpb.RSpan{Key: []byte(e.StartKey), EndKey: []byte(e.EndKey)},
+	)
 	return nil
 }
 

pkg/kv/kvpb/errors.proto

@@ -579,6 +579,11 @@ message BatchTimestampBeforeGCError {
   // that has been marked as excluded from a backup via
   // `ALTER TABLE ... SET (exclude_data_from_backup = true)`.
   optional bool data_excluded_from_backup = 3 [(gogoproto.nullable) = false];
+  optional int64 range_id = 4 [(gogoproto.nullable) = false,
+    (gogoproto.customname) = "RangeID",
+    (gogoproto.casttype) = "github.com/cockroachdb/cockroach/pkg/roachpb.RangeID"];
+  optional bytes start_key = 5 [(gogoproto.casttype) = "github.com/cockroachdb/cockroach/pkg/roachpb.Key"];
+  optional bytes end_key = 6 [(gogoproto.casttype) = "github.com/cockroachdb/cockroach/pkg/roachpb.Key"];
 }
 
 // A MVCCHistoryMutationError indicates that MVCC history was unexpectedly

pkg/kv/kvpb/errors_test.go

@@ -282,7 +282,7 @@ func TestErrorRedaction(t *testing.T) {
 		},
 		{
 			err:    &BatchTimestampBeforeGCError{},
-			expect: "batch timestamp 0,0 must be after replica GC threshold 0,0",
+			expect: "batch timestamp 0,0 must be after replica GC threshold 0,0 (r0: ‹/Min›)",
 		},
 		{
 			err:    &TxnAlreadyEncounteredErrorError{},

pkg/kv/kvserver/kvserverbase/forced_error.go

@@ -256,6 +256,9 @@ func CheckForcedErr(
 			ForcedError: kvpb.NewError(&kvpb.BatchTimestampBeforeGCError{
 				Timestamp: wts,
 				Threshold: *replicaState.GCThreshold,
+				RangeID:   replicaState.Desc.RangeID,
+				StartKey:  replicaState.Desc.StartKey.AsRawKey(),
+				EndKey:    replicaState.Desc.EndKey.AsRawKey(),
 			}),
 		}
 	}

pkg/kv/kvserver/replica.go

@@ -1993,10 +1993,14 @@ func (r *Replica) checkTSAboveGCThresholdRLocked(
 	if threshold.Less(ts) {
 		return nil
 	}
+	desc := r.descRLocked()
 	return &kvpb.BatchTimestampBeforeGCError{
 		Timestamp:              ts,
 		Threshold:              threshold,
 		DataExcludedFromBackup: r.excludeReplicaFromBackupRLocked(ctx, rspan),
+		RangeID:                desc.RangeID,
+		StartKey:               desc.StartKey.AsRawKey(),
+		EndKey:                 desc.EndKey.AsRawKey(),
 	}
 }