Skip to content

GH-3786: Remove ProducerRecord duplicated traceparent header #3789

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

Merged
merged 3 commits into from
Mar 13, 2025
Merged

GH-3786: Remove ProducerRecord duplicated traceparent header #3789

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b154b89
GH-3786: Remove ProducerRecord duplicated traceparent header
sobychacko Mar 13, 2025
1a6b2ec
PR review
sobychacko Mar 13, 2025
102c555
PR review
sobychacko Mar 13, 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
15 changes: 12 additions & 3 deletions .../src/main/java/org/springframework/kafka/support/micrometer/KafkaRecordSenderContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2022-2024 the original author or authors.
* Copyright 2022-2025 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -21,13 +21,15 @@

import io.micrometer.observation.transport.SenderContext;
import org.apache.kafka.clients.producer.ProducerRecord;
import org.apache.kafka.common.header.Headers;

/**
* {@link SenderContext} for {@link ProducerRecord}s.
*
* @author Gary Russell
* @author Christian Mergenthaler
* @author Wang Zhiyang
* @author Soby Chacko
*
* @since 3.0
*
Expand All @@ -39,8 +41,15 @@ public class KafkaRecordSenderContext extends SenderContext<ProducerRecord<?, ?>
private final ProducerRecord<?, ?> record;

public KafkaRecordSenderContext(ProducerRecord<?, ?> record, String beanName, Supplier<String> clusterId) {
super((carrier, key, value) -> record.headers().add(key,
value == null ? null : value.getBytes(StandardCharsets.UTF_8)));
super((carrier, key, value) -> {
Headers headers = record.headers();
// For traceparent context headers, ensure there's only one
if ("traceparent".equals(key)) {
Copy link
Member

@artembilan artembilan Mar 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not correct.
Different vendors provides different header name.
I have so far know here: https://github.com/spring-cloud/spring-cloud-stream-binder-aws-kinesis/blob/main/spring-cloud-stream-binder-kinesis/src/main/java/org/springframework/cloud/stream/binder/kinesis/KinesisMessageChannelBinder.java#L575-L577.

But that does not mean that anything else custom could be provided from the context supplier.

I think it is totally safe to replace whatever was asked from the supplier.
The point is to not mislead with extra entry from what might came from the previous observation.
We have to provide here what can be set from keys supplier.

headers.remove(key);
}
headers.add(key, value == null ? null : value.getBytes(StandardCharsets.UTF_8));
});

setCarrier(record);
this.beanName = beanName;
this.record = record;
Expand Down
75 changes: 73 additions & 2 deletions ...ng-kafka/src/test/java/org/springframework/kafka/support/micrometer/ObservationTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

package org.springframework.kafka.support.micrometer;

import java.nio.charset.StandardCharsets;
import java.util.Arrays;
import java.util.Deque;
import java.util.List;
Expand All @@ -26,6 +27,8 @@
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import java.util.concurrent.atomic.AtomicReference;
import java.util.stream.Collectors;
import java.util.stream.StreamSupport;

import io.micrometer.common.KeyValues;
import io.micrometer.core.instrument.MeterRegistry;
Expand Down Expand Up @@ -56,6 +59,7 @@
import org.apache.kafka.common.errors.InvalidTopicException;
import org.apache.kafka.common.header.Header;
import org.apache.kafka.common.header.Headers;
import org.apache.kafka.common.header.internals.RecordHeader;
import org.jspecify.annotations.Nullable;
import org.junit.jupiter.api.Test;
import reactor.core.publisher.Mono;
Expand All @@ -78,6 +82,7 @@
import org.springframework.kafka.core.ProducerFactory;
import org.springframework.kafka.listener.MessageListenerContainer;
import org.springframework.kafka.listener.RecordInterceptor;
import org.springframework.kafka.support.ProducerListener;
import org.springframework.kafka.support.micrometer.KafkaListenerObservation.DefaultKafkaListenerObservationConvention;
import org.springframework.kafka.support.micrometer.KafkaTemplateObservation.DefaultKafkaTemplateObservationConvention;
import org.springframework.kafka.test.EmbeddedKafkaBroker;
Expand All @@ -104,7 +109,7 @@
@SpringJUnitConfig
@EmbeddedKafka(topics = { ObservationTests.OBSERVATION_TEST_1, ObservationTests.OBSERVATION_TEST_2,
ObservationTests.OBSERVATION_TEST_3, ObservationTests.OBSERVATION_RUNTIME_EXCEPTION,
ObservationTests.OBSERVATION_ERROR }, partitions = 1)
ObservationTests.OBSERVATION_ERROR, ObservationTests.OBSERVATION_TRACEPARENT_DUPLICATE }, partitions = 1)
@DirtiesContext
public class ObservationTests {

Expand All @@ -122,6 +127,8 @@ public class ObservationTests {

public final static String OBSERVATION_ERROR_MONO = "observation.error.mono";

public final static String OBSERVATION_TRACEPARENT_DUPLICATE = "observation.traceparent.duplicate";

@Test
void endToEnd(@Autowired Listener listener, @Autowired KafkaTemplate<Integer, String> template,
@Autowired SimpleTracer tracer, @Autowired KafkaListenerEndpointRegistry rler,
Expand Down Expand Up @@ -449,6 +456,65 @@ void kafkaAdminNotRecreatedIfBootstrapServersSameInProducerAndAdminConfig(
assertThat(template.getKafkaAdmin()).isSameAs(kafkaAdmin);
}

// https://github.com/spring-cloud/spring-cloud-stream/issues/3095#issuecomment-2707075861
// https://github.com/spring-projects/spring-kafka/issues/3786
@Test
void verifyKafkaRecordSenderContextTraceParentHandling() {
String initialTraceParent = "traceparent-from-previous";
String updatedTraceParent = "traceparent-current";
ProducerRecord<Integer, String> record = new ProducerRecord<>("test-topic", "test-value");
record.headers().add("traceparent", initialTraceParent.getBytes(StandardCharsets.UTF_8));

// Create the context and update the traceparent
KafkaRecordSenderContext context = new KafkaRecordSenderContext(
record,
"test-bean",
() -> "test-cluster"
);
context.getSetter().set(record, "traceparent", updatedTraceParent);

Iterable<Header> traceparentHeaders = record.headers().headers("traceparent");
List<String> headerValues = StreamSupport.stream(traceparentHeaders.spliterator(), false)
.map(header -> new String(header.value(), StandardCharsets.UTF_8))
.collect(Collectors.toList());
Copy link
Member

@artembilan artembilan Mar 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No reason in this. Just toList() is enough.


// Verify there's only one traceparent header and it contains the updated value
assertThat(headerValues).containsExactly(updatedTraceParent);
}

// https://github.com/spring-cloud/spring-cloud-stream/issues/3095#issuecomment-2707075861
// https://github.com/spring-projects/spring-kafka/issues/3786
Copy link
Member

@artembilan artembilan Mar 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think there is a reason in this comments.
We always can find out that from the commit history.

@Test
void verifyTraceParentHeader(@Autowired KafkaTemplate<Integer, String> template,
@Autowired SimpleTracer tracer) throws Exception {
CompletableFuture<ProducerRecord<Integer, String>> producerRecordFuture = new CompletableFuture<>();
template.setProducerListener(new ProducerListener<>() {
@Override
public void onSuccess(ProducerRecord<Integer, String> producerRecord, RecordMetadata recordMetadata) {
producerRecordFuture.complete(producerRecord);
}
});
String initialTraceParent = "traceparent-from-previous";
Header header = new RecordHeader("traceparent", initialTraceParent.getBytes(StandardCharsets.UTF_8));
ProducerRecord<Integer, String> producerRecord = new ProducerRecord<>(
OBSERVATION_TRACEPARENT_DUPLICATE,
null, null, null,
"test-value",
List.of(header)
);

template.send(producerRecord).get(10, TimeUnit.SECONDS);
ProducerRecord<Integer, String> recordResult = producerRecordFuture.get(10, TimeUnit.SECONDS);

Iterable<Header> traceparentHeaders = recordResult.headers().headers("traceparent");
assertThat(traceparentHeaders).hasSize(1);

String traceparentValue = new String(traceparentHeaders.iterator().next().value(), StandardCharsets.UTF_8);
assertThat(traceparentValue).isEqualTo("traceparent-from-propagator");

tracer.getSpans().clear();
}

@Configuration
@EnableKafka
public static class Config {
Expand Down Expand Up @@ -598,6 +664,9 @@ public List<String> fields() {
public <C> void inject(TraceContext context, @Nullable C carrier, Setter<C> setter) {
setter.set(carrier, "foo", "some foo value");
setter.set(carrier, "bar", "some bar value");

// Add a traceparent header to simulate W3C trace context
setter.set(carrier, "traceparent", "traceparent-from-propagator");
}

// This is called on the consumer side when the message is consumed
Expand All @@ -606,7 +675,9 @@ public <C> void inject(TraceContext context, @Nullable C carrier, Setter<C> sett
public <C> Span.Builder extract(C carrier, Getter<C> getter) {
String foo = getter.get(carrier, "foo");
String bar = getter.get(carrier, "bar");
return tracer.spanBuilder().tag("foo", foo).tag("bar", bar);
return tracer.spanBuilder()
.tag("foo", foo)
.tag("bar", bar);
}
};
}
Expand Down