Skip to content

Support stable database semconv #46957

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 1 commit into from
Oct 14, 2025
Merged

Support stable database semconv #46957

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
37 changes: 22 additions & 15 deletions ...ain/java/com/azure/monitor/opentelemetry/autoconfigure/implementation/SpanDataMapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
import com.azure.monitor.opentelemetry.autoconfigure.implementation.models.ContextTagKeys;
import com.azure.monitor.opentelemetry.autoconfigure.implementation.models.TelemetryItem;
import com.azure.monitor.opentelemetry.autoconfigure.implementation.semconv.ClientAttributes;
import com.azure.monitor.opentelemetry.autoconfigure.implementation.semconv.DbAttributes;
import com.azure.monitor.opentelemetry.autoconfigure.implementation.semconv.incubating.EnduserIncubatingAttributes;
import com.azure.monitor.opentelemetry.autoconfigure.implementation.semconv.ExceptionAttributes;
import com.azure.monitor.opentelemetry.autoconfigure.implementation.semconv.HttpAttributes;
Expand Down Expand Up @@ -61,12 +62,14 @@ public final class SpanDataMapper {
// visible for testing
public static final String MS_PROCESSED_BY_METRIC_EXTRACTORS = "_MS.ProcessedByMetricExtractors";

private static final Set<String> SQL_DB_SYSTEMS = new HashSet<>(asList(DbIncubatingAttributes.DbSystemValues.DB2,
DbIncubatingAttributes.DbSystemValues.DERBY, DbIncubatingAttributes.DbSystemValues.MARIADB,
DbIncubatingAttributes.DbSystemValues.MSSQL, DbIncubatingAttributes.DbSystemValues.MYSQL,
DbIncubatingAttributes.DbSystemValues.ORACLE, DbIncubatingAttributes.DbSystemValues.POSTGRESQL,
DbIncubatingAttributes.DbSystemValues.SQLITE, DbIncubatingAttributes.DbSystemValues.OTHER_SQL,
DbIncubatingAttributes.DbSystemValues.HSQLDB, DbIncubatingAttributes.DbSystemValues.H2));
// the deprecated incubating constants for mariadb, mysql, postgresql had the same values as the stable ones
private static final Set<String> SQL_DB_SYSTEMS
= new HashSet<>(asList(DbAttributes.DbSystemNameValues.MARIADB, DbAttributes.DbSystemNameValues.MYSQL,
DbAttributes.DbSystemNameValues.POSTGRESQL, DbAttributes.DbSystemNameValues.MICROSOFT_SQL_SERVER,
DbIncubatingAttributes.DbSystemValues.DB2, DbIncubatingAttributes.DbSystemValues.DERBY,
DbIncubatingAttributes.DbSystemValues.MSSQL, DbIncubatingAttributes.DbSystemValues.ORACLE,
DbIncubatingAttributes.DbSystemValues.SQLITE, DbIncubatingAttributes.DbSystemValues.OTHER_SQL,
DbIncubatingAttributes.DbSystemValues.HSQLDB, DbIncubatingAttributes.DbSystemValues.H2));

// this is needed until Azure SDK moves to latest OTel semantic conventions
private static final String COSMOS = "Cosmos";
Expand Down Expand Up @@ -227,7 +230,8 @@ private static void applySemanticConventions(RemoteDependencyTelemetryBuilder te
applyRpcClientSpan(telemetryBuilder, rpcSystem, attributes);
return;
}
String dbSystem = attributes.get(DbIncubatingAttributes.DB_SYSTEM);
String dbSystem
= getStableOrOldAttribute(attributes, DbAttributes.DB_SYSTEM_NAME, DbIncubatingAttributes.DB_SYSTEM);
if (dbSystem == null) {
// special case needed until Azure SDK moves to latest OTel semantic conventions
dbSystem = attributes.get(AiSemanticAttributes.AZURE_SDK_DB_TYPE);
Expand Down Expand Up @@ -402,15 +406,17 @@ private static String getTarget(String host, @Nullable Long port, int defaultPor

private static void applyDatabaseClientSpan(RemoteDependencyTelemetryBuilder telemetryBuilder, String dbSystem,
Attributes attributes) {
String dbStatement = attributes.get(DbIncubatingAttributes.DB_STATEMENT);
String dbStatement
= getStableOrOldAttribute(attributes, DbAttributes.DB_QUERY_TEXT, DbIncubatingAttributes.DB_STATEMENT);
if (dbStatement == null) {
dbStatement = attributes.get(DbIncubatingAttributes.DB_OPERATION);
dbStatement = getStableOrOldAttribute(attributes, DbAttributes.DB_OPERATION_NAME,
DbIncubatingAttributes.DB_OPERATION);
}
String type;
if (SQL_DB_SYSTEMS.contains(dbSystem)) {
if (dbSystem.equals(DbIncubatingAttributes.DbSystemValues.MYSQL)) {
if (dbSystem.equals(DbAttributes.DbSystemNameValues.MYSQL)) { // stable and incubating constants have the same value
type = "mysql"; // this has special icon in portal
} else if (dbSystem.equals(DbIncubatingAttributes.DbSystemValues.POSTGRESQL)) {
} else if (dbSystem.equals(DbAttributes.DbSystemNameValues.POSTGRESQL)) { // stable and incubating constants have the same value
type = "postgresql"; // this has special icon in portal
} else {
type = "SQL";
Expand All @@ -437,7 +443,7 @@ private static void applyDatabaseClientSpan(RemoteDependencyTelemetryBuilder tel
dbName = attributes.get(AiSemanticAttributes.AZURE_SDK_DB_INSTANCE);
} else {
target = getTargetOrDefault(attributes, getDefaultPortForDbSystem(dbSystem), dbSystem);
dbName = attributes.get(DbIncubatingAttributes.DB_NAME);
dbName = getStableOrOldAttribute(attributes, DbAttributes.DB_NAMESPACE, DbIncubatingAttributes.DB_NAME);
}
target = nullAwareConcat(target, dbName, " | ");
if (target == null) {
Expand Down Expand Up @@ -472,10 +478,11 @@ private static int getDefaultPortForDbSystem(String dbSystem) {
case DbIncubatingAttributes.DbSystemValues.REDIS:
return 6379;

case DbIncubatingAttributes.DbSystemValues.MARIADB:
case DbIncubatingAttributes.DbSystemValues.MYSQL:
case DbAttributes.DbSystemNameValues.MARIADB: // deprecated incubating constant had the same value
case DbAttributes.DbSystemNameValues.MYSQL: // deprecated incubating constant had the same value
return 3306;

case DbAttributes.DbSystemNameValues.MICROSOFT_SQL_SERVER:
case DbIncubatingAttributes.DbSystemValues.MSSQL:
return 1433;

Expand All @@ -491,7 +498,7 @@ private static int getDefaultPortForDbSystem(String dbSystem) {
case DbIncubatingAttributes.DbSystemValues.DERBY:
return 1527;

case DbIncubatingAttributes.DbSystemValues.POSTGRESQL:
case DbAttributes.DbSystemNameValues.POSTGRESQL: // deprecated incubating constant had the same value
return 5432;

default:
Expand Down
Loading