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

Switches ID encoding to fixed-length (#450)

Browse Source 
Before, we were using variable encoding for trace and span identifiers.
This complicates search for those who are copy/pasting fixed-length IDs
provisioned upstream. This moves to standard formatting, while
maintaining tolerant reads.

The code added will also be used to support 128-bit (32 char) trace IDs.

Fixes #449
This commit is contained in:
Adrian Cole
2016-11-16 14:55:28 +08:00
committed by GitHub
parent eab6d39cb6
commit c943e4cd50
5 changed files with 35 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
spring-cloud-sleuth-core/src/main/java/org/springframework/cloud/sleuth/Span.java
View File

@@ -453,12 +453,34 @@ public class Span implements SpanContext {
}
/**
* Represents given long id as hex string
* Represents given long id as 16-character lower-hex string
*/
public static String idToHex(long id) {
return Long.toHexString(id);
char[] data = new char[16];
writeHexLong(data, 0, id);
return new String(data);
}
/** Inspired by {@code okio.Buffer.writeLong} */
static void writeHexLong(char[] data, int pos, long v) {
writeHexByte(data, pos + 0, (byte) ((v >>> 56L) & 0xff));
writeHexByte(data, pos + 2, (byte) ((v >>> 48L) & 0xff));
writeHexByte(data, pos + 4, (byte) ((v >>> 40L) & 0xff));
writeHexByte(data, pos + 6, (byte) ((v >>> 32L) & 0xff));
writeHexByte(data, pos + 8, (byte) ((v >>> 24L) & 0xff));
writeHexByte(data, pos + 10, (byte) ((v >>> 16L) & 0xff));
writeHexByte(data, pos + 12, (byte) ((v >>> 8L) & 0xff));
writeHexByte(data, pos + 14, (byte) (v & 0xff));
}
static void writeHexByte(char[] data, int pos, byte b) {
data[pos + 0] = HEX_DIGITS[(b >> 4) & 0xf];
data[pos + 1] = HEX_DIGITS[b & 0xf];
}
static final char[] HEX_DIGITS =
{'0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f'};
/**
* Parses a 1 to 32 character lower-hex string with no prefix into an unsigned long, tossing any
* bits higher than 64.

4
spring-cloud-sleuth-core/src/test/java/org/springframework/cloud/sleuth/SpanTests.java
View File

@@ -36,12 +36,12 @@ import static org.assertj.core.api.BDDAssertions.then;
public class SpanTests {
@Test
public void should_convert_long_to_hex_string() throws Exception {
public void should_convert_long_to_16_character_hex_string() throws Exception {
long someLong = 123123L;
String hexString = Span.idToHex(someLong);
then(hexString).isEqualTo("1e0f3");
then(hexString).isEqualTo("000000000001e0f3");
}
@Test

6
spring-cloud-sleuth-core/src/test/java/org/springframework/cloud/sleuth/instrument/zuul/ApacheHttpClientRibbonRequestCustomizerTests.java
View File

@@ -65,9 +65,9 @@ public class ApacheHttpClientRibbonRequestCustomizerTests {
this.customizer.inject(this.span, this.customizer.toSpanTextMap(requestBuilder));
HttpUriRequest request = requestBuilder.build();
thenThereIsAHeaderWithNameAndValue(request, Span.SPAN_ID_NAME, "1");
thenThereIsAHeaderWithNameAndValue(request, Span.TRACE_ID_NAME, "2");
thenThereIsAHeaderWithNameAndValue(request, Span.PARENT_ID_NAME, "3");
thenThereIsAHeaderWithNameAndValue(request, Span.SPAN_ID_NAME, "0000000000000001");
thenThereIsAHeaderWithNameAndValue(request, Span.TRACE_ID_NAME, "0000000000000002");
thenThereIsAHeaderWithNameAndValue(request, Span.PARENT_ID_NAME, "0000000000000003");
thenThereIsAHeaderWithNameAndValue(request, Span.PROCESS_ID_NAME, "processId");
}

6
spring-cloud-sleuth-core/src/test/java/org/springframework/cloud/sleuth/instrument/zuul/OkHttpClientRibbonRequestCustomizerTests.java
View File

@@ -62,9 +62,9 @@ public class OkHttpClientRibbonRequestCustomizerTests {
this.customizer.inject(this.span, this.customizer.toSpanTextMap(requestBuilder));
Request request = requestBuilder.build();
thenThereIsAHeaderWithNameAndValue(request, Span.SPAN_ID_NAME, "1");
thenThereIsAHeaderWithNameAndValue(request, Span.TRACE_ID_NAME, "2");
thenThereIsAHeaderWithNameAndValue(request, Span.PARENT_ID_NAME, "3");
thenThereIsAHeaderWithNameAndValue(request, Span.SPAN_ID_NAME, "0000000000000001");
thenThereIsAHeaderWithNameAndValue(request, Span.TRACE_ID_NAME, "0000000000000002");
thenThereIsAHeaderWithNameAndValue(request, Span.PARENT_ID_NAME, "0000000000000003");
thenThereIsAHeaderWithNameAndValue(request, Span.PROCESS_ID_NAME, "processId");
}

6
spring-cloud-sleuth-core/src/test/java/org/springframework/cloud/sleuth/instrument/zuul/RestClientRibbonRequestCustomizerTests.java
View File

@@ -62,9 +62,9 @@ public class RestClientRibbonRequestCustomizerTests {
this.customizer.inject(this.span, this.customizer.toSpanTextMap(requestBuilder));
HttpRequest request = requestBuilder.build();
thenThereIsAHeaderWithNameAndValue(request, Span.SPAN_ID_NAME, "1");
thenThereIsAHeaderWithNameAndValue(request, Span.TRACE_ID_NAME, "2");
thenThereIsAHeaderWithNameAndValue(request, Span.PARENT_ID_NAME, "3");
thenThereIsAHeaderWithNameAndValue(request, Span.SPAN_ID_NAME, "0000000000000001");
thenThereIsAHeaderWithNameAndValue(request, Span.TRACE_ID_NAME, "0000000000000002");
thenThereIsAHeaderWithNameAndValue(request, Span.PARENT_ID_NAME, "0000000000000003");
thenThereIsAHeaderWithNameAndValue(request, Span.PROCESS_ID_NAME, "processId");
}