Skip to content

Commit d222397

Browse files
committed
Deprecate getDbSystem/getResponseStatus, add getDbSystemName/getResponseStatusCode
- Deprecated DbClientCommonAttributesGetter.getDbSystem() in favor of getDbSystemName() - Deprecated DbClientCommonAttributesGetter.getResponseStatus() in favor of getResponseStatusCode() - Updated DbClientAttributesExtractor to call the new methods - Updated test implementations to use new method names - Old methods now delegate to new methods by default for backward compatibility
1 parent bb926c0 commit d222397

File tree

6 files changed

+26
-8
lines changed

6 files changed

+26
-8
lines changed

instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/db/DbClientAttributesExtractor.java

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,14 +77,14 @@ static <REQUEST, RESPONSE> void onStartCommon(
7777
internalSet(
7878
attributes,
7979
DB_SYSTEM_NAME,
80-
SemconvStability.stableDbSystemName(getter.getDbSystem(request)));
80+
SemconvStability.stableDbSystemName(getter.getDbSystemName(request)));
8181
internalSet(attributes, DB_NAMESPACE, getter.getDbNamespace(request));
8282
internalSet(attributes, DB_QUERY_TEXT, getter.getDbQueryText(request));
8383
internalSet(attributes, DB_OPERATION_NAME, getter.getDbOperationName(request));
8484
internalSet(attributes, DB_QUERY_SUMMARY, getter.getDbQuerySummary(request));
8585
}
8686
if (SemconvStability.emitOldDatabaseSemconv()) {
87-
internalSet(attributes, DB_SYSTEM, getter.getDbSystem(request));
87+
internalSet(attributes, DB_SYSTEM, getter.getDbSystemName(request));
8888
internalSet(attributes, DB_USER, getter.getUser(request));
8989
internalSet(attributes, DB_NAME, getter.getDbNamespace(request));
9090
internalSet(attributes, DB_CONNECTION_STRING, getter.getConnectionString(request));
@@ -114,7 +114,8 @@ static <REQUEST, RESPONSE> void onEndCommon(
114114
internalSet(attributes, ERROR_TYPE, error.getClass().getName());
115115
}
116116
if (error != null || response != null) {
117-
internalSet(attributes, DB_RESPONSE_STATUS_CODE, getter.getResponseStatus(response, error));
117+
internalSet(
118+
attributes, DB_RESPONSE_STATUS_CODE, getter.getResponseStatusCode(response, error));
118119
}
119120
}
120121
}

instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/semconv/db/DbClientCommonAttributesGetter.java

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,15 @@
1515
@Deprecated
1616
public interface DbClientCommonAttributesGetter<REQUEST, RESPONSE> {
1717

18-
String getDbSystem(REQUEST request);
18+
/**
19+
* @deprecated Use {@link #getDbSystemName(REQUEST)} instead.
20+
*/
21+
@Deprecated
22+
default String getDbSystem(REQUEST request) {
23+
return getDbSystemName(request);
24+
}
25+
26+
String getDbSystemName(REQUEST request);
1927

2028
@Deprecated
2129
@Nullable
@@ -32,8 +40,17 @@ default String getConnectionString(REQUEST request) {
3240
return null;
3341
}
3442

43+
/**
44+
* @deprecated Use {@link #getResponseStatusCode(RESPONSE, Throwable)} instead.
45+
*/
46+
@Deprecated
3547
@Nullable
3648
default String getResponseStatus(@Nullable RESPONSE response, @Nullable Throwable error) {
49+
return getResponseStatusCode(response, error);
50+
}
51+
52+
@Nullable
53+
default String getResponseStatusCode(@Nullable RESPONSE response, @Nullable Throwable error) {
3754
return null;
3855
}
3956
}

instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/db/DbClientAttributesExtractorTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ class DbClientAttributesExtractorTest {
2626
static final class TestAttributesGetter
2727
implements DbClientAttributesGetter<Map<String, String>, Void> {
2828
@Override
29-
public String getDbSystem(Map<String, String> map) {
29+
public String getDbSystemName(Map<String, String> map) {
3030
return map.get("db.system");
3131
}
3232

instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/semconv/db/SqlClientAttributesExtractorTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public Collection<String> getRawQueryTexts(Map<String, Object> map) {
3939
}
4040

4141
@Override
42-
public String getDbSystem(Map<String, Object> map) {
42+
public String getDbSystemName(Map<String, Object> map) {
4343
return read(map, "db.system");
4444
}
4545

instrumentation-api/src/test/java/io/opentelemetry/instrumentation/api/internal/InstrumenterContextTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ void testSqlSanitizer() {
3535
SqlClientAttributesGetter<Object, Void> getter =
3636
new SqlClientAttributesGetter<Object, Void>() {
3737
@Override
38-
public String getDbSystem(Object o) {
38+
public String getDbSystemName(Object o) {
3939
return "testdb";
4040
}
4141

instrumentation/jdbc/library/src/main/java/io/opentelemetry/instrumentation/jdbc/internal/JdbcAttributesGetter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ public final class JdbcAttributesGetter implements SqlClientAttributesGetter<DbR
2222

2323
@Nullable
2424
@Override
25-
public String getDbSystem(DbRequest request) {
25+
public String getDbSystemName(DbRequest request) {
2626
return request.getDbInfo().getSystem();
2727
}
2828

0 commit comments

Comments
 (0)