Repository navigation
Enhance documentation for rate limiting and backend checks - #21
Merged
Merged
Conversation
- Updated error handling documentation to include behavior when the rate limiter's backend is down (503). - Added details about the new abstract method `aping` in `BaseStore` and its implications for custom stores. - Clarified the behavior of the `CustomRateLimitBackend` when the backend is unavailable. - Included instructions for running `10xgraph dev` against Docker backends, emphasizing the need for localhost connections. - Documented new startup check variables and their purpose in ensuring backend availability at server startup. - Expanded the production deployment checklist to include startup checks and their configuration. - Added troubleshooting sections for backend unavailability and rate limit issues, detailing symptoms, causes, and fixes. - Updated playground troubleshooting to address local server access issues due to Chrome's permissions.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
apinginBaseStoreand its implications for custom stores.CustomRateLimitBackendwhen the backend is unavailable.10xgraph devagainst Docker backends, emphasizing the need for localhost connections.