From 32086cfb8dcf4a5de716f6d41244b6fce07bd86c Mon Sep 17 00:00:00 2001 From: Fiery-Fenix Date: Thu, 31 Jul 2025 17:16:15 +0300 Subject: [PATCH] [doc][exporter/kafka] Clarify `timeout` setting description --- exporter/kafkaexporter/README.md | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/exporter/kafkaexporter/README.md b/exporter/kafkaexporter/README.md index 496745a4d3090..191a2aa643b15 100644 --- a/exporter/kafkaexporter/README.md +++ b/exporter/kafkaexporter/README.md @@ -48,7 +48,7 @@ The following settings can be optionally configured: - `encoding` (default = otlp\_proto): The encoding for traces. See [Supported encodings](#supported-encodings). - `topic_from_metadata_key` (default = ""): The name of the metadata key whose value should be used as the message's topic. Useful to dynamically produce to topics based on request inputs. It takes precedence over `topic_from_attribute` and `topic` settings. - `topic` (Deprecated in v0.124.0: use `logs::topic`, `metrics::topic`, and `traces::topic`) If specified, this is used as the default topic, but will be overridden by signal-specific configuration. See [Destination Topic](#destination-topic) below for more details. -- `topic_from_attribute` (default = ""): Specify the resource attribute whose value should be used as the message's topic. See [Destination Topic](#destination-topic) below for more details. +- `topic_from_attribute` (default = ""): Specify the resource attribute whose value should be used as the message's topic. See [Destination Topic](#destination-topic) below for more details. - `encoding` (Deprecated in v0.124.0: use `logs::encoding`, `metrics::encoding`, and `traces::encoding`) If specified, this is used as the default encoding, but will be overridden by signal-specific configuration. See [Supported encodings](#supported-encodings) below for more details. - `include_metadata_keys` (default = []): Specifies a list of metadata keys to propagate as Kafka message headers. If one or more keys aren't found in the metadata, they are ignored. - `partition_traces_by_id` (default = false): configures the exporter to include the trace ID as the message key in trace messages sent to kafka. *Please note:* this setting does not have any effect on Jaeger encoding exporters since Jaeger exporters include trace ID as the message key by default. @@ -83,7 +83,7 @@ The following settings can be optionally configured: - `retry` - `max` (default = 3): The number of retries to get metadata - `backoff` (default = 250ms): How long to wait between metadata retries -- `timeout` (default = 5s): Is the timeout for every attempt to send data to the backend. +- `timeout` (default = 5s): Time to wait per individual attempt to produce data to Kafka. - `retry_on_failure` - `enabled` (default = true) - `initial_interval` (default = 5s): Time to wait after the first failure before retrying; ignored if `enabled` is `false` @@ -98,8 +98,8 @@ The following settings can be optionally configured: - `requests_per_second` is the average number of requests per seconds. - `producer` - `max_message_bytes` (default = 1000000) the maximum permitted size of a message in bytes - - `required_acks` (default = 1) controls when a message is regarded as transmitted. https://docs.confluent.io/platform/current/installation/configuration/producer-configs.html#acks - - `compression` (default = 'none') the compression used when producing messages to kafka. The options are: `none`, `gzip`, `snappy`, `lz4`, and `zstd` https://docs.confluent.io/platform/current/installation/configuration/producer-configs.html#compression-type + - `required_acks` (default = 1) controls when a message is regarded as transmitted. + - `compression` (default = 'none') the compression used when producing messages to kafka. The options are: `none`, `gzip`, `snappy`, `lz4`, and `zstd` - `compression_params` - `level` (default = -1) the compression level used when producing messages to kafka. - The following are valid combinations of `compression` and `level` @@ -123,17 +123,20 @@ The following settings can be optionally configured: The Kafka exporter supports encoding extensions, as well as the following built-in encodings. Available for all signals: - - `otlp_proto`: data is encoded as OTLP Protobuf - - `otlp_json`: data is encoded as OTLP JSON + +- `otlp_proto`: data is encoded as OTLP Protobuf +- `otlp_json`: data is encoded as OTLP JSON Available only for traces: - - `jaeger_proto`: the payload is serialized to a single Jaeger proto `Span`, and keyed by TraceID. - - `jaeger_json`: the payload is serialized to a single Jaeger JSON Span using `jsonpb`, and keyed by TraceID. - - `zipkin_proto`: the payload is serialized to Zipkin v2 proto Span. - - `zipkin_json`: the payload is serialized to Zipkin v2 JSON Span. + +- `jaeger_proto`: the payload is serialized to a single Jaeger proto `Span`, and keyed by TraceID. +- `jaeger_json`: the payload is serialized to a single Jaeger JSON Span using `jsonpb`, and keyed by TraceID. +- `zipkin_proto`: the payload is serialized to Zipkin v2 proto Span. +- `zipkin_json`: the payload is serialized to Zipkin v2 JSON Span. Available only for logs: - - `raw`: if the log record body is a byte array, it is sent as is. Otherwise, it is serialized to JSON. Resource and record attributes are discarded. + +- `raw`: if the log record body is a byte array, it is sent as is. Otherwise, it is serialized to JSON. Resource and record attributes are discarded. ### Example configuration