docs(kafka): document connection timeouts, health check, and tunable producer config (OSS-1152)#5223
Draft
nelson-parente wants to merge 2 commits into
Draft
Conversation
…ig metadata OSS-1152: document the new metadata fields added to the shared Kafka client for connection timeouts (dialTimeout, readTimeout, writeTimeout, metadataTimeout), producer tunability (producerRequiredAcks, producerRetryMax), and the associated Ping() health-check method. Updates both the pub/sub reference doc (setup-apache-kafka.md) and the bindings reference doc (kafka.md) with defaults, examples, and descriptions consistent with the implementation. Signed-off-by: Nelson Parente <nelson_parente@live.com.pt>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Dapr docs to reflect newly added, configurable timeout and producer settings in the shared Kafka client (per OSS-1152 / components-contrib#4413), so users can tune connection/metadata timeouts and producer durability/retry behavior.
Changes:
- Documented
dialTimeout,readTimeout,writeTimeout, andmetadataTimeoutin both Kafka pub/sub and Kafka binding reference docs. - Documented new tunables
producerRequiredAcksandproducerRetryMax, including accepted values/defaults.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| daprdocs/content/en/reference/components-reference/supported-pubsub/setup-apache-kafka.md | Adds new Kafka client timeout and producer tuning fields to the pub/sub metadata table. |
| daprdocs/content/en/reference/components-reference/supported-bindings/kafka.md | Adds the same fields to the Kafka binding metadata table, including binding direction support notes. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Summary
Documents the new metadata fields added to the shared Kafka client in dapr/components-contrib (OSS-1152 / dapr/components-contrib#4413):
dialTimeout,readTimeout,writeTimeout— Net timeout tunables (default 30 s each), bounding how longInit()can block on an unreachable cluster.metadataTimeout— per-request metadata refresh timeout (default 0 / disabled, Sarama computes from Net timeouts × retry count).producerRequiredAcks— replaces the previously hard-codedWaitForAll; accepts"all"(default),"local","none".producerRetryMax— replaces the previously hard-coded5; configurable integer (default 5).Both the pub/sub reference doc (
setup-apache-kafka.md) and the binding reference doc (kafka.md) are updated.Testing
✅ Markdown renders correctly locally
✅ New rows match the format and column count of existing table entries
☐ Hugo build / link-checker — pending CI
Related