Skip to content

Add publishCheckpoint outcome attribute to traces #922

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
phbnf merged 1 commit into from
Mar 27, 2026
Merged

Add publishCheckpoint outcome attribute to traces #922

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions storage/gcp/gcp.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1088,14 +1088,14 @@ func (s *spannerCoordinator) publishCheckpoint(ctx context.Context, minStaleActi
}

return otel.TraceErr(ctx, "tessera.storage.gcp.publishCheckpoint", tracer, func(ctx context.Context, span trace.Span) error {
// outcomeAttrs is used to track any attributes which need to be attached to metrics based on the outcome of the attempt to publish.
var outcomeAttrs []attribute.KeyValue
// outcomeAttr records the outcome of the checkpoint publication attempt for metrics and traces.
var outcomeAttr attribute.KeyValue
start := time.Now()

span.AddEvent("Starting ReadWriteTransaction")
if _, err := s.dbPool.ReadWriteTransactionWithOptions(ctx, func(ctx context.Context, txn *spanner.ReadWriteTransaction) error {
// Reset outcome attributes from any prior transaction attempts.
outcomeAttrs = []attribute.KeyValue{}
outcomeAttr = outcomeTypeKey.String("success")

span.AddEvent("Reading PubCoord")
pRow, err := txn.ReadRowWithOptions(ctx, "PubCoord", spanner.Key{0}, []string{"publishedAt", "size"}, &spanner.ReadOptions{LockHint: spannerpb.ReadRequest_LOCK_HINT_EXCLUSIVE})
Expand All @@ -1110,13 +1110,14 @@ func (s *spannerCoordinator) publishCheckpoint(ctx context.Context, minStaleActi

if lastSize.Valid && int64(currentSize) < lastSize.Int64 {
// Our view is stale, abort.
outcomeAttr = outcomeTypeKey.String("aborted")
return nil
}

cpAge := time.Since(pubAt)
if cpAge < minStaleActive {
slog.DebugContext(ctx, "publishCheckpoint: last checkpoint published too recently, not publishing new checkpoint", slog.Duration("cpAge", cpAge), slog.Duration("minStaleActive", minStaleActive))
outcomeAttrs = append(outcomeAttrs, errorTypeKey.String("skipped"))
outcomeAttr = outcomeTypeKey.String("skipped")
return nil
}

Expand All @@ -1132,7 +1133,7 @@ func (s *spannerCoordinator) publishCheckpoint(ctx context.Context, minStaleActi

if !shouldPublish {
slog.DebugContext(ctx, "publishCheckpoint: skipping publish because tree hasn't grown and previous checkpoint is too recent")
outcomeAttrs = append(outcomeAttrs, errorTypeKey.String("skipped_no_growth"))
outcomeAttr = outcomeTypeKey.String("skipped_no_growth")
return nil
}

Expand All @@ -1149,11 +1150,13 @@ func (s *spannerCoordinator) publishCheckpoint(ctx context.Context, minStaleActi

return nil
}, spanner.TransactionOptions{TransactionTag: "tessera.op=publishCheckpoint"}); err != nil {
publishCount.Add(ctx, 1, metric.WithAttributes(errorTypeKey.String("error")))
span.SetAttributes(outcomeTypeKey.String("error"))
publishCount.Add(ctx, 1, metric.WithAttributes(outcomeTypeKey.String("error")))
return err
}
opsHistogram.Record(ctx, time.Since(start).Milliseconds(), metric.WithAttributes(opNameKey.String("publishCheckpoint")))
publishCount.Add(ctx, 1, metric.WithAttributes(outcomeAttrs...))
span.SetAttributes(outcomeAttr)
publishCount.Add(ctx, 1, metric.WithAttributes(outcomeAttr))
return nil
})
}
Expand Down
12 changes: 6 additions & 6 deletions storage/gcp/otel.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,12 @@ var (
)

var (
errorTypeKey = attribute.Key("error.type")
treeSizeKey = attribute.Key("tessera.treeSize")
fromSizeKey = attribute.Key("tessera.fromSize")
numEntriesKey = attribute.Key("tessera.numEntries")
objectPathKey = attribute.Key("tessera.objectPath")
opNameKey = attribute.Key("op_name")
outcomeTypeKey = attribute.Key("tessera.publishCheckpoint.outcome")
treeSizeKey = attribute.Key("tessera.treeSize")
fromSizeKey = attribute.Key("tessera.fromSize")
numEntriesKey = attribute.Key("tessera.numEntries")
objectPathKey = attribute.Key("tessera.objectPath")
opNameKey = attribute.Key("op_name")

publishCount metric.Int64Counter
opsHistogram metric.Int64Histogram
Expand Down
Loading