Skip to content

add missing configurations to the kafka documents #14225

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
trask merged 4 commits into from
Jul 15, 2025
Merged

add missing configurations to the kafka documents #14225

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ac1224d
add missing configurations to kafka 0.11
mznet Jul 11, 2025
fec1c05
fix the typo in the metadata, clarify the wording, and restore the re…
mznet Jul 12, 2025
b6dd5a8
Merge branch 'main' into add-kafka-metadata
mznet Jul 12, 2025
28e4089
remove the incorrect number from the readme
mznet Jul 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions instrumentation/kafka/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# Settings for the Kafka instrumentation

| System property | Type | Default | Description |
|-----------------------------------------------------------| ------- |---------|--------------------------------------------------------------------------------------------------------------------------------|
| `otel.instrumentation.kafka.experimental-span-attributes` | Boolean | `false` | Enable the capture of experimental span attributes. |
| `otel.instrumentation.kafka.producer-propagation.enabled` | Boolean | `true` | Enable context propagation for kafka message producer. |
| System property | Type | Default | Description |
|-----------------------------------------------------------|---------|---------|----------------------------------------------------------------------------|
| `otel.instrumentation.kafka.experimental-span-attributes` | Boolean | `false` | Enable the capture of experimental span attributes. |
| `otel.instrumentation.kafka.producer-propagation.enabled` | Boolean | `true` | Enable context propagation for kafka message producer. |
| `otel.instrumentation.messaging.experimental.capture-headers` | List | Empty | Enable the capture of experimental headers in messaging systems. |
| `otel.instrumentation.messaging.experimental.receive-telemetry.enabled` | Boolean | `false` | Enable the capture of experimental receive telemetry in messaging systems. |
Copy link
Contributor

@laurit laurit Jul 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we currently don't list the common options in the readme files.

Copy link
Contributor Author

@mznet mznet Jul 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@laurit I reverted the README because my previous change was unnecessary.

---------
11 changes: 11 additions & 0 deletions instrumentation/kafka/kafka-clients/kafka-clients-0.11/metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
description: >
This instrumentation provides producer and consumer spans and metrics for Apache Kafka 0.11 clients.
It automatically traces message production and consumption, propagates context, and emits metrics for production and consumption.
configurations:
- name: otel.instrumentation.kafka.producer-propagation.enabled
description: Enable context propagation for kafka message producers.
Expand All @@ -7,3 +10,11 @@ configurations:
description: Enables the capture of the experimental consumer attribute "kafka.record.queue_time_ms"
type: boolean
default: false
- name: otel.instrumentation.messaging.experimental.capture-headers
description: Allows configuring headers to capture as span attributes.
type: list
default: ''
- name: otel.instrumentation.messaging.experimental.receive-telemetry.enabled
description: Enables experimental receive telemetry for AWS SDK instrumentation.
type: boolean
default: false
2 changes: 2 additions & 0 deletions instrumentation/kafka/kafka-clients/kafka-clients-2.6/metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
description: >
This instrumentation provides a library integeration that enables producer and consumer spans and metrics for Apache Kafka 2.6+ clients.
Loading