Skip to content

Commit 8561995

Browse files
committed
bring back and deprecate public api
1 parent 62e11c9 commit 8561995

File tree

2 files changed

+55
-29
lines changed

2 files changed

+55
-29
lines changed

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

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -18,56 +18,63 @@
1818
* from the attribute methods, but implement as many as possible for best compliance with the
1919
* OpenTelemetry specification.
2020
*/
21-
public interface DbClientAttributesGetter<REQUEST> {
21+
@SuppressWarnings("deprecation") // using deprecated semconv
22+
public interface DbClientAttributesGetter<REQUEST> extends DbClientCommonAttributesGetter<REQUEST> {
2223

23-
@Deprecated
2424
@Nullable
25-
default String getSystem(REQUEST request) {
25+
String getDbSystem(REQUEST request);
26+
27+
@Nullable
28+
String getDbNamespace(REQUEST request);
29+
30+
@Nullable
31+
default String getDbQueryText(REQUEST request) {
2632
return null;
2733
}
2834

29-
// TODO: make this required to implement
3035
@Nullable
31-
default String getDbSystem(REQUEST request) {
32-
return getSystem(request);
36+
default String getDbOperationName(REQUEST request) {
37+
return null;
3338
}
3439

40+
/**
41+
* @deprecated Use {@link #getDbSystem(Object)} instead.
42+
*/
3543
@Deprecated
44+
@Override
3645
@Nullable
37-
String getUser(REQUEST request);
46+
default String getSystem(REQUEST request) {
47+
return getDbSystem(request);
48+
}
3849

39-
/**
40-
* @deprecated Use {@link #getDbNamespace(Object)} instead.
41-
*/
4250
@Deprecated
4351
@Nullable
44-
default String getName(REQUEST request) {
52+
default String getUser(REQUEST request) {
4553
return null;
4654
}
4755

48-
// TODO: make this required to implement
56+
/**
57+
* @deprecated Use {@link #getDbNamespace(Object)} instead.
58+
*/
59+
@Deprecated
4960
@Nullable
50-
default String getDbNamespace(REQUEST request) {
51-
return getName(request);
61+
default String getName(REQUEST request) {
62+
return getDbNamespace(request);
5263
}
5364

5465
@Deprecated
5566
@Nullable
56-
String getConnectionString(REQUEST request);
67+
default String getConnectionString(REQUEST request) {
68+
return null;
69+
}
5770

5871
/**
5972
* @deprecated Use {@link #getDbQueryText(REQUEST)} instead.
6073
*/
6174
@Deprecated
6275
@Nullable
6376
default String getStatement(REQUEST request) {
64-
return null;
65-
}
66-
67-
// TODO: make this required to implement
68-
@Nullable
69-
default String getDbQueryText(REQUEST request) {
70-
return getStatement(request);
77+
return getDbQueryText(request);
7178
}
7279

7380
/**
@@ -76,12 +83,6 @@ default String getDbQueryText(REQUEST request) {
7683
@Deprecated
7784
@Nullable
7885
default String getOperation(REQUEST request) {
79-
return null;
80-
}
81-
82-
// TODO: make this required to implement
83-
@Nullable
84-
default String getDbOperationName(REQUEST request) {
85-
return getOperation(request);
86+
return getDbOperationName(request);
8687
}
8788
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
/*
2+
* Copyright The OpenTelemetry Authors
3+
* SPDX-License-Identifier: Apache-2.0
4+
*/
5+
6+
package io.opentelemetry.instrumentation.api.incubator.semconv.db;
7+
8+
import javax.annotation.Nullable;
9+
10+
/** An interface for getting attributes common to database clients. */
11+
@Deprecated
12+
public interface DbClientCommonAttributesGetter<REQUEST> {
13+
14+
@Nullable
15+
String getSystem(REQUEST request);
16+
17+
@Nullable
18+
String getUser(REQUEST request);
19+
20+
@Nullable
21+
String getName(REQUEST request);
22+
23+
@Nullable
24+
String getConnectionString(REQUEST request);
25+
}

0 commit comments

Comments
 (0)