Skip to content

docs(kafka): document connection timeouts, health check, and tunable producer config (OSS-1152) #5223

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
nelson-parente wants to merge 2 commits into
base: v1.18
Choose a base branch
from
+12 −0
Draft

docs(kafka): document connection timeouts, health check, and tunable producer config (OSS-1152) #5223

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
84fbd91
docs(kafka): document Kafka client timeout, health, and producer conf…
nelson-parente Jun 17, 2026
bfc18a6
Merge branch 'v1.18' into oss-1152-kafka-timeout-docs
nelson-parente Jun 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions daprdocs/content/en/reference/components-reference/supported-bindings/kafka.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,12 @@ spec:
| `heartbeatInterval` | N | Input | The interval between heartbeats to the consumer coordinator. At most, the value should be set to a 1/3 of the `sessionTimeout` value. Defaults to `"3s"`. | `"5s"` |
| `sessionTimeout` | N | Input | The timeout used to detect client failures when using Kafka’s group management facility. If the broker fails to receive any heartbeats from the consumer before the expiration of this session timeout, then the consumer is removed and initiates a rebalance. Defaults to `"10s"`. | `"20s"` |
| `escapeHeaders` | N | Input | Enables URL escaping of the message header values received by the consumer. Allows receiving content with special characters that are usually not allowed in HTTP headers. Default is `false`. | `true` |
| `dialTimeout` | N | Input/Output | The maximum duration to wait for the initial TCP connection to a broker. Bounds how long `Init()` can block on an unreachable cluster. Default is `"30s"`. | `"10s"` |
| `readTimeout` | N | Input/Output | The maximum duration to wait for a response from a broker. Default is `"30s"`. | `"10s"` |
| `writeTimeout` | N | Input/Output | The maximum duration to wait for a request to be transmitted to a broker. Default is `"30s"`. | `"10s"` |
| `metadataTimeout` | N | Input/Output | The per-request timeout for metadata refresh operations. When `"0"` (default), Sarama computes the effective timeout from the Net timeouts and retry count. | `"5s"` |
| `producerRequiredAcks` | N | Output | The number of broker acknowledgements required before a produce request is considered successful. Accepted values: `"all"` (all in-sync replicas, highest durability), `"local"` (partition leader only), `"none"` (no acknowledgement). Default is `"all"`. | `"local"` |
| `producerRetryMax` | N | Output | The maximum number of times to retry sending a message before giving up. Default is `5`. | `3` |

#### Note
The metadata `version` must be set to `1.0.0` when using Azure EventHubs with Kafka.
Expand Down
6 changes: 6 additions & 0 deletions ...ontent/en/reference/components-reference/supported-pubsub/setup-apache-kafka.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,12 @@ spec:
| consumerGroupRebalanceStrategy | N | The strategy to use for consumer group rebalancing. Supported values: `range`, `sticky`, `roundrobin`. Default is `range` | `"sticky"` |
| escapeHeaders | N | Enables URL escaping of the message header values received by the consumer. Allows receiving content with special characters that are usually not allowed in HTTP headers. Default is `false`. | `true` |
| excludeHeaderMetaRegex | N | A regular expression to exclude keys from being converted from headers to metadata when consuming messages and from metadata to headers when publishing messages. This capability avoids unwanted downstream side effects for topic consumers. | '"^valueSchemaType$"`
| dialTimeout | N | The maximum duration to wait for the initial TCP connection to a broker. Bounds how long `Init()` can block on an unreachable cluster. Default is `"30s"` (matches Sarama's built-in default). | `"10s"` |
| readTimeout | N | The maximum duration to wait for a response from a broker after sending a request. Default is `"30s"`. | `"10s"` |
| writeTimeout | N | The maximum duration to wait for a request to be transmitted to a broker. Default is `"30s"`. | `"10s"` |
| metadataTimeout | N | The per-request timeout for metadata refresh operations. When `"0"` (default), Sarama computes the effective timeout from the Net timeouts and retry count. | `"5s"` |
| producerRequiredAcks | N | The number of broker acknowledgements required before a produce request is considered successful. Accepted values: `"all"` (all in-sync replicas, highest durability), `"local"` (partition leader only), `"none"` (no acknowledgement). Default is `"all"`. | `"local"` |
| producerRetryMax | N | The maximum number of times to retry sending a message before giving up. Default is `5`. | `3` |

The `secretKeyRef` above is referencing a [kubernetes secrets store]({{% ref kubernetes-secret-store.md %}}) to access the tls information. Visit [here]({{% ref setup-secret-store.md %}}) to learn more about how to configure a secret store component.

Expand Down
Loading