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.

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

Implement ExtendedTextMapGetter in kafka-clients instrumentation #13068

Merged
merged 2 commits into from
Jan 21, 2025
Merged

Implement ExtendedTextMapGetter in kafka-clients instrumentation #13068

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a2b2abd
Implement ExtendedTextMapGetter in kafka-clients instrumentation
xiepuhuan Jan 19, 2025
b2d4035
Remove ParameterizedTest
xiepuhuan Jan 20, 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
28 changes: 24 additions & 4 deletions ...try/javaagent/instrumentation/kafkaclients/v0_11/KafkaClientSuppressReceiveSpansTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
import io.opentelemetry.instrumentation.kafka.internal.KafkaClientPropagationBaseTest;
import io.opentelemetry.instrumentation.testing.junit.AgentInstrumentationExtension;
import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
import java.nio.charset.StandardCharsets;
import java.time.Duration;
import java.util.List;
import java.util.concurrent.ExecutionException;
Expand All @@ -22,19 +23,37 @@
import org.apache.kafka.clients.producer.ProducerRecord;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;

class KafkaClientSuppressReceiveSpansTest extends KafkaClientPropagationBaseTest {
@RegisterExtension
static final InstrumentationExtension testing = AgentInstrumentationExtension.create();

@Test
void testKafkaProduceAndConsume() throws InterruptedException {
@ParameterizedTest
@ValueSource(strings = {"testSingleBaggage", "testMultiBaggage"})
void testKafkaProduceAndConsume(String testBaggageKind) throws InterruptedException {
String greeting = "Hello Kafka!";
testing.runWithSpan(
"parent",
() -> {
ProducerRecord<Integer, String> producerRecord =
new ProducerRecord<>(SHARED_TOPIC, 10, greeting);
producerRecord
.headers()
// adding baggage header in w3c baggage format
.add(
"baggage",
"test-baggage-key-1=test-baggage-value-1".getBytes(StandardCharsets.UTF_8));
if (testBaggageKind.equals("testMultiBaggage")) {
producerRecord
.headers()
.add(
"baggage",
"test-baggage-key-2=test-baggage-value-2".getBytes(StandardCharsets.UTF_8));
}
producer.send(
new ProducerRecord<>(SHARED_TOPIC, 10, greeting),
producerRecord,
(meta, ex) -> {
if (ex == null) {
testing.runWithSpan("producer callback", () -> {});
Expand Down Expand Up @@ -70,7 +89,8 @@ void testKafkaProduceAndConsume() throws InterruptedException {
span.hasName(SHARED_TOPIC + " process")
.hasKind(SpanKind.CONSUMER)
.hasParent(trace.getSpan(1))
.hasAttributesSatisfyingExactly(processAttributes("10", greeting, false)),
.hasAttributesSatisfyingExactly(
processAttributes("10", greeting, false, testBaggageKind)),
span ->
span.hasName("processing")
.hasKind(SpanKind.INTERNAL)
Expand Down
22 changes: 22 additions & 0 deletions ...ng/src/main/java/io/opentelemetry/instrumentation/kafka/internal/KafkaClientBaseTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,4 +251,26 @@ protected static List<AttributeAssertion> processAttributes(
}
return assertions;
}

protected static List<AttributeAssertion> processAttributes(
String messageKey, String messageValue, boolean testHeaders, String testBaggageKind) {
List<AttributeAssertion> attributeAssertions =
processAttributes(messageKey, messageValue, testHeaders);
attributeAssertions.addAll(processAttributes(testBaggageKind));
return attributeAssertions;
}

protected static List<AttributeAssertion> processAttributes(String testBaggageKind) {
switch (testBaggageKind) {
case "testSingleBaggage":
return Collections.singletonList(
equalTo(AttributeKey.stringKey("test-baggage-key-1"), "test-baggage-value-1"));
case "testMultiBaggage":
return Arrays.asList(
equalTo(AttributeKey.stringKey("test-baggage-key-1"), "test-baggage-value-1"),
equalTo(AttributeKey.stringKey("test-baggage-key-2"), "test-baggage-value-2"));
default:
throw new IllegalArgumentException("Unknown testBaggageKind: " + testBaggageKind);
}
}
}
30 changes: 24 additions & 6 deletions ...est/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/AbstractInterceptorsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,17 @@
import io.opentelemetry.instrumentation.kafka.internal.KafkaClientBaseTest;
import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
import io.opentelemetry.instrumentation.testing.junit.LibraryInstrumentationExtension;
import java.nio.charset.StandardCharsets;
import java.time.Duration;
import java.util.Map;
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.producer.ProducerConfig;
import org.apache.kafka.clients.producer.ProducerRecord;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;

abstract class AbstractInterceptorsTest extends KafkaClientBaseTest {

Expand All @@ -43,13 +45,29 @@ public Map<String, Object> consumerProps() {
return props;
}

@Test
void testInterceptors() throws InterruptedException {
@ParameterizedTest
@ValueSource(strings = {"testSingleBaggage", "testMultiBaggage"})
void testInterceptors(String testBaggageKind) throws InterruptedException {
testing.runWithSpan(
"parent",
() -> {
ProducerRecord<Integer, String> producerRecord =
new ProducerRecord<>(SHARED_TOPIC, greeting);
producerRecord
.headers()
// adding baggage header in w3c baggage format
.add(
"baggage",
"test-baggage-key-1=test-baggage-value-1".getBytes(StandardCharsets.UTF_8));
if (testBaggageKind.equals("testMultiBaggage")) {
producerRecord
.headers()
.add(
"baggage",
"test-baggage-key-2=test-baggage-value-2".getBytes(StandardCharsets.UTF_8));
}
producer.send(
new ProducerRecord<>(SHARED_TOPIC, greeting),
producerRecord,
(meta, ex) -> {
if (ex == null) {
testing.runWithSpan("producer callback", () -> {});
Expand All @@ -69,8 +87,8 @@ void testInterceptors() throws InterruptedException {
testing.runWithSpan("process child", () -> {});
}

assertTraces();
assertTraces(testBaggageKind);
}

abstract void assertTraces();
abstract void assertTraces(String testBaggageKind);
}
52 changes: 31 additions & 21 deletions ...opentelemetry/instrumentation/kafkaclients/v2_6/InterceptorsSuppressReceiveSpansTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,21 @@
import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_MESSAGE_BODY_SIZE;
import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_OPERATION;
import static io.opentelemetry.semconv.incubating.MessagingIncubatingAttributes.MESSAGING_SYSTEM;
import static java.util.Arrays.asList;

import io.opentelemetry.api.trace.SpanKind;
import io.opentelemetry.sdk.testing.assertj.AttributeAssertion;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.List;
import org.assertj.core.api.AbstractLongAssert;
import org.assertj.core.api.AbstractStringAssert;

class InterceptorsSuppressReceiveSpansTest extends AbstractInterceptorsTest {

@SuppressWarnings("deprecation") // using deprecated semconv
@Override
void assertTraces() {
void assertTraces(String testBaggageKind) {
testing.waitAndAssertTraces(
trace ->
trace.hasSpansSatisfyingExactly(
Expand All @@ -40,26 +44,32 @@ void assertTraces() {
satisfies(
MESSAGING_CLIENT_ID,
stringAssert -> stringAssert.startsWith("producer"))),
span ->
span.hasName(SHARED_TOPIC + " process")
.hasKind(SpanKind.CONSUMER)
.hasParent(trace.getSpan(1))
.hasAttributesSatisfyingExactly(
equalTo(MESSAGING_SYSTEM, "kafka"),
equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC),
equalTo(MESSAGING_OPERATION, "process"),
equalTo(
MESSAGING_MESSAGE_BODY_SIZE,
greeting.getBytes(StandardCharsets.UTF_8).length),
satisfies(
MESSAGING_DESTINATION_PARTITION_ID,
AbstractStringAssert::isNotEmpty),
satisfies(
MESSAGING_KAFKA_MESSAGE_OFFSET, AbstractLongAssert::isNotNegative),
equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "test"),
satisfies(
MESSAGING_CLIENT_ID,
stringAssert -> stringAssert.startsWith("consumer"))),
span -> {
List<AttributeAssertion> assertions =
new ArrayList<>(
asList(
equalTo(MESSAGING_SYSTEM, "kafka"),
equalTo(MESSAGING_DESTINATION_NAME, SHARED_TOPIC),
equalTo(MESSAGING_OPERATION, "process"),
equalTo(
MESSAGING_MESSAGE_BODY_SIZE,
greeting.getBytes(StandardCharsets.UTF_8).length),
satisfies(
MESSAGING_DESTINATION_PARTITION_ID,
AbstractStringAssert::isNotEmpty),
satisfies(
MESSAGING_KAFKA_MESSAGE_OFFSET,
AbstractLongAssert::isNotNegative),
equalTo(MESSAGING_KAFKA_CONSUMER_GROUP, "test"),
satisfies(
MESSAGING_CLIENT_ID,
stringAssert -> stringAssert.startsWith("consumer"))));
assertions.addAll(processAttributes(testBaggageKind));
span.hasName(SHARED_TOPIC + " process")
.hasKind(SpanKind.CONSUMER)
.hasParent(trace.getSpan(1))
.hasAttributesSatisfyingExactly(assertions);
},
span ->
span.hasName("process child")
.hasKind(SpanKind.INTERNAL)
Expand Down
2 changes: 1 addition & 1 deletion ...ry/src/test/java/io/opentelemetry/instrumentation/kafkaclients/v2_6/InterceptorsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ class InterceptorsTest extends AbstractInterceptorsTest {

@SuppressWarnings("deprecation") // using deprecated semconv
@Override
void assertTraces() {
void assertTraces(String unused) {
AtomicReference<SpanContext> producerSpanContext = new AtomicReference<>();
testing.waitAndAssertSortedTraces(
orderByRootSpanName("parent", SHARED_TOPIC + " receive", "producer callback"),
Expand Down
12 changes: 10 additions & 2 deletions .../main/java/io/opentelemetry/instrumentation/kafka/internal/KafkaConsumerRecordGetter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,15 @@

package io.opentelemetry.instrumentation.kafka.internal;

import io.opentelemetry.context.propagation.TextMapGetter;
import io.opentelemetry.context.propagation.internal.ExtendedTextMapGetter;
import java.nio.charset.StandardCharsets;
import java.util.Iterator;
import java.util.stream.Collectors;
import java.util.stream.StreamSupport;
import javax.annotation.Nullable;
import org.apache.kafka.common.header.Header;

enum KafkaConsumerRecordGetter implements TextMapGetter<KafkaProcessRequest> {
enum KafkaConsumerRecordGetter implements ExtendedTextMapGetter<KafkaProcessRequest> {
INSTANCE;

@Override
Expand All @@ -35,4 +36,11 @@ public String get(@Nullable KafkaProcessRequest carrier, String key) {
}
return new String(value, StandardCharsets.UTF_8);
}

@Override
public Iterator<String> getAll(@Nullable KafkaProcessRequest carrier, String key) {
return StreamSupport.stream(carrier.getRecord().headers().headers(key).spliterator(), false)
.map(header -> new String(header.value(), StandardCharsets.UTF_8))
.iterator();
}
}
Loading