Apache Kafka Client
OpenTelemetry Java agent instrumentation
This instrumentation enables messaging spans for Kafka producers and consumers, and collects internal Kafka client metrics.
- Name:
kafka-clients-0.11 - Scope:
io.opentelemetry.kafka-clients-0.11 - Target versions:
org.apache.kafka:kafka-clients:[0.11.0.0,) - Library: https://kafka.apache.org/
Telemetry
- Span attributes:
messaging.batch.message_count,messaging.client_id,messaging.destination.name,messaging.destination.partition.id,messaging.kafka.consumer.group,messaging.kafka.message.key,messaging.kafka.message.offset,messaging.kafka.message.tombstone,messaging.message.body.size,messaging.operation,messaging.system,kafka.record.queue_time_ms,messaging.kafka.bootstrap.servers,messaging.kafka.offset
Configuration
| Option | Type | Default | Description |
|---|---|---|---|
otel.instrumentation.messaging.experimental.capture-headers | list | A comma-separated list of header names to capture as span attributes. | |
otel.instrumentation.kafka.experimental-span-attributes | boolean | false | Enables the capture of the experimental consumer attributes kafka.record.queue_time_ms and messaging.kafka.bootstrap.servers. |
otel.instrumentation.kafka.producer-propagation.enabled | boolean | true | Enable context propagation for Kafka message producers. |
otel.instrumentation.messaging.experimental.receive-telemetry.enabled | boolean | false | Enables experimental receive telemetry, which will cause consumers to start a new trace, with only a span link connecting it to the producer trace. |