Skip to content

Support for Lineage in XRay Trace Header and removing additional Baggage from being added #1671

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 6 commits into from
Feb 18, 2025
Merged

Support for Lineage in XRay Trace Header and removing additional Baggage from being added #1671

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
42fa0f7
added support for Lineage in Xray Trace Header
liustve Jan 24, 2025
b49754b
cleaned up code and added additional test case
liustve Jan 28, 2025
16ad65b
removed v2 from lineage names
liustve Jan 28, 2025
6b4517f
changed variable names
liustve Feb 3, 2025
efbb27f
formatting fix
liustve Feb 3, 2025
3a6090f
more cleanup
liustve Feb 15, 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
121 changes: 82 additions & 39 deletions ...opagator/src/main/java/io/opentelemetry/contrib/awsxray/propagator/AwsXrayPropagator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,10 @@

package io.opentelemetry.contrib.awsxray.propagator;

import static io.opentelemetry.api.internal.OtelEncodingUtils.isValidBase16String;

import io.opentelemetry.api.baggage.Baggage;
import io.opentelemetry.api.baggage.BaggageBuilder;
import io.opentelemetry.api.baggage.BaggageEntry;
import io.opentelemetry.api.internal.StringUtils;
import io.opentelemetry.api.trace.Span;
import io.opentelemetry.api.trace.SpanContext;
Expand All @@ -21,7 +22,7 @@
import io.opentelemetry.context.propagation.TextMapSetter;
import java.util.Collections;
import java.util.List;
import java.util.function.BiConsumer;
import java.util.Set;
import java.util.logging.Logger;
import javax.annotation.Nullable;

Expand Down Expand Up @@ -68,6 +69,16 @@ public final class AwsXrayPropagator implements TextMapPropagator {
private static final char IS_SAMPLED = '1';
private static final char NOT_SAMPLED = '0';

private static final String LINEAGE_KEY = "Lineage";
private static final char LINEAGE_DELIMITER = ':';
private static final int LINEAGE_MAX_LENGTH = 18;
private static final int LINEAGE_MIN_LENGTH = 12;
private static final int LINEAGE_HASH_LENGTH = 8;
private static final int LINEAGE_MAX_COUNTER1 = 32767;
private static final int LINEAGE_MAX_COUNTER2 = 255;
private static final int LINEAGE_MIN_COUNTER = 0;
private static final String INVALID_LINEAGE = "-1:11111111:0";

private static final List<String> FIELDS = Collections.singletonList(TRACE_HEADER_KEY);

private static final AwsXrayPropagator INSTANCE = new AwsXrayPropagator();
Expand Down Expand Up @@ -127,34 +138,19 @@ public <C> void inject(Context context, @Nullable C carrier, TextMapSetter<C> se
.append(samplingFlag);

Baggage baggage = Baggage.fromContext(context);
// Truncate baggage to 256 chars per X-Ray spec.
baggage.forEach(
new BiConsumer<String, BaggageEntry>() {

private int baggageWrittenBytes;

@Override
public void accept(String key, BaggageEntry entry) {
if (key.equals(TRACE_ID_KEY)
|| key.equals(PARENT_ID_KEY)
|| key.equals(SAMPLED_FLAG_KEY)) {
return;
}
// Size is key/value pair, excludes delimiter.
int size = key.length() + entry.getValue().length() + 1;
if (baggageWrittenBytes + size > 256) {
return;
}
traceHeader
.append(TRACE_HEADER_DELIMITER)
.append(key)
.append(KV_DELIMITER)
.append(entry.getValue());
baggageWrittenBytes += size;
}
});

setter.set(carrier, TRACE_HEADER_KEY, traceHeader.toString());
String lineageHeader = baggage.getEntryValue(LINEAGE_KEY);

if (lineageHeader != null) {
traceHeader
.append(TRACE_HEADER_DELIMITER)
.append(LINEAGE_KEY)
.append(KV_DELIMITER)
.append(lineageHeader);
}

// add 256 character truncation
String truncatedTraceHeader = traceHeader.substring(0, Math.min(traceHeader.length(), 256));
setter.set(carrier, TRACE_HEADER_KEY, truncatedTraceHeader);
}

@Override
Expand Down Expand Up @@ -183,10 +179,20 @@ private static <C> Context getContextFromHeader(

String traceId = TraceId.getInvalid();
String spanId = SpanId.getInvalid();
String lineageHeader;
Boolean isSampled = false;

BaggageBuilder baggage = null;
int baggageReadBytes = 0;
Baggage contextBaggage = Baggage.fromContext(context);
BaggageBuilder baggageBuilder = Baggage.builder();
Set<String> baggageMap = contextBaggage.asMap().keySet();

// Copying baggage over to new Baggage object to add Lineage key
for (String baggageKey : baggageMap) {
String baggageValue = contextBaggage.getEntryValue(baggageKey);
if (baggageValue != null) {
baggageBuilder.put(baggageKey, baggageValue);
}
}

int pos = 0;
while (pos < traceHeader.length()) {
Expand Down Expand Up @@ -215,12 +221,11 @@ private static <C> Context getContextFromHeader(
spanId = parseSpanId(value);
} else if (trimmedPart.startsWith(SAMPLED_FLAG_KEY)) {
isSampled = parseTraceFlag(value);
} else if (baggageReadBytes + trimmedPart.length() <= 256) {
if (baggage == null) {
baggage = Baggage.builder();
} else if (trimmedPart.startsWith(LINEAGE_KEY)) {
lineageHeader = parseLineageHeader(value);
if (isValidLineage(lineageHeader)) {
Copy link
Contributor

Choose a reason for hiding this comment

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

It would be worth adding logger.fine printing the value in case parsed lineage is invalid and lineage is not added to the baggage

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry for the late reply but comments addressed and implemented.

baggageBuilder.put(LINEAGE_KEY, lineageHeader);
}
baggage.put(trimmedPart.substring(0, equalsIndex), value);
baggageReadBytes += trimmedPart.length();
}
}
if (isSampled == null) {
Expand All @@ -243,12 +248,17 @@ private static <C> Context getContextFromHeader(
spanId,
isSampled ? TraceFlags.getSampled() : TraceFlags.getDefault(),
TraceState.getDefault());

if (spanContext.isValid()) {
context = context.with(Span.wrap(spanContext));
}
if (baggage != null) {
context = context.with(baggage.build());

Baggage baggage = baggageBuilder.build();

if (!baggage.isEmpty()) {
context = context.with(baggage);
}

return context;
}

Expand Down Expand Up @@ -316,6 +326,31 @@ private static String parseSpanId(String xrayParentId) {
return xrayParentId;
}

private static String parseLineageHeader(String xrayLineageHeader) {
long numOfDelimiters = xrayLineageHeader.chars().filter(ch -> ch == LINEAGE_DELIMITER).count();

if (xrayLineageHeader.length() < LINEAGE_MIN_LENGTH
|| xrayLineageHeader.length() > LINEAGE_MAX_LENGTH
|| numOfDelimiters != 2) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Here a constant would be better as well

return INVALID_LINEAGE;
}

return xrayLineageHeader;
}

private static boolean isValidLineage(String key) {
String[] split = key.split(String.valueOf(LINEAGE_DELIMITER));
String hash = split[1];
int counter1 = parseIntOrReturnNegative(split[0]);
int counter2 = parseIntOrReturnNegative(split[2]);

boolean isHashValid = hash.length() == LINEAGE_HASH_LENGTH && isValidBase16String(hash);
boolean isValidCounter2 = counter2 <= LINEAGE_MAX_COUNTER2 && counter2 >= LINEAGE_MIN_COUNTER;
boolean isValidCounter1 = counter1 <= LINEAGE_MAX_COUNTER1 && counter1 >= LINEAGE_MIN_COUNTER;

return isHashValid && isValidCounter2 && isValidCounter1;
}

@Nullable
private static Boolean parseTraceFlag(String xraySampledFlag) {
if (xraySampledFlag.length() != SAMPLED_FLAG_LENGTH) {
Expand All @@ -332,4 +367,12 @@ private static Boolean parseTraceFlag(String xraySampledFlag) {
return null;
}
}

private static int parseIntOrReturnNegative(String num) {
try {
return Integer.parseInt(num);
} catch (NumberFormatException e) {
return -1;
}
}
}
78 changes: 78 additions & 0 deletions ...test/java/io/opentelemetry/contrib/awsxray/propagator/AwsXrayCompositePropagatorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/

package io.opentelemetry.contrib.awsxray.propagator;

import static org.assertj.core.api.Assertions.assertThat;

import io.opentelemetry.api.baggage.propagation.W3CBaggagePropagator;
import io.opentelemetry.api.trace.SpanContext;
import io.opentelemetry.api.trace.propagation.W3CTraceContextPropagator;
import io.opentelemetry.context.Context;
import io.opentelemetry.context.propagation.TextMapPropagator;
import java.util.LinkedHashMap;
import org.junit.jupiter.api.Test;

public class AwsXrayCompositePropagatorTest extends AwsXrayPropagatorTest {

@Override
TextMapPropagator propagator() {
return TextMapPropagator.composite(
W3CBaggagePropagator.getInstance(),
AwsXrayPropagator.getInstance(),
W3CTraceContextPropagator.getInstance());
}

@Test
void extract_traceContextOverridesXray() {
LinkedHashMap<String, String> carrier = new LinkedHashMap<>();
String w3cTraceContextTraceId = "4bf92f3577b34da6a3ce929d0e0e4736";
String w3cTraceContextSpanId = "00f067aa0ba902b7";
String traceParent =
String.format("00-%s-%s-01", w3cTraceContextTraceId, w3cTraceContextSpanId);
String traceState = "rojo=00f067aa0ba902b7";
String xrayTrace = String.format("Root=1-%s;Parent=%s;Sampled=0", TRACE_ID, SPAN_ID);

carrier.put("traceparent", traceParent);
carrier.put("tracestate", traceState);
carrier.put("X-Amzn-Trace-Id", xrayTrace);

SpanContext actualContext = getSpanContext(subject.extract(Context.current(), carrier, GETTER));

assertThat(actualContext.getTraceId()).isEqualTo(w3cTraceContextTraceId);
assertThat(actualContext.getSpanId()).isEqualTo(w3cTraceContextSpanId);
assertThat(actualContext.isSampled()).isEqualTo(true);
}

@Test
void extract_xrayOverridesTraceContext() {
TextMapPropagator propagator =
TextMapPropagator.composite(
W3CBaggagePropagator.getInstance(),
W3CTraceContextPropagator.getInstance(),
AwsXrayPropagator.getInstance());

LinkedHashMap<String, String> carrier = new LinkedHashMap<>();
String w3cTraceContextTraceId = "4bf92f3577b34da6a3ce929d0e0e4736";
String w3cTraceContextSpanId = "00f067aa0ba902b7";
String traceParent =
String.format("00-%s-%s-01", w3cTraceContextTraceId, w3cTraceContextSpanId);
String traceState = "rojo=00f067aa0ba902b7";
String xrayTrace =
String.format(
"Root=1-%s;Parent=%s;Sampled=0", "8a3c60f7-d188f8fa79d48a391a778fa6", SPAN_ID);

carrier.put("traceparent", traceParent);
carrier.put("tracestate", traceState);
carrier.put("X-Amzn-Trace-Id", xrayTrace);

SpanContext actualContext =
getSpanContext(propagator.extract(Context.current(), carrier, GETTER));

assertThat(actualContext.getTraceId()).isEqualTo(TRACE_ID);
assertThat(actualContext.getSpanId()).isEqualTo(SPAN_ID);
assertThat(actualContext.isSampled()).isEqualTo(false);
}
}
Loading