Implement vertx-kafka-client instrumentation; batch processing (#5982)

* Implement vertx-kafka-client instrumentation; batch processing * try-finally just in case * Add to supported libraries list * Update instrumentation/vertx/vertx-kafka-client-3.6/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/vertx/kafka/v3_6/InstrumentedBatchRecordsHandler.java Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com> Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>
open-telemetry · May 10, 2022 · 2fad192 · 2fad192
1 parent c22af23
commit 2fad192
Show file tree

Hide file tree

Showing 16 changed files with 728 additions and 65 deletions.
diff --git a/docs/supported-libraries.md b/docs/supported-libraries.md
@@ -114,6 +114,7 @@ These are the supported libraries and frameworks:
 | [Vaadin](https://vaadin.com/)                                                                                                     | 14.2+                          |
 | [Vert.x Web](https://vertx.io/docs/vertx-web/java/)                                                                               | 3.0+                           |
 | [Vert.x HttpClient](https://vertx.io/docs/apidocs/io/vertx/core/http/HttpClient.html)                                             | 3.0+                           |
+| [Vert.x Kafka Client](https://vertx.io/docs/vertx-kafka-client/java/)                                                             | 3.6+                           |
 | [Vert.x RxJava2](https://vertx.io/docs/vertx-rx/java2/)                                                                           | 3.5+                           |
 
 ## Application Servers

diff --git a/...ka/KafkaBatchProcessAttributesGetter.java → ...al/KafkaBatchProcessAttributesGetter.java b/...ka/KafkaBatchProcessAttributesGetter.java → ...al/KafkaBatchProcessAttributesGetter.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.javaagent.instrumentation.spring.kafka;
+package io.opentelemetry.instrumentation.kafka.internal;
 
 import io.opentelemetry.instrumentation.api.instrumenter.messaging.MessagingAttributesGetter;
 import io.opentelemetry.semconv.trace.attributes.SemanticAttributes;

diff --git a/.../KafkaBatchProcessSpanLinksExtractor.java → .../KafkaBatchProcessSpanLinksExtractor.java b/.../KafkaBatchProcessSpanLinksExtractor.java → .../KafkaBatchProcessSpanLinksExtractor.java
@@ -3,13 +3,12 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.javaagent.instrumentation.spring.kafka;
+package io.opentelemetry.instrumentation.kafka.internal;
 
 import io.opentelemetry.context.Context;
 import io.opentelemetry.context.propagation.ContextPropagators;
 import io.opentelemetry.instrumentation.api.instrumenter.SpanLinksBuilder;
 import io.opentelemetry.instrumentation.api.instrumenter.SpanLinksExtractor;
-import io.opentelemetry.instrumentation.kafka.internal.KafkaConsumerRecordGetter;
 import org.apache.kafka.clients.consumer.ConsumerRecord;
 import org.apache.kafka.clients.consumer.ConsumerRecords;
 

diff --git a/...c/main/java/io/opentelemetry/instrumentation/kafka/internal/KafkaInstrumenterFactory.java b/...c/main/java/io/opentelemetry/instrumentation/kafka/internal/KafkaInstrumenterFactory.java
@@ -19,6 +19,7 @@
 import io.opentelemetry.instrumentation.api.instrumenter.messaging.MessagingSpanNameExtractor;
 import java.util.Collections;
 import org.apache.kafka.clients.consumer.ConsumerRecord;
+import org.apache.kafka.clients.consumer.ConsumerRecords;
 import org.apache.kafka.clients.producer.ProducerRecord;
 
 /**
@@ -118,4 +119,19 @@ public Instrumenter<ReceivedRecords, Void> createConsumerReceiveInstrumenter(
       return builder.newConsumerInstrumenter(KafkaConsumerRecordGetter.INSTANCE);
     }
   }
+
+  public Instrumenter<ConsumerRecords<?, ?>, Void> createBatchProcessInstrumenter() {
+    KafkaBatchProcessAttributesGetter getter = KafkaBatchProcessAttributesGetter.INSTANCE;
+    MessageOperation operation = MessageOperation.PROCESS;
+
+    return Instrumenter.<ConsumerRecords<?, ?>, Void>builder(
+            openTelemetry,
+            instrumentationName,
+            MessagingSpanNameExtractor.create(getter, operation))
+        .addAttributesExtractor(MessagingAttributesExtractor.create(getter, operation))
+        .addSpanLinksExtractor(
+            new KafkaBatchProcessSpanLinksExtractor(openTelemetry.getPropagators()))
+        .setErrorCauseExtractor(errorCauseExtractor)
+        .newInstrumenter(SpanKindExtractor.alwaysConsumer());
+  }
 }
diff --git a/...n/java/io/opentelemetry/javaagent/instrumentation/spring/kafka/SpringKafkaSingletons.java b/...n/java/io/opentelemetry/javaagent/instrumentation/spring/kafka/SpringKafkaSingletons.java
@@ -7,10 +7,6 @@
 
 import io.opentelemetry.api.GlobalOpenTelemetry;
 import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter;
-import io.opentelemetry.instrumentation.api.instrumenter.SpanKindExtractor;
-import io.opentelemetry.instrumentation.api.instrumenter.messaging.MessageOperation;
-import io.opentelemetry.instrumentation.api.instrumenter.messaging.MessagingAttributesExtractor;
-import io.opentelemetry.instrumentation.api.instrumenter.messaging.MessagingSpanNameExtractor;
 import io.opentelemetry.instrumentation.kafka.internal.KafkaInstrumenterFactory;
 import org.apache.kafka.clients.consumer.ConsumerRecord;
 import org.apache.kafka.clients.consumer.ConsumerRecords;
@@ -19,26 +15,15 @@ public final class SpringKafkaSingletons {
 
   private static final String INSTRUMENTATION_NAME = "io.opentelemetry.spring-kafka-2.7";
 
-  private static final Instrumenter<ConsumerRecords<?, ?>, Void> BATCH_PROCESS_INSTRUMENTER =
-      buildBatchProcessInstrumenter();
-  private static final Instrumenter<ConsumerRecord<?, ?>, Void> PROCESS_INSTRUMENTER =
-      new KafkaInstrumenterFactory(GlobalOpenTelemetry.get(), INSTRUMENTATION_NAME)
-          .setErrorCauseExtractor(SpringKafkaErrorCauseExtractor.INSTANCE)
-          .createConsumerProcessInstrumenter();
-
-  private static Instrumenter<ConsumerRecords<?, ?>, Void> buildBatchProcessInstrumenter() {
-    KafkaBatchProcessAttributesGetter getter = KafkaBatchProcessAttributesGetter.INSTANCE;
-    MessageOperation operation = MessageOperation.PROCESS;
-
-    return Instrumenter.<ConsumerRecords<?, ?>, Void>builder(
-            GlobalOpenTelemetry.get(),
-            INSTRUMENTATION_NAME,
-            MessagingSpanNameExtractor.create(getter, operation))
-        .addAttributesExtractor(MessagingAttributesExtractor.create(getter, operation))
-        .addSpanLinksExtractor(
-            new KafkaBatchProcessSpanLinksExtractor(GlobalOpenTelemetry.getPropagators()))
-        .setErrorCauseExtractor(SpringKafkaErrorCauseExtractor.INSTANCE)
-        .newInstrumenter(SpanKindExtractor.alwaysConsumer());
+  private static final Instrumenter<ConsumerRecords<?, ?>, Void> BATCH_PROCESS_INSTRUMENTER;
+  private static final Instrumenter<ConsumerRecord<?, ?>, Void> PROCESS_INSTRUMENTER;
+
+  static {
+    KafkaInstrumenterFactory factory =
+        new KafkaInstrumenterFactory(GlobalOpenTelemetry.get(), INSTRUMENTATION_NAME)
+            .setErrorCauseExtractor(SpringKafkaErrorCauseExtractor.INSTANCE);
+    BATCH_PROCESS_INSTRUMENTER = factory.createBatchProcessInstrumenter();
+    PROCESS_INSTRUMENTER = factory.createConsumerProcessInstrumenter();
   }
 
   public static Instrumenter<ConsumerRecords<?, ?>, Void> batchProcessInstrumenter() {

diff --git a/...telemetry/javaagent/instrumentation/vertx/kafka/v3_6/InstrumentedBatchRecordsHandler.java b/...telemetry/javaagent/instrumentation/vertx/kafka/v3_6/InstrumentedBatchRecordsHandler.java
@@ -0,0 +1,69 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.vertx.kafka.v3_6;
+
+import static io.opentelemetry.javaagent.instrumentation.vertx.kafka.v3_6.VertxKafkaSingletons.batchProcessInstrumenter;
+
+import io.opentelemetry.context.Context;
+import io.opentelemetry.context.Scope;
+import io.opentelemetry.instrumentation.api.field.VirtualField;
+import io.opentelemetry.javaagent.bootstrap.kafka.KafkaClientsConsumerProcessTracing;
+import io.vertx.core.Handler;
+import javax.annotation.Nullable;
+import org.apache.kafka.clients.consumer.ConsumerRecords;
+
+public final class InstrumentedBatchRecordsHandler<K, V> implements Handler<ConsumerRecords<K, V>> {
+
+  private final VirtualField<ConsumerRecords<K, V>, Context> receiveContextField;
+  @Nullable private final Handler<ConsumerRecords<K, V>> delegate;
+
+  public InstrumentedBatchRecordsHandler(
+      VirtualField<ConsumerRecords<K, V>, Context> receiveContextField,
+      @Nullable Handler<ConsumerRecords<K, V>> delegate) {
+    this.receiveContextField = receiveContextField;
+    this.delegate = delegate;
+  }
+
+  @Override
+  public void handle(ConsumerRecords<K, V> records) {
+    Context parentContext = getParentContext(records);
+
+    if (!batchProcessInstrumenter().shouldStart(parentContext, records)) {
+      callDelegateHandler(records);
+      return;
+    }
+
+    // the instrumenter iterates over records when adding links, we need to suppress that
+    boolean previousWrappingEnabled = KafkaClientsConsumerProcessTracing.setEnabled(false);
+    try {
+      Context context = batchProcessInstrumenter().start(parentContext, records);
+      Throwable error = null;
+      try (Scope ignored = context.makeCurrent()) {
+        callDelegateHandler(records);
+      } catch (Throwable t) {
+        error = t;
+        throw t;
+      } finally {
+        batchProcessInstrumenter().end(context, records, null, error);
+      }
+    } finally {
+      KafkaClientsConsumerProcessTracing.setEnabled(previousWrappingEnabled);
+    }
+  }
+
+  private Context getParentContext(ConsumerRecords<K, V> records) {
+    Context receiveContext = receiveContextField.get(records);
+
+    // use the receive CONSUMER span as parent if it's available
+    return receiveContext != null ? receiveContext : Context.current();
+  }
+
+  private void callDelegateHandler(ConsumerRecords<K, V> records) {
+    if (delegate != null) {
+      delegate.handle(records);
+    }
+  }
+}
diff --git a/...telemetry/javaagent/instrumentation/vertx/kafka/v3_6/InstrumentedSingleRecordHandler.java b/...telemetry/javaagent/instrumentation/vertx/kafka/v3_6/InstrumentedSingleRecordHandler.java
@@ -47,8 +47,8 @@ public void handle(ConsumerRecord<K, V> record) {
     }
   }
 
-  private Context getParentContext(ConsumerRecord<K, V> records) {
-    Context receiveContext = receiveContextField.get(records);
+  private Context getParentContext(ConsumerRecord<K, V> record) {
+    Context receiveContext = receiveContextField.get(record);
 
     // use the receive CONSUMER span as parent if it's available
     return receiveContext != null ? receiveContext : Context.current();

diff --git a/...emetry/javaagent/instrumentation/vertx/kafka/v3_6/KafkaReadStreamImplInstrumentation.java b/...emetry/javaagent/instrumentation/vertx/kafka/v3_6/KafkaReadStreamImplInstrumentation.java
@@ -64,7 +64,10 @@ public static class BatchHandlerAdvice {
     @Advice.OnMethodEnter(suppress = Throwable.class)
     public static <K, V> void onEnter(
         @Advice.Argument(value = 0, readOnly = false) Handler<ConsumerRecords<K, V>> handler) {
-      // TODO: next PR
+
+      VirtualField<ConsumerRecords<K, V>, Context> receiveContextField =
+          VirtualField.find(ConsumerRecords.class, Context.class);
+      handler = new InstrumentedBatchRecordsHandler<>(receiveContextField, handler);
     }
   }
 

diff --git a/...ava/io/opentelemetry/javaagent/instrumentation/vertx/kafka/v3_6/VertxKafkaSingletons.java b/...ava/io/opentelemetry/javaagent/instrumentation/vertx/kafka/v3_6/VertxKafkaSingletons.java
@@ -9,14 +9,25 @@
 import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter;
 import io.opentelemetry.instrumentation.kafka.internal.KafkaInstrumenterFactory;
 import org.apache.kafka.clients.consumer.ConsumerRecord;
+import org.apache.kafka.clients.consumer.ConsumerRecords;
 
 public final class VertxKafkaSingletons {
 
   private static final String INSTRUMENTATION_NAME = "io.opentelemetry.vertx-kafka-client-3.5";
 
-  private static final Instrumenter<ConsumerRecord<?, ?>, Void> PROCESS_INSTRUMENTER =
-      new KafkaInstrumenterFactory(GlobalOpenTelemetry.get(), INSTRUMENTATION_NAME)
-          .createConsumerProcessInstrumenter();
+  private static final Instrumenter<ConsumerRecords<?, ?>, Void> BATCH_PROCESS_INSTRUMENTER;
+  private static final Instrumenter<ConsumerRecord<?, ?>, Void> PROCESS_INSTRUMENTER;
+
+  static {
+    KafkaInstrumenterFactory factory =
+        new KafkaInstrumenterFactory(GlobalOpenTelemetry.get(), INSTRUMENTATION_NAME);
+    BATCH_PROCESS_INSTRUMENTER = factory.createBatchProcessInstrumenter();
+    PROCESS_INSTRUMENTER = factory.createConsumerProcessInstrumenter();
+  }
+
+  public static Instrumenter<ConsumerRecords<?, ?>, Void> batchProcessInstrumenter() {
+    return BATCH_PROCESS_INSTRUMENTER;
+  }
 
   public static Instrumenter<ConsumerRecord<?, ?>, Void> processInstrumenter() {
     return PROCESS_INSTRUMENTER;