docs: add health and rate-limit operations notes (#512 #511) - #611
Open
charlesedeh021-cell wants to merge 1 commit into
Open
docs: add health and rate-limit operations notes (#512 #511)#611charlesedeh021-cell wants to merge 1 commit into
charlesedeh021-cell wants to merge 1 commit into
Conversation
Contributor
|
@charlesedeh021-cell fix conflict |
Contributor
|
@charlesedeh021-cell please resolve conflict |
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.
Closes #512
Closes #511
Closes #509
Closes #514
Summary
This PR delivers a focused documentation pass for two assigned operational issues:
express-rate-limitstore is Redis-backed, not in-memory #511 Rate limiting: confirmexpress-rate-limitstore is Redis-backed, not in-memoryThe current codebase already contains the main runtime pieces behind both issues:
HealthServicealready returns dependency-level readiness details for database, Redis, Horizon, Soroban RPC, email, and LLM checksRateLimiterServiceis already wired torate-limit-rediswith the shared Redis client as its primary storeThis PR documents that existing behavior so contributors and operators can understand what is already implemented today, how to interpret the readiness responses, and where follow-up implementation work is still needed.
What changed
Health endpoint documentation
Updated
docs/SYSTEMS_HANDBOOK.mdto document:GET /healthandGET /readyHealthServiceOperational guidance
Added guidance for:
/healthas a liveness probe/readyfor readiness checks and incident triageRate limiting deployment notes
Updated
docs/SYSTEMS_HANDBOOK.mdandREADME.mdto confirm that the gateway rate limiter is already Redis-backed through:express-rate-limitrate-limit-redisMulti-instance caveat
Documented the current fallback behavior:
Files changed
README.mddocs/SYSTEMS_HANDBOOK.mdScope
This is an intentional partial pass focused on documentation and operational clarity. It does not yet:
express-rate-limitstore is Redis-backed, not in-memory #511Testing
Not run in this pass, per request.