Skip to content

DOC-6430 changes to redis-py failover API#2959

Merged
andy-stark-redis merged 1 commit intomainfrom
DOC-6430-py-failover-updates
Mar 31, 2026
Merged

DOC-6430 changes to redis-py failover API#2959
andy-stark-redis merged 1 commit intomainfrom
DOC-6430-py-failover-updates

Conversation

@andy-stark-redis
Copy link
Copy Markdown
Contributor

@andy-stark-redis andy-stark-redis commented Mar 31, 2026

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 MultiDbConfig option, 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 be async, and the example now imports from redis.asyncio.multidb.healthcheck and uses the new method signature.

Written by Cursor Bugbot for commit bf85f93. This will update automatically on new commits. Configure here.

@andy-stark-redis andy-stark-redis requested a review from a team March 31, 2026 13:41
@andy-stark-redis andy-stark-redis self-assigned this Mar 31, 2026
@andy-stark-redis andy-stark-redis added the clients Client library docs label Mar 31, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 31, 2026

DOC-6430

@github-actions
Copy link
Copy Markdown
Contributor

@jit-ci
Copy link
Copy Markdown

jit-ci bot commented Mar 31, 2026

🛡️ Jit Security Scan Results

CRITICAL HIGH MEDIUM

✅ No security findings were detected in this PR


Security scan by Jit

Copy link
Copy Markdown
Collaborator

@dwdougherty dwdougherty left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@andy-stark-redis
Copy link
Copy Markdown
Contributor Author

Thanks @dwdougherty !

@andy-stark-redis andy-stark-redis merged commit 0367d78 into main Mar 31, 2026
48 checks passed
@andy-stark-redis andy-stark-redis deleted the DOC-6430-py-failover-updates branch March 31, 2026 13:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

clients Client library docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants