Skip to content

Commit 2278501

Browse files
docs(otelcol.exporter.kafka): Update compression argument description for clarity [backport] (#5716)
## Backport of #5706 This PR backports #5706 to release/v1.14. ### Original PR Author @benoitschipper ### Description ### Brief description of Pull Request Fix incorrect description for the `compression` argument in the `producer` block of `otelcol.exporter.kafka` documentation. ### Pull Request Details The `compression` argument in the [`producer`](docs/sources/reference/components/otelcol/otelcol.exporter.kafka.md) block had a copy-paste error in its description — it read "Time to wait between retries." (which is the description for `flush_max_messages`) instead of the correct "The level of compression to use on messages." This is a one-line documentation fix with no code changes. ### Issue(s) fixed by this Pull Request Fixes #5705 ### Notes to the Reviewer Purely a documentation fix — no functional changes, no tests needed, no config converter changes needed. ### PR Checklist - [x] Documentation added - [ ] Tests updated - [ ] Config converters updated --- *This backport was created automatically.* Co-authored-by: Benoit <77777295+benoitschipper@users.noreply.github.com>
1 parent 39bff2e commit 2278501

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

docs/sources/reference/components/otelcol/otelcol.exporter.kafka.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ The following arguments are supported:
200200

201201
| Name | Type | Description | Default | Required |
202202
| -------------------- | -------- | --------------------------------------------------- | --------- | -------- |
203-
| `compression` | `string` | Time to wait between retries. | `"none"` | no |
203+
| `compression` | `string` | The level of compression to use on messages. | `"none"` | no |
204204
| `flush_max_messages` | `number` | Time to wait between retries. | `0` | no |
205205
| `max_message_bytes` | `number` | The maximum permitted size of a message in bytes. | `1000000` | no |
206206
| `required_acks` | `number` | Controls when a message is regarded as transmitted. | `1` | no |

0 commit comments

Comments
 (0)