From ac1224df0d04c03111d75f1d178fa5f951de06c2 Mon Sep 17 00:00:00 2001 From: Minje Park Date: Fri, 11 Jul 2025 15:17:07 +0900 Subject: [PATCH 1/3] add missing configurations to kafka 0.11 --- instrumentation/kafka/README.md | 11 +++++++---- .../kafka-clients/kafka-clients-0.11/metadata.yaml | 11 +++++++++++ .../kafka-clients/kafka-clients-2.6/metadata.yaml | 2 ++ 3 files changed, 20 insertions(+), 4 deletions(-) create mode 100644 instrumentation/kafka/kafka-clients/kafka-clients-2.6/metadata.yaml diff --git a/instrumentation/kafka/README.md b/instrumentation/kafka/README.md index 9d8d3b24e70a..207b74709389 100644 --- a/instrumentation/kafka/README.md +++ b/instrumentation/kafka/README.md @@ -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. | +--------- diff --git a/instrumentation/kafka/kafka-clients/kafka-clients-0.11/metadata.yaml b/instrumentation/kafka/kafka-clients/kafka-clients-0.11/metadata.yaml index 7b42919bb1b8..b0c339dbd43f 100644 --- a/instrumentation/kafka/kafka-clients/kafka-clients-0.11/metadata.yaml +++ b/instrumentation/kafka/kafka-clients/kafka-clients-0.11/metadata.yaml @@ -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. @@ -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 diff --git a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/metadata.yaml b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/metadata.yaml new file mode 100644 index 000000000000..91ffb7f4e0ec --- /dev/null +++ b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/metadata.yaml @@ -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. From fec1c0507b117dc1dc3c8217fe49b59075cbd624 Mon Sep 17 00:00:00 2001 From: Minje Park Date: Sat, 12 Jul 2025 17:44:18 +0900 Subject: [PATCH 2/3] fix the typo in the metadata, clarify the wording, and restore the readme. --- instrumentation/kafka/README.md | 11 ++++------- .../kafka-clients/kafka-clients-0.11/metadata.yaml | 6 +++--- .../kafka-clients/kafka-clients-2.6/metadata.yaml | 2 +- 3 files changed, 8 insertions(+), 11 deletions(-) diff --git a/instrumentation/kafka/README.md b/instrumentation/kafka/README.md index 207b74709389..77b134bfbc40 100644 --- a/instrumentation/kafka/README.md +++ b/instrumentation/kafka/README.md @@ -1,9 +1,6 @@ # 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. | -| `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. | ---------- +| 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. |1 diff --git a/instrumentation/kafka/kafka-clients/kafka-clients-0.11/metadata.yaml b/instrumentation/kafka/kafka-clients/kafka-clients-0.11/metadata.yaml index b0c339dbd43f..5da6ed1a9c89 100644 --- a/instrumentation/kafka/kafka-clients/kafka-clients-0.11/metadata.yaml +++ b/instrumentation/kafka/kafka-clients/kafka-clients-0.11/metadata.yaml @@ -1,5 +1,5 @@ description: > - This instrumentation provides producer and consumer spans and metrics for Apache Kafka 0.11 clients. + This instrumentation provides messaging 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 @@ -11,10 +11,10 @@ configurations: type: boolean default: false - name: otel.instrumentation.messaging.experimental.capture-headers - description: Allows configuring headers to capture as span attributes. + description: A comma-separated list of header names 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. + description: Enables experimental receive telemetry for Kafka instrumentation. type: boolean default: false diff --git a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/metadata.yaml b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/metadata.yaml index 91ffb7f4e0ec..5898d2e01872 100644 --- a/instrumentation/kafka/kafka-clients/kafka-clients-2.6/metadata.yaml +++ b/instrumentation/kafka/kafka-clients/kafka-clients-2.6/metadata.yaml @@ -1,2 +1,2 @@ description: > - This instrumentation provides a library integeration that enables producer and consumer spans and metrics for Apache Kafka 2.6+ clients. + This instrumentation provides a library integeration that enables messaging spans and metrics for Apache Kafka 2.6+ clients. From 28e40894e3554a6e58e7b79c380e72d8abbdb3c0 Mon Sep 17 00:00:00 2001 From: Minje Park Date: Sat, 12 Jul 2025 17:46:18 +0900 Subject: [PATCH 3/3] remove the incorrect number from the readme --- instrumentation/kafka/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/instrumentation/kafka/README.md b/instrumentation/kafka/README.md index 77b134bfbc40..9d8d3b24e70a 100644 --- a/instrumentation/kafka/README.md +++ b/instrumentation/kafka/README.md @@ -3,4 +3,4 @@ | 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. |1 +| `otel.instrumentation.kafka.producer-propagation.enabled` | Boolean | `true` | Enable context propagation for kafka message producer. |