dapr
/
docs
mirror of https://github.com/dapr/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add Kafka heartbeat interval and session timeout to component reference (#4074) 

* docs: add session timeout and heartbeat interval to kafka pubsub reference

Signed-off-by: denisbchrsk <155584191+denisbchrsk@users.noreply.github.com>

* docs: add session timeout and heartbeat interval to kafka binding reference

Signed-off-by: denisbchrsk <155584191+denisbchrsk@users.noreply.github.com>

* docs: add recommendation to how to set heartbeat interval

Signed-off-by: denisbchrsk <155584191+denisbchrsk@users.noreply.github.com>

* docs: small change to heartbeat interval doc

Signed-off-by: denisbchrsk <155584191+denisbchrsk@users.noreply.github.com>

* docs: update sessionTimeout and take new merged changes into consideration

Signed-off-by: denisbchrsk <155584191+denisbchrsk@users.noreply.github.com>

* docs: remove redundant doc lines

Signed-off-by: denisbchrsk <155584191+denisbchrsk@users.noreply.github.com>

* docs: fix heartbeatInterval and sessionTimeout

Signed-off-by: denisbchrsk <155584191+denisbchrsk@users.noreply.github.com>

---------

Signed-off-by: denisbchrsk <155584191+denisbchrsk@users.noreply.github.com>
Co-authored-by: Mark Fussell <markfussell@gmail.com>
Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>
This commit is contained in:
denisbchrsk 2024-06-25 22:46:11 +03:00 committed by GitHub
parent 795fdd6e62
commit a079545709
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 32 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
daprdocs/content/en/reference/components-reference/supported-bindings/kafka.md
View File

@ -45,6 +45,10 @@ spec:
value: "newest"
- name: maxMessageBytes # Optional.
value: "1024"
- name: heartbeatInterval # Optional.
value: 5s
- name: sessionTimeout # Optional.
value: 15s
- name: version # Optional.
value: "2.0.0"
- name: direction
@ -93,8 +97,8 @@ spec:
| `clientConnectionTopicMetadataRefreshInterval` | N | Input/Output | The interval for the client connection's topic metadata to be refreshed with the broker as a Go duration. Defaults to `9m`. | `"4m"` |
| `clientConnectionKeepAliveInterval` | N | Input/Output | The maximum time for the client connection to be kept alive with the broker, as a Go duration, before closing the connection. A zero value (default) means keeping alive indefinitely. | `"4m"` |
| `consumerFetchDefault` | N | Input/Output | The default number of message bytes to fetch from the broker in each request. Default is `"1048576"` bytes. | `"2097152"` |
| `heartbeatInterval` | N | Input/Output | The interval between heartbeats to the consumer coordinator for the client connection. Default is `"3s"`. | `"5s"` |
| `sessionTimeout` | N | Input/Output | The maximum time between heartbeats before the consumer is considered inactive and will timeout. Default is `"10s"`. | `"20s"` |
| `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"` |
#### Note
The metadata `version` must be set to `1.0.0` when using Azure EventHubs with Kafka.

28
daprdocs/content/en/reference/components-reference/supported-pubsub/setup-apache-kafka.md
View File

@ -45,6 +45,10 @@ spec:
value: 1024
- name: consumeRetryInterval # Optional.
value: 200ms
- name: heartbeatInterval # Optional.
value: 5s
- name: sessionTimeout # Optional.
value: 15s
- name: version # Optional.
value: 2.0.0
- name: disableTls # Optional. Disable TLS. This is not safe for production!! You should read the `Mutual TLS` section for how to use TLS.
@ -106,8 +110,8 @@ spec:
| clientConnectionTopicMetadataRefreshInterval | N | The interval for the client connection's topic metadata to be refreshed with the broker as a Go duration. Defaults to `9m`. | `"4m"` |
| clientConnectionKeepAliveInterval | N | The maximum time for the client connection to be kept alive with the broker, as a Go duration, before closing the connection. A zero value (default) means keeping alive indefinitely. | `"4m"` |
| consumerFetchDefault | N | The default number of message bytes to fetch from the broker in each request. Default is `"1048576"` bytes. | `"2097152"` |
| heartbeatInterval | N | The interval between heartbeats to the consumer coordinator for the client connection. Default is `"3s"`. | `"5s"` |
| sessionTimeout | N | The maximum time between heartbeats before the consumer is considered inactive and will timeout. Default is `"10s"`. | `"20s"` |
| heartbeatInterval | N | 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 | 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"` |
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.
@ -155,6 +159,10 @@ spec:
value: 1024
- name: consumeRetryInterval # Optional.
value: 200ms
- name: heartbeatInterval # Optional.
value: 5s
- name: sessionTimeout # Optional.
value: 15s
- name: version # Optional.
value: 0.10.2.0
- name: disableTls
@ -194,6 +202,10 @@ spec:
value: 1024
- name: consumeRetryInterval # Optional.
value: 200ms
- name: heartbeatInterval # Optional.
value: 5s
- name: sessionTimeout # Optional.
value: 15s
- name: version # Optional.
value: 0.10.2.0
- name: caCert
@ -241,6 +253,10 @@ spec:
value: 1024
- name: consumeRetryInterval # Optional.
value: 200ms
- name: heartbeatInterval # Optional.
value: 5s
- name: sessionTimeout # Optional.
value: 15s
- name: version # Optional.
value: 0.10.2.0
```
@ -293,6 +309,10 @@ spec:
value: 1024
- name: consumeRetryInterval # Optional.
value: 200ms
- name: heartbeatInterval # Optional.
value: 5s
- name: sessionTimeout # Optional.
value: 15s
- name: version # Optional.
value: 0.10.2.0
```
@ -362,6 +382,10 @@ spec:
value: "certificate"
- name: consumeRetryInterval # Optional.
value: 200ms
- name: heartbeatInterval # Optional.
value: 5s
- name: sessionTimeout # Optional.
value: 15s
- name: version # Optional.
value: 0.10.2.0
- name: maxMessageBytes # Optional.