DOC-6430 changes to redis-py failover API#2959
Merged
andy-stark-redis merged 1 commit intomainfrom Mar 31, 2026
Merged
Conversation
Contributor
Contributor
🛡️ Jit Security Scan Results✅ No security findings were detected in this PR
Security scan by Jit
|
Contributor
Author
|
Thanks @dwdougherty ! |
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.
The health check API has changed to require the checks to use an async method (relevant if you are implementing a custom health check). This PR notes that change in the Python failover page.
Note
Low Risk
Low risk because this PR only updates documentation; the main risk is minor user confusion if the new async custom health-check example has typos or mismatched variable names.
Overview
Updates the redis-py geographic failover documentation to document a new
MultiDbConfigoption,health_check_timeout, for bounding the total time spent running a health check.Reworks the custom health check example to match the updated async API: health checks run in an asyncio loop,
check_health()must beasync, and the example now imports fromredis.asyncio.multidb.healthcheckand uses the new method signature.Written by Cursor Bugbot for commit bf85f93. This will update automatically on new commits. Configure here.