Add basic check tracing doc #215
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
samkim
reviewed
Mar 25, 2024
| @@ -1,5 +1,5 @@ | |||
| import { Callout } from 'nextra/components' | |||
| import YouTube from 'react-youtube' | |||
| import { Callout } from "nextra/components"; | |||
There was a problem hiding this comment.
nit: single quotes for mdx files
|
|
||
| SpiceDB supports tracing of check requests to view the path(s) taken to compute the result, as well as timing information. | ||
|
|
||
| This information is requested via a header (versions older than v1.31.0) or setting `with_tracing: true` (v1.31.0 or later), and |
There was a problem hiding this comment.
Might be more clear to separate the info here into separate sections: Versions previous to v1.31.0 and versions v1.31.0 on
Also specify where to set with_tracing eg in the request body.
jzelinskie
reviewed
Apr 9, 2024
Comment on lines
95
to
102
| ### Versions older than v1.31.0 | ||
|
|
||
| Request tracing information via a header and the information is found in the response footer as JSON. | ||
|
|
||
| ### v1.31.0 or later | ||
|
|
||
| Request tracing information by setting `with_tracing: true` in the request message and the information is found in the response message. | ||
|
|
There was a problem hiding this comment.
I think it might be a better structure to the page if this just documents the v1.31 behavior with a warning about using the header for older versions rather than having two additional layers of nesting headings.
jzelinskie
reviewed
Apr 9, 2024
| **Warning:** | ||
| Versions older than v1.31.0 | ||
|
|
||
| Request tracing information via a header and the information will be found in the response footer as JSON. |
jzelinskie
approved these changes
Apr 9, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.