Skip to content

[aws-xray] Update SamplerRulesApplier to recognize new HTTP/URL semconv. #1959

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 14 commits into from
Jul 23, 2025
+219 −16
Merged

[aws-xray] Update SamplerRulesApplier to recognize new HTTP/URL semconv. #1959

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
761d996
Updated the sampling rules applier to use latest semcovs
AsakerMohd Jun 2, 2025
7bb457c
Merge branch 'main' of https://github.com/open-telemetry/opentelemetr…
AsakerMohd Jun 12, 2025
9f5c983
Merge branch 'open-telemetry:main' into main
AsakerMohd Jul 7, 2025
fd8fd81
applied comments
AsakerMohd Jul 7, 2025
846657b
./gradlew spotlessApply
otelbot[bot] Jul 7, 2025
cde8df7
fixed build issue
AsakerMohd Jul 7, 2025
1649fc0
Merge branch 'main' of https://github.com/AsakerMohd/opentelemetry-ja…
AsakerMohd Jul 7, 2025
a12a706
updated comment
AsakerMohd Jul 7, 2025
34defcc
Merge branch 'open-telemetry:main' into main
AsakerMohd Jul 15, 2025
9b5c5ab
moved if conditions out of the loop
AsakerMohd Jul 15, 2025
da01369
./gradlew spotlessApply
otelbot[bot] Jul 15, 2025
2c33019
updated tests according to comments
AsakerMohd Jul 21, 2025
3f0db10
Merge branch 'main' of https://github.com/AsakerMohd/opentelemetry-ja…
AsakerMohd Jul 21, 2025
cb9e713
./gradlew spotlessApply
otelbot[bot] Jul 21, 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
49 changes: 33 additions & 16 deletions aws-xray/src/main/java/io/opentelemetry/contrib/awsxray/SamplingRuleApplier.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@
import io.opentelemetry.sdk.trace.samplers.Sampler;
import io.opentelemetry.sdk.trace.samplers.SamplingDecision;
import io.opentelemetry.sdk.trace.samplers.SamplingResult;
import io.opentelemetry.semconv.HttpAttributes;
import io.opentelemetry.semconv.ServerAttributes;
import io.opentelemetry.semconv.UrlAttributes;
import java.time.Duration;
import java.util.Collections;
import java.util.Date;
Expand Down Expand Up @@ -57,6 +60,10 @@ final class SamplingRuleApplier {

private static final Map<String, String> XRAY_CLOUD_PLATFORM;

// _OTHER request method:
// https://github.com/open-telemetry/semantic-conventions/blob/main/docs/registry/attributes/http.md?plain=1#L96
private static final String _OTHER_REQUEST_METHOD = "_OTHER";

static {
Map<String, String> xrayCloudPlatform = new HashMap<>();
xrayCloudPlatform.put(AWS_EC2, "AWS::EC2::Instance");
Expand Down Expand Up @@ -175,25 +182,35 @@ private SamplingRuleApplier(
@SuppressWarnings("deprecation") // TODO
boolean matches(Attributes attributes, Resource resource) {
int matchedAttributes = 0;
String httpTarget = null;
String httpUrl = null;
String httpMethod = null;
String host = null;

for (Map.Entry<AttributeKey<?>, Object> entry : attributes.asMap().entrySet()) {
if (entry.getKey().equals(HTTP_TARGET)) {
httpTarget = (String) entry.getValue();
} else if (entry.getKey().equals(HTTP_URL)) {
httpUrl = (String) entry.getValue();
} else if (entry.getKey().equals(HTTP_METHOD)) {
httpMethod = (String) entry.getValue();
} else if (entry.getKey().equals(NET_HOST_NAME)) {
host = (String) entry.getValue();
} else if (entry.getKey().equals(HTTP_HOST)) {
// TODO (trask) remove support for deprecated http.host attribute
host = (String) entry.getValue();
String httpTarget = attributes.get(UrlAttributes.URL_PATH);
if (httpTarget == null) {
httpTarget = attributes.get(HTTP_TARGET);
}

String httpUrl = attributes.get(UrlAttributes.URL_FULL);
if (httpUrl == null) {
httpUrl = attributes.get(HTTP_URL);
}

String httpMethod = attributes.get(HttpAttributes.HTTP_REQUEST_METHOD);
if (httpMethod == null) {
httpMethod = attributes.get(HTTP_METHOD);
}

if (httpMethod != null && httpMethod.equals(_OTHER_REQUEST_METHOD)) {
httpMethod = attributes.get(HttpAttributes.HTTP_REQUEST_METHOD_ORIGINAL);
}

String host = attributes.get(ServerAttributes.SERVER_ADDRESS);
if (host == null) {
host = attributes.get(NET_HOST_NAME);
if (host == null) {
host = attributes.get(HTTP_HOST);
}
}

for (Map.Entry<AttributeKey<?>, Object> entry : attributes.asMap().entrySet()) {
Matcher matcher = attributeMatchers.get(entry.getKey().getKey());
if (matcher == null) {
continue;
Expand Down
186 changes: 186 additions & 0 deletions aws-xray/src/test/java/io/opentelemetry/contrib/awsxray/SamplingRuleApplierTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@
import io.opentelemetry.sdk.testing.time.TestClock;
import io.opentelemetry.sdk.trace.samplers.SamplingDecision;
import io.opentelemetry.sdk.trace.samplers.SamplingResult;
import io.opentelemetry.semconv.HttpAttributes;
import io.opentelemetry.semconv.ServerAttributes;
import io.opentelemetry.semconv.UrlAttributes;
import io.opentelemetry.semconv.incubating.CloudIncubatingAttributes;
import java.io.IOException;
import java.io.UncheckedIOException;
Expand Down Expand Up @@ -72,6 +75,15 @@ class ExactMatch {
.put(AttributeKey.longKey("speed"), 10)
.build();

private final Attributes stableSemConvAttributes =
Attributes.builder()
.put(HttpAttributes.HTTP_REQUEST_METHOD, "GET")
.put(ServerAttributes.SERVER_ADDRESS, "opentelemetry.io")
.put(UrlAttributes.URL_PATH, "/instrument-me")
.put(AttributeKey.stringKey("animal"), "cat")
.put(AttributeKey.longKey("speed"), 10)
.build();

// FixedRate set to 1.0 in rule and no reservoir
@Test
void fixedRateAlwaysSample() {
Expand Down Expand Up @@ -120,6 +132,21 @@ void matches() {
.isTrue();
}

@Test
void matchesURLFullStableSemConv() {
assertThat(applier.matches(stableSemConvAttributes, resource)).isTrue();

// url.full works too
assertThat(
applier.matches(
attributes.toBuilder()
.remove(HTTP_TARGET)
.put(UrlAttributes.URL_FULL, "scheme://host:port/instrument-me")
.build(),
resource))
.isTrue();
}

@Test
void serviceNameNotMatch() {
assertThat(
Expand All @@ -140,6 +167,15 @@ void methodNotMatch() {
assertThat(applier.matches(attributes, resource)).isFalse();
}

@Test
void methodStableSemConvNotMatch() {
Attributes attributes =
this.stableSemConvAttributes.toBuilder()
.put(HttpAttributes.HTTP_REQUEST_METHOD, "POST")
.build();
assertThat(applier.matches(attributes, resource)).isFalse();
}

@Test
void hostNotMatch() {
// Replacing dot with character makes sure we're not accidentally treating dot as regex
Expand Down Expand Up @@ -177,6 +213,36 @@ void pathNotMatch() {
assertThat(applier.matches(attributes, resource)).isFalse();
}

@Test
void pathStableSemConvNotMatch() {
Attributes attributes =
this.stableSemConvAttributes.toBuilder()
.put(UrlAttributes.URL_PATH, "/instrument-you")
.build();
assertThat(applier.matches(attributes, resource)).isFalse();
attributes =
this.stableSemConvAttributes.toBuilder()
.remove(UrlAttributes.URL_PATH)
.put(UrlAttributes.URL_FULL, "scheme://host:port/instrument-you")
.build();
assertThat(applier.matches(attributes, resource)).isFalse();
attributes =
this.stableSemConvAttributes.toBuilder()
.remove(UrlAttributes.URL_PATH)
.put(UrlAttributes.URL_FULL, "scheme://host:port")
.build();
assertThat(applier.matches(attributes, resource)).isFalse();

// Correct path, but we ignore anyways since the URL is malformed per spec, scheme is always
// present.
attributes =
this.stableSemConvAttributes.toBuilder()
.remove(UrlAttributes.URL_PATH)
.put(UrlAttributes.URL_FULL, "host:port/instrument-me")
.build();
assertThat(applier.matches(attributes, resource)).isFalse();
}

@Test
void attributeNotMatch() {
Attributes attributes =
Expand Down Expand Up @@ -235,6 +301,15 @@ class WildcardMatch {
.put(AttributeKey.longKey("speed"), 10)
.build();

private final Attributes stableSemConvAttributes =
Attributes.builder()
.put(HttpAttributes.HTTP_REQUEST_METHOD, "GET")
.put(ServerAttributes.SERVER_ADDRESS, "opentelemetry.io")
.put(UrlAttributes.URL_PATH, "/instrument-me?foo=bar&cat=meow")
.put(AttributeKey.stringKey("animal"), "cat")
.put(AttributeKey.longKey("speed"), 10)
.build();

// FixedRate set to 0.0 in rule and no reservoir
@Test
void fixedRateNeverSample() {
Expand Down Expand Up @@ -317,6 +392,36 @@ void methodNotMatch() {
assertThat(applier.matches(attributes, resource)).isFalse();
}

@Test
void stableSemConvMethodMatches() {
Attributes attributes =
this.stableSemConvAttributes.toBuilder()
.put(HttpAttributes.HTTP_REQUEST_METHOD, "BADGETGOOD")
.build();
assertThat(applier.matches(attributes, resource)).isTrue();
attributes =
stableSemConvAttributes.toBuilder()
.put(HttpAttributes.HTTP_REQUEST_METHOD, "BADGET")
.build();
assertThat(applier.matches(attributes, resource)).isTrue();
attributes =
stableSemConvAttributes.toBuilder()
.put(HttpAttributes.HTTP_REQUEST_METHOD, "GETGET")
.build();
assertThat(applier.matches(attributes, resource)).isTrue();
}

@Test
void stableSemConvMethodNotMatch() {
Attributes attributes =
stableSemConvAttributes.toBuilder()
.put(HttpAttributes.HTTP_REQUEST_METHOD, "POST")
.build();
assertThat(applier.matches(attributes, resource)).isFalse();
attributes = removeAttribute(stableSemConvAttributes, HttpAttributes.HTTP_REQUEST_METHOD);
assertThat(applier.matches(attributes, resource)).isFalse();
}

@Test
void hostMatches() {
Attributes attributes =
Expand Down Expand Up @@ -345,6 +450,56 @@ void hostNotMatch() {
assertThat(applier.matches(attributes, resource)).isFalse();
}

@Test
void stableSemConvHostMatches() {
Attributes attributes =
this.stableSemConvAttributes.toBuilder()
.put(ServerAttributes.SERVER_ADDRESS, "alpha.opentelemetry.io")
.build();
assertThat(applier.matches(attributes, resource)).isTrue();
attributes =
this.stableSemConvAttributes.toBuilder()
.put(ServerAttributes.SERVER_ADDRESS, "opfdnqtelemetry.io")
.build();
assertThat(applier.matches(attributes, resource)).isTrue();
attributes =
this.stableSemConvAttributes.toBuilder()
.put(ServerAttributes.SERVER_ADDRESS, "opentglemetry.io")
.build();
assertThat(applier.matches(attributes, resource)).isTrue();
attributes =
this.stableSemConvAttributes.toBuilder()
.put(ServerAttributes.SERVER_ADDRESS, "opentglemry.io")
.build();
assertThat(applier.matches(attributes, resource)).isTrue();
attributes =
this.stableSemConvAttributes.toBuilder()
.put(ServerAttributes.SERVER_ADDRESS, "opentglemrz.io")
.build();
assertThat(applier.matches(attributes, resource)).isTrue();
}

@Test
void stableSemConvHostNotMatch() {
Attributes attributes =
this.stableSemConvAttributes.toBuilder()
.put(ServerAttributes.SERVER_ADDRESS, "opentelemetryfio")
.build();
assertThat(applier.matches(attributes, resource)).isFalse();
attributes =
this.stableSemConvAttributes.toBuilder()
.put(ServerAttributes.SERVER_ADDRESS, "opentgalemetry.io")
.build();
assertThat(applier.matches(attributes, resource)).isFalse();
attributes =
this.stableSemConvAttributes.toBuilder()
.put(ServerAttributes.SERVER_ADDRESS, "alpha.oentelemetry.io")
.build();
assertThat(applier.matches(attributes, resource)).isFalse();
attributes = removeAttribute(this.stableSemConvAttributes, ServerAttributes.SERVER_ADDRESS);
assertThat(applier.matches(attributes, resource)).isFalse();
}

@Test
void pathMatches() {
Attributes attributes =
Expand All @@ -368,6 +523,37 @@ void pathNotMatch() {
assertThat(applier.matches(attributes, resource)).isFalse();
}

@Test
void pathStableSemConvMatches() {
Attributes attributes =
stableSemConvAttributes.toBuilder()
.put(UrlAttributes.URL_PATH, "/instrument-me?foo=bar&cat=")
.build();
assertThat(applier.matches(attributes, resource)).isTrue();
// Deceptive question mark, it's actually a wildcard :-)
attributes =
stableSemConvAttributes.toBuilder()
.put(UrlAttributes.URL_PATH, "/instrument-meafoo=bar&cat=")
.build();
assertThat(applier.matches(attributes, resource)).isTrue();
}

@Test
void pathStableSemConvNotMatch() {
Attributes attributes =
stableSemConvAttributes.toBuilder()
.put(UrlAttributes.URL_PATH, "/instrument-mea?foo=bar&cat=")
.build();
assertThat(applier.matches(attributes, resource)).isFalse();
attributes =
stableSemConvAttributes.toBuilder()
.put(UrlAttributes.URL_PATH, "foo/instrument-meafoo=bar&cat=")
.build();
assertThat(applier.matches(attributes, resource)).isFalse();
attributes = removeAttribute(stableSemConvAttributes, UrlAttributes.URL_PATH);
assertThat(applier.matches(attributes, resource)).isFalse();
}

@Test
void attributeMatches() {
Attributes attributes =
Expand Down
Loading