From 4b70b0b63af2d3c7cab76d33a2d25ca3b0c2ea56 Mon Sep 17 00:00:00 2001 From: Joseph Schorr Date: Tue, 7 Jan 2025 11:00:41 -0500 Subject: [PATCH] Clarify trace comments --- authzed/api/v1/debug.proto | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/authzed/api/v1/debug.proto b/authzed/api/v1/debug.proto index bf49e5a..ad06688 100644 --- a/authzed/api/v1/debug.proto +++ b/authzed/api/v1/debug.proto @@ -85,9 +85,15 @@ message CheckDebugTrace { // compute this result, expires (if any). This is *not* related to the caching window. google.protobuf.Timestamp optional_expires_at = 10; - // trace_id is a unique identifier for this trace. This identifier is only guaranteed - // to be unique within the same overall Check or CheckBulk operation. - string trace_id = 11; + // trace_operation_id is a unique identifier for this trace's operation, that will + // be shared for all traces created for the same check operation in SpiceDB. + // + // In cases where SpiceDB performs automatic batching of subproblems, this ID can be used + // to correlate work that was shared across multiple traces. + // + // This identifier is generated by SpiceDB, is to be considered opaque to the caller + // and only guaranteed to be unique within the same overall Check or CheckBulk operation. + string trace_operation_id = 11; // source holds the source of the result. It is of the form: // `:`, where sourcetype can be, among others: