Skip to content

Commit 4b70b0b

Browse files
committed
Clarify trace comments
1 parent 54441d0 commit 4b70b0b

1 file changed

Lines changed: 9 additions & 3 deletions

File tree

authzed/api/v1/debug.proto

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,9 +85,15 @@ message CheckDebugTrace {
8585
// compute this result, expires (if any). This is *not* related to the caching window.
8686
google.protobuf.Timestamp optional_expires_at = 10;
8787

88-
// trace_id is a unique identifier for this trace. This identifier is only guaranteed
89-
// to be unique within the same overall Check or CheckBulk operation.
90-
string trace_id = 11;
88+
// trace_operation_id is a unique identifier for this trace's operation, that will
89+
// be shared for all traces created for the same check operation in SpiceDB.
90+
//
91+
// In cases where SpiceDB performs automatic batching of subproblems, this ID can be used
92+
// to correlate work that was shared across multiple traces.
93+
//
94+
// This identifier is generated by SpiceDB, is to be considered opaque to the caller
95+
// and only guaranteed to be unique within the same overall Check or CheckBulk operation.
96+
string trace_operation_id = 11;
9197

9298
// source holds the source of the result. It is of the form:
9399
// `<sourcetype>:<sourceid>`, where sourcetype can be, among others:

0 commit comments

Comments
 (0)