Skip to content

[semconv]: Add support for new formal DB semantic convention keys #1162

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 9 commits into from
Oct 23, 2025
Merged

[semconv]: Add support for new formal DB semantic convention keys #1162

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
99d6930
[semconv]: Add support for new formal DB semantic convention keys
lukeina2z Aug 22, 2025
f34f4af
Merge branch 'main' into adotjava-pr-01
thpierce Sep 4, 2025
185246d
Merge branch 'main' into adotjava-pr-01
lukeina2z Sep 22, 2025
1f9f544
Update awsagentprovider/src/main/java/software/amazon/opentelemetry/j…
lukeina2z Sep 23, 2025
5d81c71
rename from remoteSvcKey to remoteServiceKey
lukeina2z Sep 23, 2025
5bcbc9c
Merge branch 'main' into adotjava-pr-01
lukeina2z Oct 22, 2025
00c2abe
fix github check failures.
lukeina2z Oct 22, 2025
7880e4a
adding more tests for the newly added DB attributes.
lukeina2z Oct 23, 2025
df6d3b7
Merge branch 'main' into adotjava-pr-01
thpierce Oct 23, 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
43 changes: 25 additions & 18 deletions ...n/java/software/amazon/opentelemetry/javaagent/providers/AwsMetricAttributeGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@

package software.amazon.opentelemetry.javaagent.providers;

import static io.opentelemetry.semconv.DbAttributes.DB_NAMESPACE;
import static io.opentelemetry.semconv.DbAttributes.DB_OPERATION_NAME;
import static io.opentelemetry.semconv.DbAttributes.DB_QUERY_TEXT;
import static io.opentelemetry.semconv.DbAttributes.DB_SYSTEM_NAME;
import static io.opentelemetry.semconv.HttpAttributes.HTTP_REQUEST_METHOD;
import static io.opentelemetry.semconv.HttpAttributes.HTTP_RESPONSE_STATUS_CODE;
import static io.opentelemetry.semconv.NetworkAttributes.NETWORK_PEER_ADDRESS;
Expand All @@ -26,7 +30,6 @@
// https://github.com/open-telemetry/semantic-conventions-java/blob/release/v1.34.0/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/DbIncubatingAttributes.java#L322-L327
// They have been replaced with new keys:
// https://github.com/open-telemetry/semantic-conventions-java/blob/release/v1.34.0/semconv/src/main/java/io/opentelemetry/semconv/DbAttributes.java#L77
// TODO: Supporting new keys. Cannot do this now as new keys are not available in OTel Agent 2.11.
// TODO: Delete deprecated keys once they no longer exist in binding version of the upstream code.
import static io.opentelemetry.semconv.incubating.DbIncubatingAttributes.DB_CONNECTION_STRING;
import static io.opentelemetry.semconv.incubating.DbIncubatingAttributes.DB_NAME;
Expand Down Expand Up @@ -93,6 +96,7 @@
import static software.amazon.opentelemetry.javaagent.providers.AwsSpanProcessingUtil.UNKNOWN_OPERATION;
import static software.amazon.opentelemetry.javaagent.providers.AwsSpanProcessingUtil.UNKNOWN_REMOTE_OPERATION;
import static software.amazon.opentelemetry.javaagent.providers.AwsSpanProcessingUtil.UNKNOWN_REMOTE_SERVICE;
import static software.amazon.opentelemetry.javaagent.providers.AwsSpanProcessingUtil.getKeyValueWithFallback;
import static software.amazon.opentelemetry.javaagent.providers.AwsSpanProcessingUtil.isAwsSDKSpan;
import static software.amazon.opentelemetry.javaagent.providers.AwsSpanProcessingUtil.isDBSpan;
import static software.amazon.opentelemetry.javaagent.providers.AwsSpanProcessingUtil.isKeyPresent;
Expand Down Expand Up @@ -285,11 +289,12 @@ private static void setRemoteServiceAndOperation(SpanData span, AttributesBuilde
remoteOperation = getRemoteOperation(span, RPC_METHOD);

} else if (isDBSpan(span)) {
remoteService = getRemoteService(span, DB_SYSTEM);
if (isKeyPresent(span, DB_OPERATION)) {
remoteOperation = getRemoteOperation(span, DB_OPERATION);
remoteService = getRemoteServiceWithFallback(span, DB_SYSTEM_NAME, DB_SYSTEM);
if (isKeyPresentWithFallback(span, DB_OPERATION_NAME, DB_OPERATION)) {
remoteOperation = getRemoteOperationWithFallback(span, DB_OPERATION_NAME, DB_OPERATION);
} else {
remoteOperation = getDBStatementRemoteOperation(span, DB_STATEMENT);
String dbStatement = getKeyValueWithFallback(span, DB_QUERY_TEXT, DB_STATEMENT);
remoteOperation = getDBStatementRemoteOperation(span, dbStatement);
}
} else if (isKeyPresent(span, FAAS_INVOKED_NAME) || isKeyPresent(span, FAAS_TRIGGER)) {
remoteService = getRemoteService(span, FAAS_INVOKED_NAME);
Expand Down Expand Up @@ -349,10 +354,7 @@ private static void setRemoteEnvironment(SpanData span, AttributesBuilder builde
private static String generateRemoteOperation(SpanData span) {
String remoteOperation = UNKNOWN_REMOTE_OPERATION;
if (isKeyPresent(span, URL_FULL) || isKeyPresent(span, HTTP_URL)) {
String httpUrl =
isKeyPresent(span, URL_FULL)
? span.getAttributes().get(URL_FULL)
: span.getAttributes().get(HTTP_URL);
String httpUrl = getKeyValueWithFallback(span, URL_FULL, HTTP_URL);
try {
URL url;
if (httpUrl != null) {
Expand All @@ -363,11 +365,8 @@ private static String generateRemoteOperation(SpanData span) {
logger.log(Level.FINEST, "invalid http.url attribute: ", httpUrl);
}
}
if (isKeyPresent(span, HTTP_REQUEST_METHOD) || isKeyPresent(span, HTTP_METHOD)) {
String httpMethod =
isKeyPresent(span, HTTP_REQUEST_METHOD)
? span.getAttributes().get(HTTP_REQUEST_METHOD)
: span.getAttributes().get(HTTP_METHOD);
if (isKeyPresentWithFallback(span, HTTP_REQUEST_METHOD, HTTP_METHOD)) {
String httpMethod = getKeyValueWithFallback(span, HTTP_REQUEST_METHOD, HTTP_METHOD);
remoteOperation = httpMethod + " " + remoteOperation;
}
if (remoteOperation.equals(UNKNOWN_REMOTE_OPERATION)) {
Expand Down Expand Up @@ -791,7 +790,7 @@ private static Optional<String> getSnsResourceNameFromArn(Optional<String> strin
* provided.
*/
private static Optional<String> getDbConnection(SpanData span) {
String dbName = span.getAttributes().get(DB_NAME);
String dbName = getKeyValueWithFallback(span, DB_NAMESPACE, DB_NAME);
Optional<String> dbConnection = Optional.empty();

if (isKeyPresent(span, SERVER_ADDRESS)) {
Expand Down Expand Up @@ -949,6 +948,15 @@ private static String getRemoteService(SpanData span, AttributeKey<String> remot
return remoteService;
}

static String getRemoteServiceWithFallback(
SpanData span, AttributeKey<String> remoteSvcKey, AttributeKey<String> remoteSvcFallbackKey) {
String remoteService = span.getAttributes().get(remoteSvcKey);
if (remoteService == null) {
return getRemoteService(span, remoteSvcFallbackKey);
}
return remoteService;
}

private static String getRemoteOperation(SpanData span, AttributeKey<String> remoteOperationKey) {
String remoteOperation = span.getAttributes().get(remoteOperationKey);
if (remoteOperation == null) {
Expand All @@ -972,9 +980,8 @@ static String getRemoteOperationWithFallback(
* statement and compare to a regex list of known SQL keywords. The substring length is determined
* by the longest known SQL keywords.
*/
private static String getDBStatementRemoteOperation(
SpanData span, AttributeKey<String> remoteOperationKey) {
String remoteOperation = span.getAttributes().get(remoteOperationKey);
private static String getDBStatementRemoteOperation(SpanData span, String dbStatement) {
String remoteOperation = dbStatement;
if (remoteOperation == null) {
remoteOperation = UNKNOWN_REMOTE_OPERATION;
}
Expand Down
10 changes: 3 additions & 7 deletions .../main/java/software/amazon/opentelemetry/javaagent/providers/AwsSpanMetricsProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
import static io.opentelemetry.semconv.HttpAttributes.HTTP_RESPONSE_STATUS_CODE;
import static io.opentelemetry.semconv.incubating.HttpIncubatingAttributes.HTTP_STATUS_CODE;
import static software.amazon.opentelemetry.javaagent.providers.AwsAttributeKeys.AWS_REMOTE_SERVICE;
import static software.amazon.opentelemetry.javaagent.providers.AwsSpanProcessingUtil.isKeyPresent;
import static software.amazon.opentelemetry.javaagent.providers.AwsSpanProcessingUtil.getKeyValueWithFallback;

import io.opentelemetry.api.common.Attributes;
import io.opentelemetry.api.metrics.DoubleHistogram;
Expand Down Expand Up @@ -152,12 +152,8 @@ public boolean isEndRequired() {
// possible except for the throttle
// https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/exporter/awsxrayexporter/internal/translator/cause.go#L121-L160
private void recordErrorOrFault(SpanData spanData, Attributes attributes) {
Long httpStatusCode = null;
if (isKeyPresent(spanData, HTTP_RESPONSE_STATUS_CODE)) {
httpStatusCode = spanData.getAttributes().get(HTTP_RESPONSE_STATUS_CODE);
} else if (isKeyPresent(spanData, HTTP_STATUS_CODE)) {
httpStatusCode = spanData.getAttributes().get(HTTP_STATUS_CODE);
}
Long httpStatusCode =
getKeyValueWithFallback(spanData, HTTP_RESPONSE_STATUS_CODE, HTTP_STATUS_CODE);
StatusCode statusCode = spanData.getStatus().getStatusCode();

if (httpStatusCode == null) {
Expand Down
9 changes: 6 additions & 3 deletions ...rc/main/java/software/amazon/opentelemetry/javaagent/providers/AwsSpanProcessingUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@

package software.amazon.opentelemetry.javaagent.providers;

import static io.opentelemetry.semconv.DbAttributes.DB_OPERATION_NAME;
import static io.opentelemetry.semconv.DbAttributes.DB_QUERY_TEXT;
import static io.opentelemetry.semconv.DbAttributes.DB_SYSTEM_NAME;
import static io.opentelemetry.semconv.UrlAttributes.URL_PATH;
import static io.opentelemetry.semconv.incubating.DbIncubatingAttributes.DB_OPERATION;
import static io.opentelemetry.semconv.incubating.DbIncubatingAttributes.DB_STATEMENT;
Expand Down Expand Up @@ -295,9 +298,9 @@ private static String generateIngressOperation(SpanData span) {

// Check if the current Span adheres to database semantic conventions
static boolean isDBSpan(SpanData span) {
return isKeyPresent(span, DB_SYSTEM)
|| isKeyPresent(span, DB_OPERATION)
|| isKeyPresent(span, DB_STATEMENT);
return isKeyPresentWithFallback(span, DB_SYSTEM_NAME, DB_SYSTEM)
|| isKeyPresentWithFallback(span, DB_OPERATION_NAME, DB_OPERATION)
|| isKeyPresentWithFallback(span, DB_QUERY_TEXT, DB_STATEMENT);
}

static boolean isLambdaServerSpan(ReadableSpan span) {
Expand Down
31 changes: 31 additions & 0 deletions ...va/software/amazon/opentelemetry/javaagent/providers/AwsMetricAttributeGeneratorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@

package software.amazon.opentelemetry.javaagent.providers;

import static io.opentelemetry.semconv.DbAttributes.DB_SYSTEM_NAME;
import static io.opentelemetry.semconv.HttpAttributes.HTTP_REQUEST_METHOD;
import static io.opentelemetry.semconv.HttpAttributes.HTTP_RESPONSE_STATUS_CODE;
import static io.opentelemetry.semconv.NetworkAttributes.NETWORK_PEER_ADDRESS;
Expand Down Expand Up @@ -1792,4 +1793,34 @@ public void testBothMetricsWhenLocalRootConsumerProcess() {
assertThat(attributeMap.get(SERVICE_METRIC)).isEqualTo(serviceAttributes);
assertThat(attributeMap.get(DEPENDENCY_METRIC)).isEqualTo(dependencyAttributes);
}

@Test
public void testGetRemoteServiceWithFallback_PrimaryKeyPresent() {
mockAttribute(DB_SYSTEM_NAME, "mysql");
mockAttribute(DB_SYSTEM, "postgresql");
String result =
AwsMetricAttributeGenerator.getRemoteServiceWithFallback(
spanDataMock, DB_SYSTEM_NAME, DB_SYSTEM);

assertThat(result).isEqualTo("mysql");
}

@Test
public void testGetRemoteServiceWithFallback_FallbackKeyPresent() {
mockAttribute(DB_SYSTEM, "postgresql");
String result =
AwsMetricAttributeGenerator.getRemoteServiceWithFallback(
spanDataMock, DB_SYSTEM_NAME, DB_SYSTEM);

assertThat(result).isEqualTo("postgresql");
}

@Test
public void testGetRemoteServiceWithFallback_BothKeysAbsent() {
String result =
AwsMetricAttributeGenerator.getRemoteServiceWithFallback(
spanDataMock, DB_SYSTEM_NAME, DB_SYSTEM);

assertThat(result).isEqualTo(UNKNOWN_REMOTE_SERVICE);
}
}
Loading