storageccl: add trace to ExportMVCCToSST to track duration

Release note: None

pkg/ccl/storageccl/export.go

@@ -168,7 +168,7 @@ func evalExport(
 	var curSizeOfExportedSSTs int64
 	for start := args.Key; start != nil; {
 		destFile := &storage.MemFile{}
-		summary, resume, err := reader.ExportMVCCToSst(start, args.EndKey, args.StartTime,
+		summary, resume, err := reader.ExportMVCCToSst(ctx, start, args.EndKey, args.StartTime,
 			h.Timestamp, exportAllRevisions, targetSize, maxSize, useTBI, destFile)
 		if err != nil {
 			return result.Result{}, err

pkg/ccl/storageccl/export_test.go

@@ -569,7 +569,7 @@ func assertEqualKVs(
 			maxSize := uint64(0)
 			prevStart := start
 			sstFile := &storage.MemFile{}
-			summary, start, err = e.ExportMVCCToSst(start, endKey, startTime, endTime,
+			summary, start, err = e.ExportMVCCToSst(ctx, start, endKey, startTime, endTime,
 				exportAllRevisions, targetSize, maxSize, enableTimeBoundIteratorOptimization, sstFile)
 			require.NoError(t, err)
 			sst = sstFile.Data()
@@ -609,7 +609,7 @@ func assertEqualKVs(
 				if dataSizeWhenExceeded == maxSize {
 					maxSize--
 				}
-				_, _, err = e.ExportMVCCToSst(prevStart, endKey, startTime, endTime,
+				_, _, err = e.ExportMVCCToSst(ctx, prevStart, endKey, startTime, endTime,
 					exportAllRevisions, targetSize, maxSize, enableTimeBoundIteratorOptimization, &storage.MemFile{})
 				require.Regexp(t, fmt.Sprintf("export size \\(%d bytes\\) exceeds max size \\(%d bytes\\)",
 					dataSizeWhenExceeded, maxSize), err)

pkg/kv/kvserver/spanset/batch.go

@@ -399,14 +399,15 @@ func (s spanSetReader) Closed() bool {
 
 // ExportMVCCToSst is part of the storage.Reader interface.
 func (s spanSetReader) ExportMVCCToSst(
+	ctx context.Context,
 	startKey, endKey roachpb.Key,
 	startTS, endTS hlc.Timestamp,
 	exportAllRevisions bool,
 	targetSize, maxSize uint64,
 	useTBI bool,
 	dest io.Writer,
 ) (roachpb.BulkOpSummary, roachpb.Key, error) {
-	return s.r.ExportMVCCToSst(startKey, endKey, startTS, endTS, exportAllRevisions, targetSize,
+	return s.r.ExportMVCCToSst(ctx, startKey, endKey, startTS, endTS, exportAllRevisions, targetSize,
 		maxSize, useTBI, dest)
 }
 

pkg/storage/BUILD.bazel

@@ -95,6 +95,7 @@ go_library(
         "//pkg/util/stop",
         "//pkg/util/syncutil",
         "//pkg/util/timeutil",
+        "//pkg/util/tracing",
         "//pkg/util/uuid",
         "@com_github_cockroachdb_errors//:errors",
         "@com_github_cockroachdb_errors//oserror",

pkg/storage/bench_test.go

@@ -1434,7 +1434,7 @@ func runExportToSst(
 	for i := 0; i < b.N; i++ {
 		startTS := hlc.Timestamp{WallTime: int64(numRevisions / 2)}
 		endTS := hlc.Timestamp{WallTime: int64(numRevisions + 2)}
-		_, _, err := engine.ExportMVCCToSst(keys.LocalMax, roachpb.KeyMax, startTS, endTS,
+		_, _, err := engine.ExportMVCCToSst(context.Background(), keys.LocalMax, roachpb.KeyMax, startTS, endTS,
 			exportAllRevisions, 0 /* targetSize */, 0 /* maxSize */, useTBI, noopWriter{})
 		if err != nil {
 			b.Fatal(err)

pkg/storage/engine.go

@@ -409,7 +409,7 @@ type Reader interface {
 	// This function looks at MVCC versions and intents, and returns an error if an
 	// intent is found.
 	ExportMVCCToSst(
-		startKey, endKey roachpb.Key, startTS, endTS hlc.Timestamp,
+		ctx context.Context, startKey, endKey roachpb.Key, startTS, endTS hlc.Timestamp,
 		exportAllRevisions bool, targetSize uint64, maxSize uint64, useTBI bool,
 		dest io.Writer,
 	) (_ roachpb.BulkOpSummary, resumeKey roachpb.Key, _ error)

pkg/storage/mvcc_incremental_iterator_test.go

@@ -152,8 +152,8 @@ func assertExportedErrs(
 ) {
 	const big = 1 << 30
 	sstFile := &MemFile{}
-	_, _, err := e.ExportMVCCToSst(startKey, endKey, startTime, endTime, revisions, big, big,
-		useTBI, sstFile)
+	_, _, err := e.ExportMVCCToSst(context.Background(), startKey, endKey, startTime, endTime,
+		revisions, big, big, useTBI, sstFile)
 	require.Error(t, err)
 
 	if intentErr := (*roachpb.WriteIntentError)(nil); errors.As(err, &intentErr) {
@@ -181,8 +181,8 @@ func assertExportedKVs(
 ) {
 	const big = 1 << 30
 	sstFile := &MemFile{}
-	_, _, err := e.ExportMVCCToSst(startKey, endKey, startTime, endTime, revisions, big, big,
-		useTBI, sstFile)
+	_, _, err := e.ExportMVCCToSst(context.Background(), startKey, endKey, startTime, endTime,
+		revisions, big, big, useTBI, sstFile)
 	require.NoError(t, err)
 	data := sstFile.Data()
 	if data == nil {

pkg/storage/pebble.go

@@ -39,6 +39,7 @@ import (
 	"github.com/cockroachdb/cockroach/pkg/util/humanizeutil"
 	"github.com/cockroachdb/cockroach/pkg/util/log"
 	"github.com/cockroachdb/cockroach/pkg/util/protoutil"
+	"github.com/cockroachdb/cockroach/pkg/util/tracing"
 	"github.com/cockroachdb/cockroach/pkg/util/uuid"
 	"github.com/cockroachdb/errors"
 	"github.com/cockroachdb/errors/oserror"
@@ -688,6 +689,7 @@ func (p *Pebble) Closed() bool {
 
 // ExportMVCCToSst is part of the engine.Reader interface.
 func (p *Pebble) ExportMVCCToSst(
+	ctx context.Context,
 	startKey, endKey roachpb.Key,
 	startTS, endTS hlc.Timestamp,
 	exportAllRevisions bool,
@@ -698,8 +700,8 @@ func (p *Pebble) ExportMVCCToSst(
 	r := wrapReader(p)
 	// Doing defer r.Free() does not inline.
 	maxIntentCount := MaxIntentsPerWriteIntentError.Get(&p.settings.SV)
-	summary, k, err := pebbleExportToSst(r, startKey, endKey, startTS, endTS, exportAllRevisions, targetSize,
-		maxSize, useTBI, dest, maxIntentCount)
+	summary, k, err := pebbleExportToSst(ctx, r, startKey, endKey, startTS, endTS, exportAllRevisions,
+		targetSize, maxSize, useTBI, dest, maxIntentCount)
 	r.Free()
 	return summary, k, err
 }
@@ -1407,6 +1409,7 @@ func (p *pebbleReadOnly) Closed() bool {
 
 // ExportMVCCToSst is part of the engine.Reader interface.
 func (p *pebbleReadOnly) ExportMVCCToSst(
+	ctx context.Context,
 	startKey, endKey roachpb.Key,
 	startTS, endTS hlc.Timestamp,
 	exportAllRevisions bool,
@@ -1418,7 +1421,8 @@ func (p *pebbleReadOnly) ExportMVCCToSst(
 	// Doing defer r.Free() does not inline.
 	maxIntentCount := MaxIntentsPerWriteIntentError.Get(&p.parent.settings.SV)
 	summary, k, err := pebbleExportToSst(
-		r, startKey, endKey, startTS, endTS, exportAllRevisions, targetSize, maxSize, useTBI, dest, maxIntentCount)
+		ctx, r, startKey, endKey, startTS, endTS, exportAllRevisions, targetSize, maxSize, useTBI, dest,
+		maxIntentCount)
 	r.Free()
 	return summary, k, err
 }
@@ -1680,6 +1684,7 @@ func (p *pebbleSnapshot) Closed() bool {
 
 // ExportMVCCToSst is part of the engine.Reader interface.
 func (p *pebbleSnapshot) ExportMVCCToSst(
+	ctx context.Context,
 	startKey, endKey roachpb.Key,
 	startTS, endTS hlc.Timestamp,
 	exportAllRevisions bool,
@@ -1691,7 +1696,8 @@ func (p *pebbleSnapshot) ExportMVCCToSst(
 	// Doing defer r.Free() does not inline.
 	maxIntentCount := MaxIntentsPerWriteIntentError.Get(&p.settings.SV)
 	summary, k, err := pebbleExportToSst(
-		r, startKey, endKey, startTS, endTS, exportAllRevisions, targetSize, maxSize, useTBI, dest, maxIntentCount)
+		ctx, r, startKey, endKey, startTS, endTS, exportAllRevisions, targetSize, maxSize, useTBI, dest,
+		maxIntentCount)
 	r.Free()
 	return summary, k, err
 }
@@ -1798,6 +1804,7 @@ func pebbleGetProto(
 }
 
 func pebbleExportToSst(
+	ctx context.Context,
 	reader Reader,
 	startKey, endKey roachpb.Key,
 	startTS, endTS hlc.Timestamp,
@@ -1807,6 +1814,10 @@ func pebbleExportToSst(
 	dest io.Writer,
 	maxIntentCount int64,
 ) (roachpb.BulkOpSummary, roachpb.Key, error) {
+	var span *tracing.Span
+	ctx, span = tracing.ChildSpan(ctx, "pebbleExportToSst")
+	_ = ctx // ctx is currently unused, but this new ctx should be used below in the future.
+	defer span.Finish()
 	sstWriter := MakeBackupSSTWriter(dest)
 	defer sstWriter.Close()
 

pkg/storage/pebble_batch.go

@@ -130,6 +130,7 @@ func (p *pebbleBatch) Closed() bool {
 
 // ExportMVCCToSst is part of the engine.Reader interface.
 func (p *pebbleBatch) ExportMVCCToSst(
+	ctx context.Context,
 	startKey, endKey roachpb.Key,
 	startTS, endTS hlc.Timestamp,
 	exportAllRevisions bool,

pkg/storage/pebble_test.go

@@ -634,7 +634,7 @@ func TestSstExportFailureIntentBatching(t *testing.T) {
 			require.NoError(t, fillInData(ctx, engine, data))
 
 			destination := &MemFile{}
-			_, _, err := engine.ExportMVCCToSst(key(10), key(20000), ts(999), ts(2000),
+			_, _, err := engine.ExportMVCCToSst(ctx, key(10), key(20000), ts(999), ts(2000),
 				true, 0, 0, true, destination)
 			if len(expectedIntentIndices) == 0 {
 				require.NoError(t, err)