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

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

[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
8 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
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
26 changes: 21 additions & 5 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 @@ -181,15 +188,24 @@ boolean matches(Attributes attributes, Resource resource) {
String host = null;

for (Map.Entry<AttributeKey<?>, Object> entry : attributes.asMap().entrySet()) {
if (entry.getKey().equals(HTTP_TARGET)) {
if (entry.getKey().equals(HTTP_TARGET) || entry.getKey().equals(UrlAttributes.URL_PATH)) {
httpTarget = (String) entry.getValue();
} else if (entry.getKey().equals(HTTP_URL)) {
} else if (entry.getKey().equals(HTTP_URL) || entry.getKey().equals(UrlAttributes.URL_FULL)) {
Copy link
Contributor

Choose a reason for hiding this comment

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

server instrumentations don't fill url.full, would that be an issue?

Copy link
Author

@AsakerMohd AsakerMohd Jul 7, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

That should be fine. It's there incase URL_PATH isn't being populated and the idea here is to then extract the path from URL_FULL.

httpUrl = (String) entry.getValue();
} else if (entry.getKey().equals(HTTP_METHOD)) {
} else if (entry.getKey().equals(HTTP_METHOD)
|| entry.getKey().equals(HttpAttributes.HTTP_REQUEST_METHOD)) {
Copy link
Contributor

Choose a reason for hiding this comment

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

there is also http.request.method_original that could be used to get the request method when http.request.method is _OTHER

Copy link
Author

Choose a reason for hiding this comment

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

Let me take a look.

Copy link
Author

Choose a reason for hiding this comment

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

Added logic to check for _OTHER and to use http.request.method_original in that case.

httpMethod = (String) entry.getValue();
} else if (entry.getKey().equals(NET_HOST_NAME)) {
// according to semantic conventions, if the HTTP request method is not known to
// instrumentation, it must be set to _OTHER and the
// HTTP_REQUEST_METHOD_ORIGINAL should contain the original method
if (httpMethod.equals(_OTHER_REQUEST_METHOD)) {
httpMethod = attributes.get(HttpAttributes.HTTP_REQUEST_METHOD_ORIGINAL);
}
} else if (entry.getKey().equals(NET_HOST_NAME)
|| entry.getKey().equals(ServerAttributes.SERVER_ADDRESS)) {
host = (String) entry.getValue();
} else if (entry.getKey().equals(HTTP_HOST)) {
} else if (entry.getKey().equals(HTTP_HOST)
|| entry.getKey().equals(ServerAttributes.SERVER_ADDRESS)) {
// TODO (trask) remove support for deprecated http.host attribute
host = (String) entry.getValue();
}
Expand Down
129 changes: 129 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,8 @@
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.UrlAttributes;
import io.opentelemetry.semconv.incubating.CloudIncubatingAttributes;
import java.io.IOException;
import java.io.UncheckedIOException;
Expand Down Expand Up @@ -72,6 +74,15 @@ class ExactMatch {
.put(AttributeKey.longKey("speed"), 10)
.build();

private final Attributes newSemCovAttributes =
Attributes.builder()
.put(HttpAttributes.HTTP_REQUEST_METHOD, "GET")
.put(NET_HOST_NAME, "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 +131,21 @@ void matches() {
.isTrue();
}

@Test
void matchesURLFullNewSemCov() {
assertThat(applier.matches(newSemCovAttributes, resource)).isTrue();

// http.url 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 +166,15 @@ void methodNotMatch() {
assertThat(applier.matches(attributes, resource)).isFalse();
}

@Test
void methodNewSemCovNotMatch() {
Attributes attributes =
this.newSemCovAttributes.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 +212,36 @@ void pathNotMatch() {
assertThat(applier.matches(attributes, resource)).isFalse();
}

@Test
void pathNewSemCovNotMatch() {
Attributes attributes =
this.newSemCovAttributes.toBuilder()
.put(UrlAttributes.URL_PATH, "/instrument-you")
.build();
assertThat(applier.matches(attributes, resource)).isFalse();
attributes =
this.newSemCovAttributes.toBuilder()
.remove(UrlAttributes.URL_PATH)
.put(UrlAttributes.URL_FULL, "scheme://host:port/instrument-you")
.build();
assertThat(applier.matches(attributes, resource)).isFalse();
attributes =
this.newSemCovAttributes.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.newSemCovAttributes.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 +300,15 @@ class WildcardMatch {
.put(AttributeKey.longKey("speed"), 10)
.build();

private final Attributes newSemCovAttributes =
Attributes.builder()
.put(HttpAttributes.HTTP_REQUEST_METHOD, "GET")
.put(NET_HOST_NAME, "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 +391,30 @@ void methodNotMatch() {
assertThat(applier.matches(attributes, resource)).isFalse();
}

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

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

@Test
void hostMatches() {
Attributes attributes =
Expand Down Expand Up @@ -368,6 +466,37 @@ void pathNotMatch() {
assertThat(applier.matches(attributes, resource)).isFalse();
}

@Test
void pathNewSemCovMatches() {
Attributes attributes =
newSemCovAttributes.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 =
newSemCovAttributes.toBuilder()
.put(UrlAttributes.URL_PATH, "/instrument-meafoo=bar&cat=")
.build();
assertThat(applier.matches(attributes, resource)).isTrue();
}

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

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