Db client error type for JDBC #13331
Conversation
github-actions
bot
added
the
test native
| @Override | ||
| public String getResponseStatusFromException(Throwable throwable) { | ||
| if (throwable instanceof CouchbaseException) { | ||
| // todo |
There was a problem hiding this comment.
@laurit can you provide a hint how I could get details of a newer library version?
Should this be in one of the other couchbase modules? Is there an example?
| @Nullable | ||
| @Override | ||
| public String getResponseStatusFromException(Throwable throwable) { | ||
| // todo |
There was a problem hiding this comment.
@laurit can you help here as well?
There was a problem hiding this comment.
In our test the exception is of type io.vertx.pgclient.PgException https://github.com/eclipse-vertx/vertx-sql-client/blob/4.0.0/vertx-pg-client/src/main/java/io/vertx/pgclient/PgException.java you could extract the error from there. Probably the other vetx database drivers provide similar exceptions. You may need to use reflection to extract it.
| @@ -29,6 +29,9 @@ abstract class DbClientCommonAttributesExtractor< | |||
| private static final AttributeKey<String> DB_USER = AttributeKey.stringKey("db.user"); | |||
| private static final AttributeKey<String> DB_CONNECTION_STRING = | |||
| AttributeKey.stringKey("db.connection_string"); | |||
| private static final AttributeKey<String> ERROR_TYPE = AttributeKey.stringKey("error.type"); | |||
There was a problem hiding this comment.
you should use ErrorAttributes.ERROR_TYPE since it is a stable attribute
| @Nullable | ||
| default String getResponseStatusFromException(Throwable throwable) { | ||
| return null; | ||
| } | ||
|
|
||
| @Nullable | ||
| default String getResponseStatus(RESPONSE response) { | ||
| return null; | ||
| } |
There was a problem hiding this comment.
HttpCommonAttributesGetter has Integer getHttpResponseStatusCode(REQUEST request, RESPONSE response, @Nullable Throwable error);
| @Nullable | ||
| default String httpStatusToResponseStatus(int httpStatus) { | ||
| int hundreds = httpStatus / 100; | ||
| return hundreds == 4 || hundreds == 5 ? Integer.toString(httpStatus) : null; | ||
| } |
There was a problem hiding this comment.
To me this method feels out of place here. Secondly I believe it would be more conventional to use httpStatus >= 400 && httpStatus< 600. Thirdly https://opentelemetry.io/docs/specs/semconv/database/database-spans/ says that
The status code returned by the database. Usually it represents an error code, but may also represent partial success, warning, or differentiate between various types of successful outcomes. Semantic conventions for individual database systems SHOULD document what db.response.status_code means in the context of that system.
Using the http status here already feels obscure enough that we may need to start documenting this along with the instrumentation. I'm not sure end users will be easily able to figure this out.
| @@ -8,7 +8,7 @@ | |||
| import javax.annotation.Nullable; | |||
|
|
|||
| /** An interface for getting attributes common to database clients. */ | |||
| public interface DbClientCommonAttributesGetter<REQUEST> { | |||
| public interface DbClientCommonAttributesGetter<REQUEST, RESPONSE> { | |||
There was a problem hiding this comment.
Adding a type parameter is a breaking change. @trask is this fine or do you have suggestions?
| if (error != null) { | ||
| internalSet(attributes, ERROR_TYPE, error.getClass().getName()); | ||
| internalSet( | ||
| attributes, DB_RESPONSE_STATUS_CODE, getter.getResponseStatusFromException(error)); | ||
| } | ||
| if (response != null) { | ||
| internalSet(attributes, DB_RESPONSE_STATUS_CODE, getter.getResponseStatus(response)); | ||
| } |
There was a problem hiding this comment.
should there be a stable semconv check?
zeitlinger
force-pushed
the
db-client-error-type
branch
from
973784e to
7454b42
Compare
Part of #12804