Skip to content
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.

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

Update muzzleCheck for kafka #7912

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ muzzle {
pass {
group = "org.apache.kafka"
module = "kafka-clients"
versions = "[0.11.0.0,)"
versions = "[0.11.0.0,3.7.0)"
assertInverse = true
}
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package datadog.trace.instrumentation.kafka_clients;

import static datadog.trace.agent.tooling.bytebuddy.matcher.ClassLoaderMatchers.hasClassNamed;
import static datadog.trace.agent.tooling.bytebuddy.matcher.NameMatchers.named;
import static datadog.trace.core.datastreams.TagsProcessor.CONSUMER_GROUP_TAG;
import static datadog.trace.core.datastreams.TagsProcessor.KAFKA_CLUSTER_ID_TAG;
Expand All @@ -17,11 +18,13 @@
import java.util.LinkedHashMap;
import java.util.Map;
import net.bytebuddy.asm.Advice;
import net.bytebuddy.matcher.ElementMatcher;
import org.apache.kafka.clients.Metadata;
import org.apache.kafka.clients.consumer.ConsumerRecord;
import org.apache.kafka.clients.consumer.OffsetAndMetadata;
import org.apache.kafka.clients.consumer.internals.ConsumerCoordinator;
import org.apache.kafka.clients.consumer.internals.RequestFuture;
import org.apache.kafka.clients.producer.Producer;
import org.apache.kafka.common.TopicPartition;

@AutoService(InstrumenterModule.class)
Expand All @@ -32,6 +35,13 @@ public ConsumerCoordinatorInstrumentation() {
super("kafka");
}

@Override
public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() {
// Avoid matching kafka 3.8 which has its own instrumentation
return not(
hasClassNamed("org.apache.kafka.clients.consumer.internals.OffsetCommitCallbackInvoker"));
}

@Override
public Map<String, String> contextStore() {
Map<String, String> contextStores = new HashMap<>();
Expand Down Expand Up @@ -107,10 +117,12 @@ public static void trackCommitOffset(
}
}

public static void muzzleCheck(ConsumerRecord record) {
public static void muzzleCheck(ConsumerRecord record, Producer producer) {
// KafkaConsumerInstrumentation only applies for kafka versions with headers
// Make an explicit call so ConsumerCoordinatorInstrumentation does the same
record.headers();
record.checksum();
producer.close(2, java.util.concurrent.TimeUnit.SECONDS);
}
}
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package datadog.trace.instrumentation.kafka_clients;

import static datadog.trace.agent.tooling.bytebuddy.matcher.ClassLoaderMatchers.hasClassNamed;
import static datadog.trace.agent.tooling.bytebuddy.matcher.NameMatchers.named;
import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.activateSpan;
import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.activeSpan;
Expand All @@ -9,6 +10,7 @@
import static net.bytebuddy.matcher.ElementMatchers.isConstructor;
import static net.bytebuddy.matcher.ElementMatchers.isMethod;
import static net.bytebuddy.matcher.ElementMatchers.isPublic;
import static net.bytebuddy.matcher.ElementMatchers.not;
import static net.bytebuddy.matcher.ElementMatchers.returns;
import static net.bytebuddy.matcher.ElementMatchers.takesArgument;
import static net.bytebuddy.matcher.ElementMatchers.takesArguments;
Expand All @@ -24,12 +26,14 @@
import java.util.List;
import java.util.Map;
import net.bytebuddy.asm.Advice;
import net.bytebuddy.matcher.ElementMatcher;
import org.apache.kafka.clients.Metadata;
import org.apache.kafka.clients.consumer.ConsumerConfig;
import org.apache.kafka.clients.consumer.ConsumerRecord;
import org.apache.kafka.clients.consumer.ConsumerRecords;
import org.apache.kafka.clients.consumer.KafkaConsumer;
import org.apache.kafka.clients.consumer.internals.ConsumerCoordinator;
import org.apache.kafka.clients.producer.Producer;

/**
* This instrumentation saves additional information from the KafkaConsumer, such as consumer group
Expand Down Expand Up @@ -57,6 +61,13 @@ public Map<String, String> contextStore() {
return contextStores;
}

@Override
public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() {
// Avoid matching kafka 3.8 which has its own instrumentation
return not(
hasClassNamed("org.apache.kafka.clients.consumer.internals.OffsetCommitCallbackInvoker"));
}

@Override
public String instrumentedType() {
return "org.apache.kafka.clients.consumer.KafkaConsumer";
Expand Down Expand Up @@ -176,4 +187,11 @@ public static void captureGroup(
scope.close();
}
}

public static void muzzleCheck(ConsumerRecord record, Producer producer) {
// KafkaConsumerInstrumentation only applies for kafka versions with headers
// Make an explicit call so ConsumerCoordinatorInstrumentation does the same
record.headers();
producer.close(2, java.util.concurrent.TimeUnit.SECONDS);
}
}
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
package datadog.trace.instrumentation.kafka_clients;

import static datadog.trace.agent.tooling.bytebuddy.matcher.ClassLoaderMatchers.hasClassNamed;
import static datadog.trace.agent.tooling.bytebuddy.matcher.NameMatchers.named;
import static datadog.trace.instrumentation.kafka_clients.KafkaDecorator.CONSUMER_DECORATE;
import static datadog.trace.instrumentation.kafka_clients.KafkaDecorator.KAFKA_CONSUME;
import static net.bytebuddy.matcher.ElementMatchers.isMethod;
import static net.bytebuddy.matcher.ElementMatchers.isPublic;
import static net.bytebuddy.matcher.ElementMatchers.not;
import static net.bytebuddy.matcher.ElementMatchers.returns;
import static net.bytebuddy.matcher.ElementMatchers.takesArgument;
import static net.bytebuddy.matcher.ElementMatchers.takesArguments;
Expand All @@ -18,9 +20,11 @@
import java.util.List;
import java.util.Map;
import net.bytebuddy.asm.Advice;
import net.bytebuddy.matcher.ElementMatcher;
import org.apache.kafka.clients.Metadata;
import org.apache.kafka.clients.consumer.ConsumerRecord;
import org.apache.kafka.clients.consumer.ConsumerRecords;
import org.apache.kafka.clients.producer.Producer;

@AutoService(InstrumenterModule.class)
public final class KafkaConsumerInstrumentation extends InstrumenterModule.Tracing
Expand All @@ -39,6 +43,12 @@ public Map<String, String> contextStore() {
return contextStores;
}

public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() {
// Avoid matching kafka 3.8 which has its own instrumentation
return not(
hasClassNamed("org.apache.kafka.clients.consumer.internals.OffsetCommitCallbackInvoker"));
}

@Override
public String instrumentedType() {
return "org.apache.kafka.clients.consumer.ConsumerRecords";
Expand Down Expand Up @@ -108,6 +118,14 @@ public static void wrap(
iterable, KAFKA_CONSUME, CONSUMER_DECORATE, group, clusterId, bootstrapServers);
}
}

public static void muzzleCheck(ConsumerRecord record, Producer producer) {
// KafkaConsumerInstrumentation only applies for kafka versions with headers
// Make an explicit call so ConsumerCoordinatorInstrumentation does the same
record.headers();
record.checksum();
producer.close(2, java.util.concurrent.TimeUnit.SECONDS);
}
}

public static class ListAdvice {
Expand All @@ -130,6 +148,14 @@ public static void wrap(
iterable, KAFKA_CONSUME, CONSUMER_DECORATE, group, clusterId, bootstrapServers);
}
}

public static void muzzleCheck(ConsumerRecord record, Producer producer) {
// KafkaConsumerInstrumentation only applies for kafka versions with headers
// Make an explicit call so ConsumerCoordinatorInstrumentation does the same
record.headers();
record.checksum();
producer.close(2, java.util.concurrent.TimeUnit.SECONDS);
}
}

public static class IteratorAdvice {
Expand All @@ -152,5 +178,13 @@ public static void wrap(
iterator, KAFKA_CONSUME, CONSUMER_DECORATE, group, clusterId, bootstrapServers);
}
}

public static void muzzleCheck(ConsumerRecord record, Producer producer) {
// KafkaConsumerInstrumentation only applies for kafka versions with headers
// Make an explicit call so ConsumerCoordinatorInstrumentation does the same
record.headers();
record.checksum();
producer.close(2, java.util.concurrent.TimeUnit.SECONDS);
}
}
}
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
package datadog.trace.instrumentation.kafka_clients;

import static datadog.trace.agent.tooling.bytebuddy.matcher.ClassLoaderMatchers.hasClassNamed;
import static datadog.trace.agent.tooling.bytebuddy.matcher.HierarchyMatchers.hasInterface;
import static datadog.trace.agent.tooling.bytebuddy.matcher.NameMatchers.named;
import static java.util.Collections.singletonMap;
import static net.bytebuddy.matcher.ElementMatchers.not;
import static net.bytebuddy.matcher.ElementMatchers.takesArgument;
import static net.bytebuddy.matcher.ElementMatchers.takesArguments;

Expand All @@ -20,6 +22,8 @@
import net.bytebuddy.asm.Advice;
import net.bytebuddy.description.type.TypeDescription;
import net.bytebuddy.matcher.ElementMatcher;
import org.apache.kafka.clients.consumer.ConsumerRecord;
import org.apache.kafka.clients.producer.Producer;
import org.apache.kafka.common.serialization.Deserializer;

@AutoService(InstrumenterModule.class)
Expand All @@ -44,6 +48,12 @@ public KafkaDeserializerInstrumentation() {
super("kafka");
}

public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() {
// Avoid matching kafka 3.8 which has its own instrumentation
return not(
hasClassNamed("org.apache.kafka.clients.consumer.internals.OffsetCommitCallbackInvoker"));
}

@Override
public String hierarchyMarkerType() {
return DESERIALIZER_CLASS;
Expand Down Expand Up @@ -95,6 +105,13 @@ public static void configure(
InstrumentationContext.get(Deserializer.class, Boolean.class);
KafkaIastHelper.configure(store, deserializer, isKey);
}

public static void muzzleCheck(ConsumerRecord record, Producer producer) {
// KafkaConsumerInstrumentation only applies for kafka versions with headers
// Make an explicit call so ConsumerCoordinatorInstrumentation does the same
record.headers();
producer.close(2, java.util.concurrent.TimeUnit.SECONDS);
}
}

@SuppressWarnings("rawtypes")
Expand All @@ -120,6 +137,13 @@ public static void afterDeserialize(
InstrumentationContext.get(Deserializer.class, Boolean.class);
KafkaIastHelper.afterDeserialize(ctx, store, deserializer, result);
}

public static void muzzleCheck(ConsumerRecord record, Producer producer) {
// KafkaConsumerInstrumentation only applies for kafka versions with headers
// Make an explicit call so ConsumerCoordinatorInstrumentation does the same
record.headers();
producer.close(2, java.util.concurrent.TimeUnit.SECONDS);
}
}

@SuppressWarnings({"rawtypes", "JavaExistingMethodCanBeUsed"})
Expand All @@ -145,6 +169,13 @@ public static void afterDeserialize(
InstrumentationContext.get(Deserializer.class, Boolean.class);
KafkaIastHelper.afterDeserialize(ctx, store, deserializer, result);
}

public static void muzzleCheck(ConsumerRecord record, Producer producer) {
// KafkaConsumerInstrumentation only applies for kafka versions with headers
// Make an explicit call so ConsumerCoordinatorInstrumentation does the same
record.headers();
producer.close(2, java.util.concurrent.TimeUnit.SECONDS);
}
}

@SuppressWarnings({"rawtypes", "JavaExistingMethodCanBeUsed"})
Expand All @@ -170,5 +201,12 @@ public static void afterDeserialize(
InstrumentationContext.get(Deserializer.class, Boolean.class);
KafkaIastHelper.afterDeserialize(ctx, store, deserializer, result);
}

public static void muzzleCheck(ConsumerRecord record, Producer producer) {
// KafkaConsumerInstrumentation only applies for kafka versions with headers
// Make an explicit call so ConsumerCoordinatorInstrumentation does the same
record.headers();
producer.close(2, java.util.concurrent.TimeUnit.SECONDS);
}
}
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package datadog.trace.instrumentation.kafka_clients;

import static datadog.trace.agent.tooling.bytebuddy.matcher.ClassLoaderMatchers.hasClassNamed;
import static datadog.trace.agent.tooling.bytebuddy.matcher.NameMatchers.named;
import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.activateSpan;
import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.activeSpan;
Expand All @@ -18,6 +19,7 @@
import static net.bytebuddy.matcher.ElementMatchers.isMethod;
import static net.bytebuddy.matcher.ElementMatchers.isPrivate;
import static net.bytebuddy.matcher.ElementMatchers.isPublic;
import static net.bytebuddy.matcher.ElementMatchers.not;
import static net.bytebuddy.matcher.ElementMatchers.takesArgument;

import com.google.auto.service.AutoService;
Expand All @@ -33,9 +35,12 @@
import java.util.LinkedHashMap;
import java.util.Map;
import net.bytebuddy.asm.Advice;
import net.bytebuddy.matcher.ElementMatcher;
import org.apache.kafka.clients.ApiVersions;
import org.apache.kafka.clients.Metadata;
import org.apache.kafka.clients.consumer.ConsumerRecord;
import org.apache.kafka.clients.producer.Callback;
import org.apache.kafka.clients.producer.Producer;
import org.apache.kafka.clients.producer.ProducerConfig;
import org.apache.kafka.clients.producer.ProducerRecord;
import org.apache.kafka.clients.producer.internals.Sender;
Expand All @@ -49,6 +54,12 @@ public KafkaProducerInstrumentation() {
super("kafka");
}

public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() {
// Avoid matching kafka 3.8 which has its own instrumentation
return not(
hasClassNamed("org.apache.kafka.clients.consumer.internals.OffsetCommitCallbackInvoker"));
}

@Override
public String instrumentedType() {
return "org.apache.kafka.clients.producer.KafkaProducer";
Expand Down Expand Up @@ -177,6 +188,13 @@ public static void stopSpan(
PRODUCER_DECORATE.beforeFinish(scope);
scope.close();
}

public static void muzzleCheck(ConsumerRecord record, Producer producer) {
// KafkaConsumerInstrumentation only applies for kafka versions with headers
// Make an explicit call so ConsumerCoordinatorInstrumentation does the same
record.headers();
producer.close(2, java.util.concurrent.TimeUnit.SECONDS);
}
}

public static class PayloadSizeAdvice {
Expand Down Expand Up @@ -205,5 +223,12 @@ public static void onEnter(@Advice.Argument(value = 0) int estimatedPayloadSize)
AgentTracer.get().getDataStreamsMonitoring().add(updated);
}
}

public static void muzzleCheck(ConsumerRecord record, Producer producer) {
// KafkaConsumerInstrumentation only applies for kafka versions with headers
// Make an explicit call so ConsumerCoordinatorInstrumentation does the same
record.headers();
producer.close(2, java.util.concurrent.TimeUnit.SECONDS);
}
}
}
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
package datadog.trace.instrumentation.kafka_clients;

import static datadog.trace.agent.tooling.bytebuddy.matcher.ClassLoaderMatchers.hasClassNamed;
import static datadog.trace.agent.tooling.bytebuddy.matcher.HierarchyMatchers.extendsClass;
import static datadog.trace.agent.tooling.bytebuddy.matcher.NameMatchers.named;
import static java.util.Collections.singletonMap;
import static net.bytebuddy.matcher.ElementMatchers.isMethod;
import static net.bytebuddy.matcher.ElementMatchers.not;
import static net.bytebuddy.matcher.ElementMatchers.takesArgument;

import com.google.auto.service.AutoService;
Expand All @@ -16,6 +18,7 @@
import net.bytebuddy.matcher.ElementMatcher;
import org.apache.kafka.clients.Metadata;
import org.apache.kafka.clients.consumer.ConsumerRecord;
import org.apache.kafka.clients.producer.Producer;
import org.apache.kafka.common.Cluster;
import org.apache.kafka.common.requests.MetadataResponse;

Expand All @@ -27,6 +30,12 @@ public MetadataInstrumentation() {
super("kafka");
}

public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() {
// Avoid matching kafka 3.8 which has its own instrumentation
return not(
hasClassNamed("org.apache.kafka.clients.consumer.internals.OffsetCommitCallbackInvoker"));
}

@Override
public String hierarchyMarkerType() {
return "org.apache.kafka.clients.Metadata";
Expand Down Expand Up @@ -88,10 +97,11 @@ public static void onEnter(
}
}

public static void muzzleCheck(ConsumerRecord record) {
public static void muzzleCheck(ConsumerRecord record, Producer producer) {
// KafkaConsumerInstrumentation only applies for kafka versions with headers
// Make an explicit call so MetadataInstrumentation does the same
// Make an explicit call so ConsumerCoordinatorInstrumentation does the same
record.headers();
producer.close(2, java.util.concurrent.TimeUnit.SECONDS);
}
}
}
Loading
Loading