feat: configurable broker ping timeout for FastStream health check#102
Merged
Conversation
FastStreamHealthChecksInstrument._define_health_status called broker.ping(timeout=5) with a hardcoded 5-second timeout. For users with slow brokers (large Redis clusters under load, message queues with cold connections), this is a footgun. Add faststream_health_check_broker_timeout: float = 5.0 to FastStreamConfig. Default preserves the existing behavior; users can now override. The field lives on FastStreamConfig (not the shared HealthChecksConfig) because the timeout is FastStream-shaped — it's specifically about a message broker ping, not a generic concern that FastAPI/Litestar health checks would share. Regression test patches broker.ping to assert the configured timeout value reaches it. Closes REF-7 from the audit.
Codecov Report✅ All modified and coverable lines are covered by tests.
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
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
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.
Summary
faststream_health_check_broker_timeout: float = 5.0toFastStreamConfig.FastStreamHealthChecksInstrument._define_health_statusnow reads from the config instead of the previously hardcodedtimeout=5.broker.pingand asserts the configured value reaches it.Default preserves existing behavior — pure-additive config option. Users with slow brokers (large Redis clusters under load, message queues with cold connections) can now bump the timeout without forking the library.
Closes REF-7 from an internal audit.
Test plan
just test -- 'tests/test_faststream_bootstrap.py::test_faststream_health_check_uses_configured_broker_timeout' -v— pass.just test— 129/129.just lint— clean.FastStreamConfig(notHealthChecksConfig) — this was the locked decision in the sequencing spec because the timeout is FastStream-shaped.🤖 Generated with Claude Code