internal

Author: trask

instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/README.md

@@ -31,11 +31,9 @@ There are two options for capturing traces, either using interceptors or wrappin
 
 #### Using interceptors
 
-The Kafka clients API provides a way to "intercept" messages before they are sent to the brokers as well as messages received from the broker before being passed to the application.
-The OpenTelemetry instrumented Kafka library provides two interceptors to be configured to add tracing information automatically.
-The interceptor class has to be set in the properties bag used to create the Kafka client.
+The Kafka clients API provides a way to intercept messages before they are sent to the brokers as well as messages received from the broker before being passed to the application.
 
-For the producer:
+To intercept messages and emit telemetry for a `KafkaProducer`:
 
 ```java
 KafkaTelemetry telemetry = KafkaTelemetry.create(openTelemetry);
@@ -47,7 +45,7 @@ props.putAll(telemetry.producerInterceptorConfigProperties());
 Producer<String, String> producer = new KafkaProducer<>(props);
 ```
 
-For the consumer:
+To intercept messages and emit telemetry for a `KafkaConsumer`:
 
 ```java
 KafkaTelemetry telemetry = KafkaTelemetry.create(openTelemetry);

instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/main/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/KafkaTelemetry.java

@@ -26,6 +26,8 @@
 import io.opentelemetry.instrumentation.kafkaclients.common.v0_11.internal.OpenTelemetryMetricsReporter;
 import io.opentelemetry.instrumentation.kafkaclients.common.v0_11.internal.OpenTelemetrySupplier;
 import io.opentelemetry.instrumentation.kafkaclients.common.v0_11.internal.TracingList;
+import io.opentelemetry.instrumentation.kafkaclients.v2_6.internal.OpenTelemetryConsumerInterceptor;
+import io.opentelemetry.instrumentation.kafkaclients.v2_6.internal.OpenTelemetryProducerInterceptor;
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Proxy;
 import java.util.Collections;

instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/main/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/OpenTelemetryConsumerInterceptor.java renamed to instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/main/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/internal/OpenTelemetryConsumerInterceptor.java

@@ -3,13 +3,14 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.kafkaclients.v2_6;
+package io.opentelemetry.instrumentation.kafkaclients.v2_6.internal;
 
 import com.google.errorprone.annotations.CanIgnoreReturnValue;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.instrumentation.api.internal.Timer;
 import io.opentelemetry.instrumentation.kafkaclients.common.v0_11.internal.KafkaConsumerContext;
 import io.opentelemetry.instrumentation.kafkaclients.common.v0_11.internal.KafkaConsumerContextUtil;
+import io.opentelemetry.instrumentation.kafkaclients.v2_6.KafkaTelemetry;
 import java.util.Map;
 import java.util.Objects;
 import java.util.function.Supplier;
@@ -21,14 +22,10 @@
 import org.apache.kafka.common.TopicPartition;
 
 /**
- * A ConsumerInterceptor that adds OpenTelemetry instrumentation. Add this interceptor's class name
- * or class via ConsumerConfig.INTERCEPTOR_CLASSES_CONFIG property to your Consumer's properties to
- * get it instantiated and used. See more details on ConsumerInterceptor usage in its Javadoc.
+ * A ConsumerInterceptor that adds OpenTelemetry instrumentation.
  *
- * <p>To configure the interceptor, use {@link KafkaTelemetry#consumerInterceptorConfigProperties}
- * to obtain the configuration properties and add them to your consumer configuration.
- *
- * @see KafkaTelemetry#consumerInterceptorConfigProperties()
+ * <p>This class is internal and is hence not for public use. Its APIs are unstable and can change
+ * at any time.
  */
 public class OpenTelemetryConsumerInterceptor<K, V> implements ConsumerInterceptor<K, V> {
 

instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/main/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/OpenTelemetryProducerInterceptor.java renamed to instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/main/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/internal/OpenTelemetryProducerInterceptor.java

@@ -3,9 +3,10 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.instrumentation.kafkaclients.v2_6;
+package io.opentelemetry.instrumentation.kafkaclients.v2_6.internal;
 
 import com.google.errorprone.annotations.CanIgnoreReturnValue;
+import io.opentelemetry.instrumentation.kafkaclients.v2_6.KafkaTelemetry;
 import java.util.Map;
 import java.util.Objects;
 import java.util.function.Supplier;
@@ -16,14 +17,10 @@
 import org.apache.kafka.clients.producer.RecordMetadata;
 
 /**
- * A ProducerInterceptor that adds OpenTelemetry instrumentation. Add this interceptor's class name
- * or class via ProducerConfig.INTERCEPTOR_CLASSES_CONFIG property to your Producer's properties to
- * get it instantiated and used. See more details on ProducerInterceptor usage in its Javadoc.
+ * A ProducerInterceptor that adds OpenTelemetry instrumentation.
  *
- * <p>To configure the interceptor, use {@link KafkaTelemetry#producerInterceptorConfigProperties}
- * to obtain the configuration properties and add them to your producer configuration.
- *
- * @see KafkaTelemetry#producerInterceptorConfigProperties()
+ * <p>This class is internal and is hence not for public use. Its APIs are unstable and can change
+ * at any time.
  */
 public class OpenTelemetryProducerInterceptor<K, V> implements ProducerInterceptor<K, V> {
 

instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/KafkaTelemetryInterceptorTest.java

@@ -8,6 +8,8 @@
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatThrownBy;
 
+import io.opentelemetry.instrumentation.kafkaclients.v2_6.internal.OpenTelemetryConsumerInterceptor;
+import io.opentelemetry.instrumentation.kafkaclients.v2_6.internal.OpenTelemetryProducerInterceptor;
 import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
 import io.opentelemetry.instrumentation.testing.junit.LibraryInstrumentationExtension;
 import java.io.ByteArrayInputStream;