docs: add examples and clarify tracing sections #491
Closed
+530
−1
Conversation
This file contains hidden or 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
Add comprehensive documentation about implementing client-side jitter to improve API performance and prevent request queueing. This includes: - New client best practices guide with jitter implementation examples in Go, Node, Python, Java, Ruby, and .NET - Explanations of why jitter matters (thundering herd, cache stampedes, queueing issues) - Guidance on which API endpoints benefit from jitter - Code examples for exponential backoff with jitter for retries - Code examples for polling with jitter - Updated performance guide to reference jitter documentation - Added jitter best practice to the best practices page Fixes authzed#338
Contributor
|
@ivanauth is attempting to deploy a commit to the authzed Team on Vercel. A member of the Team first needs to authorize it. |
Contributor
Author
|
Closing to run proper code review workflow before creating PR. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
1 participant
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.
Description
Improves the "Validation, Testing, and Debugging" page by adding concrete examples and clarifying the different tracing methods available in SpiceDB.
Many users are confused about how to enable and use request tracing, and the existing documentation lacked examples showing the actual request/response format. This PR addresses that by:
Clearly distinguishing between two tracing approaches:
debugfieldAdding complete grpcurl examples with full request payloads and response structures for both methods
Fixing technical inaccuracies:
withTracingnotwith_tracing)Changes
Testing
Fixes #330