SpringCloud/spring-cloud-sleuth
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fixed the Duplicate Trace Header Propagation for Zuul Proxy Applications

Browse Source 
without this change we're always setting values for headers regardless of the fact whether they have already been set.
with this change we're only setting headers if there was no any previous value of the header

fixes #586
This commit is contained in:
Marcin Grzejszczak
2017-05-27 02:58:58 +02:00
parent 802fbb63a6
commit 419ec7232a
4 changed files with 148 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/instrument/messaging/HeaderBasedMessagingInjector.java
View File

@@ -33,28 +33,28 @@ public class HeaderBasedMessagingInjector implements MessagingSpanTextMapInjecto
}
return;
}
addHeaders(span, carrier);
addHeaders(map, span, carrier);
}
private boolean isSampled(Map<String, String> initialMessage, String sampledHeaderName) {
return Span.SPAN_SAMPLED.equals(initialMessage.get(sampledHeaderName));
}
private void addHeaders(Span span, SpanTextMap textMap) {
addHeader(textMap, TraceMessageHeaders.TRACE_ID_NAME, span.traceIdString());
addHeader(textMap, TraceMessageHeaders.SPAN_ID_NAME, Span.idToHex(span.getSpanId()));
private void addHeaders(Map<String, String> map, Span span, SpanTextMap textMap) {
addHeader(map, textMap, TraceMessageHeaders.TRACE_ID_NAME, span.traceIdString());
addHeader(map, textMap, TraceMessageHeaders.SPAN_ID_NAME, Span.idToHex(span.getSpanId()));
if (span.isExportable()) {
addAnnotations(this.traceKeys, textMap, span);
Long parentId = getFirst(span.getParents());
if (parentId != null) {
addHeader(textMap, TraceMessageHeaders.PARENT_ID_NAME, Span.idToHex(parentId));
addHeader(map, textMap, TraceMessageHeaders.PARENT_ID_NAME, Span.idToHex(parentId));
}
addHeader(textMap, TraceMessageHeaders.SPAN_NAME_NAME, span.getName());
addHeader(textMap, TraceMessageHeaders.PROCESS_ID_NAME, span.getProcessId());
addHeader(textMap, TraceMessageHeaders.SAMPLED_NAME, Span.SPAN_SAMPLED);
addHeader(map, textMap, TraceMessageHeaders.SPAN_NAME_NAME, span.getName());
addHeader(map, textMap, TraceMessageHeaders.PROCESS_ID_NAME, span.getProcessId());
addHeader(map, textMap, TraceMessageHeaders.SAMPLED_NAME, Span.SPAN_SAMPLED);
}
else {
addHeader(textMap, TraceMessageHeaders.SAMPLED_NAME, Span.SPAN_NOT_SAMPLED);
addHeader(map, textMap, TraceMessageHeaders.SAMPLED_NAME, Span.SPAN_NOT_SAMPLED);
}
for (Map.Entry<String, String> entry : span.baggageItems()) {
textMap.put(prefixedKey(entry.getKey()), entry.getValue());
@@ -92,8 +92,8 @@ public class HeaderBasedMessagingInjector implements MessagingSpanTextMapInjecto
}
}
private void addHeader(SpanTextMap textMap, String name, String value) {
if (StringUtils.hasText(value)) {
private void addHeader(Map<String, String> map, SpanTextMap textMap, String name, String value) {
if (StringUtils.hasText(value) && !map.containsKey(name)) {
textMap.put(name, value);
}
}

28
spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/instrument/web/ZipkinHttpSpanInjector.java
View File

@@ -4,6 +4,7 @@ import java.util.Map;
import org.springframework.cloud.sleuth.Span;
import org.springframework.cloud.sleuth.SpanTextMap;
import org.springframework.cloud.sleuth.util.TextMapUtil;
import org.springframework.util.StringUtils;
/**
@@ -17,15 +18,16 @@ public class ZipkinHttpSpanInjector implements HttpSpanInjector {
private static final String HEADER_DELIMITER = "-";
@Override
public void inject(Span span, SpanTextMap carrier) {
setHeader(carrier, Span.TRACE_ID_NAME, span.traceIdString());
setIdHeader(carrier, Span.SPAN_ID_NAME, span.getSpanId());
setHeader(carrier, Span.SAMPLED_NAME, span.isExportable() ? Span.SPAN_SAMPLED : Span.SPAN_NOT_SAMPLED);
setHeader(carrier, Span.SPAN_NAME_NAME, span.getName());
setIdHeader(carrier, Span.PARENT_ID_NAME, getParentId(span));
setHeader(carrier, Span.PROCESS_ID_NAME, span.getProcessId());
public void inject(Span span, SpanTextMap map) {
Map<String, String> carrier = TextMapUtil.asMap(map);
setHeader(map, carrier, Span.TRACE_ID_NAME, span.traceIdString());
setIdHeader(map, carrier, Span.SPAN_ID_NAME, span.getSpanId());
setHeader(map, carrier, Span.SAMPLED_NAME, span.isExportable() ? Span.SPAN_SAMPLED : Span.SPAN_NOT_SAMPLED);
setHeader(map, carrier, Span.SPAN_NAME_NAME, span.getName());
setIdHeader(map, carrier, Span.PARENT_ID_NAME, getParentId(span));
setHeader(map, carrier, Span.PROCESS_ID_NAME, span.getProcessId());
for (Map.Entry<String, String> entry : span.baggageItems()) {
carrier.put(prefixedKey(entry.getKey()), entry.getValue());
map.put(prefixedKey(entry.getKey()), entry.getValue());
}
}
@@ -40,15 +42,15 @@ public class ZipkinHttpSpanInjector implements HttpSpanInjector {
return !span.getParents().isEmpty() ? span.getParents().get(0) : null;
}
private void setIdHeader(SpanTextMap carrier, String name, Long value) {
private void setIdHeader(SpanTextMap map, Map<String, String> carrier, String name, Long value) {
if (value != null) {
setHeader(carrier, name, Span.idToHex(value));
setHeader(map, carrier, name, Span.idToHex(value));
}
}
private void setHeader(SpanTextMap carrier, String name, String value) {
if (StringUtils.hasText(value)) {
carrier.put(name, value);
private void setHeader(SpanTextMap map, Map<String, String> carrier, String name, String value) {
if (StringUtils.hasText(value) && !carrier.containsKey(name)) {
map.put(name, value);
}
}

62
spring-cloud-sleuth-core/src/test/java/org/springframework/cloud/sleuth/instrument/messaging/HeaderBasedMessagingInjectorTests.java Normal file
View File

@@ -0,0 +1,62 @@
package org.springframework.cloud.sleuth.instrument.messaging;
import java.util.AbstractMap;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import org.junit.Test;
import org.springframework.cloud.sleuth.Span;
import org.springframework.cloud.sleuth.SpanTextMap;
import org.springframework.cloud.sleuth.TraceKeys;
import static org.springframework.cloud.sleuth.assertions.SleuthAssertions.then;
/**
* @author Marcin Grzejszczak
*/
public class HeaderBasedMessagingInjectorTests {
HeaderBasedMessagingInjector injector = new HeaderBasedMessagingInjector(new TraceKeys());
@SuppressWarnings("unchecked")
@Test
public void should_not_override_already_existing_headers() throws Exception {
Span span = Span.builder()
.spanId(1L)
.traceId(2L)
.parent(3L)
.baggage("foo", "bar")
.name("span")
.exportable(true)
.build();
Map<String, String> holder = new HashMap<>();
final SpanTextMap map = textMap(holder);
holder.put(TraceMessageHeaders.SPAN_ID_NAME, Span.idToHex(10L));
holder.put(TraceMessageHeaders.TRACE_ID_NAME, Span.idToHex(20L));
holder.put(TraceMessageHeaders.PARENT_ID_NAME, Span.idToHex(30L));
holder.put(TraceMessageHeaders.SPAN_NAME_NAME, "anotherSpan");
injector.inject(span, map);
then(map)
.contains(new AbstractMap.SimpleEntry<String, String>(TraceMessageHeaders.SPAN_ID_NAME, Span.idToHex(10L)))
.contains(new AbstractMap.SimpleEntry<String, String>(TraceMessageHeaders.TRACE_ID_NAME, Span.idToHex(20L)))
.contains(new AbstractMap.SimpleEntry<String, String>(TraceMessageHeaders.PARENT_ID_NAME, Span.idToHex(30L)))
.contains(new AbstractMap.SimpleEntry<String, String>(TraceMessageHeaders.SPAN_NAME_NAME, "anotherSpan"))
.contains(new AbstractMap.SimpleEntry<String, String>("baggage_foo", "bar"));
}
private SpanTextMap textMap(Map<String, String> textMap) {
return new SpanTextMap() {
@Override public Iterator<Map.Entry<String, String>> iterator() {
return textMap.entrySet().iterator();
}
@Override public void put(String key, String value) {
textMap.put(key, value);
}
};
}
}

60
spring-cloud-sleuth-core/src/test/java/org/springframework/cloud/sleuth/instrument/web/ZipkinHttpSpanInjectorTests.java Normal file
View File

@@ -0,0 +1,60 @@
package org.springframework.cloud.sleuth.instrument.web;
import java.util.AbstractMap;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import org.junit.Test;
import org.springframework.cloud.sleuth.Span;
import org.springframework.cloud.sleuth.SpanTextMap;
import static org.assertj.core.api.BDDAssertions.then;
/**
* @author Marcin Grzejszczak
*/
public class ZipkinHttpSpanInjectorTests {
ZipkinHttpSpanInjector injector = new ZipkinHttpSpanInjector();
@SuppressWarnings("unchecked")
@Test
public void should_not_override_already_existing_headers() throws Exception {
Span span = Span.builder()
.spanId(1L)
.traceId(2L)
.parent(3L)
.baggage("foo", "bar")
.name("span")
.build();
Map<String, String> holder = new HashMap<>();
final SpanTextMap map = textMap(holder);
holder.put(Span.SPAN_ID_NAME, Span.idToHex(10L));
holder.put(Span.TRACE_ID_NAME, Span.idToHex(20L));
holder.put(Span.PARENT_ID_NAME, Span.idToHex(30L));
holder.put(Span.SPAN_NAME_NAME, "anotherSpan");
injector.inject(span, map);
then(map)
.contains(new AbstractMap.SimpleEntry<String, String>(Span.SPAN_ID_NAME, Span.idToHex(10L)))
.contains(new AbstractMap.SimpleEntry<String, String>(Span.TRACE_ID_NAME, Span.idToHex(20L)))
.contains(new AbstractMap.SimpleEntry<String, String>(Span.PARENT_ID_NAME, Span.idToHex(30L)))
.contains(new AbstractMap.SimpleEntry<String, String>(Span.SPAN_NAME_NAME, "anotherSpan"))
.contains(new AbstractMap.SimpleEntry<String, String>("baggage-foo", "bar"));
}
private SpanTextMap textMap(Map<String, String> textMap) {
return new SpanTextMap() {
@Override public Iterator<Map.Entry<String, String>> iterator() {
return textMap.entrySet().iterator();
}
@Override public void put(String key, String value) {
textMap.put(key, value);
}
};
}
}