Skip to content

Commit

Permalink
[chore][receiver/kafa] Update README on topic (#33678)
Browse files Browse the repository at this point in the history
**Description:**
Errors are seen in the kafka receiver when different telemetry types are
being scraped from the same topic. A receiver instance will receive data
of an unexpected format (wrong telemetry type) and fail to parse. This
is expected and should be documented.

**Link to tracking Issue:** Resolves #31679
  • Loading branch information
crobert-1 committed Jun 20, 2024
1 parent 797c263 commit 88f8680
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion receiver/kafkareceiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ The following settings can be optionally configured:

- `brokers` (default = localhost:9092): The list of kafka brokers
- `resolve_canonical_bootstrap_servers_only` (default = false): Whether to resolve then reverse-lookup broker IPs during startup
- `topic` (default = otlp_spans for traces, otlp_metrics for metrics, otlp_logs for logs): The name of the kafka topic to read from
- `topic` (default = otlp_spans for traces, otlp_metrics for metrics, otlp_logs for logs): The name of the kafka topic to read from.
Only one telemetry type may be used for a given topic.
- `encoding` (default = otlp_proto): The encoding of the payload received from kafka. Available encodings:
- `otlp_proto`: the payload is deserialized to `ExportTraceServiceRequest`, `ExportLogsServiceRequest` or `ExportMetricsServiceRequest` respectively.
- `jaeger_proto`: the payload is deserialized to a single Jaeger proto `Span`.
Expand Down

0 comments on commit 88f8680

Please sign in to comment.