Skip to content

Use names specified by OpenTelemetry for tags #1468

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 2 commits into from
Sep 27, 2024
Merged

Use names specified by OpenTelemetry for tags #1468

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
20c5f4f
Use names specified by OpenTelemetry for tags
tsegismont Sep 26, 2024
e751864
Prevent failures in MySQLUnixDomainSocketTest
tsegismont Sep 26, 2024
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
10 changes: 3 additions & 7 deletions vertx-mysql-client/src/test/java/io/vertx/mysqlclient/MySQLUnixDomainSocketTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,9 @@ public void setUp() {
}

@After
public void after(TestContext ctx) {
if (vertx != null) {
vertx.close().onComplete(ctx.asyncAssertSuccess());
}
if (client != null) {
client.close().onComplete(ctx.asyncAssertSuccess());
}
public void after() {
client.close().await();
vertx.close().await();
}

@Test
Expand Down
19 changes: 10 additions & 9 deletions vertx-sql-client/src/main/java/io/vertx/sqlclient/impl/tracing/QueryReporter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
package io.vertx.sqlclient.impl.tracing;

import io.vertx.core.AsyncResult;
import io.vertx.core.internal.ContextInternal;
import io.vertx.core.spi.metrics.ClientMetrics;
import io.vertx.core.spi.tracing.SpanKind;
import io.vertx.core.spi.tracing.TagExtractor;
import io.vertx.core.spi.tracing.VertxTracer;
import io.vertx.core.tracing.TracingPolicy;
import io.vertx.core.internal.ContextInternal;
import io.vertx.sqlclient.Tuple;
import io.vertx.sqlclient.internal.Connection;
import io.vertx.sqlclient.impl.QueryResultBuilder;
import io.vertx.sqlclient.internal.Connection;
import io.vertx.sqlclient.internal.command.ExtendedQueryCommand;
import io.vertx.sqlclient.internal.command.QueryCommandBase;
import io.vertx.sqlclient.internal.command.SimpleQueryCommand;
Expand All @@ -26,17 +26,16 @@ public class QueryReporter {
enum RequestTags {

// Generic
PEER_ADDRESS("peer.address", q -> q.tracer.address),
PEER_ADDRESS("network.peer.address", q -> q.tracer.address),
SPAN_KIND("span.kind", q -> "client"),

// DB
// See https://github.com/open-telemetry/opentelemetry-specification/blob/v1.18.0/specification/trace/semantic_conventions/database.md#connection-level-attributes
// See https://opentelemetry.io/docs/specs/semconv/database/

DB_USER("db.user", q -> q.tracer.user),
DB_INSTANCE("db.instance", q -> q.tracer.database),
DB_STATEMENT("db.statement", QueryRequest::sql),
DB_TYPE("db.type", q -> "sql"),
DB_NAME("db.system", q -> q.tracer.system),
DB_NAMESPACE("db.namespace", q -> q.tracer.database),
DB_QUERY_TEXT("db.query.text", QueryRequest::sql),
DB_SYSTEM("db.system", q -> q.tracer.system),
;

final String name;
Expand All @@ -48,18 +47,20 @@ enum RequestTags {
}
}

private static final TagExtractor<QueryRequest> REQUEST_TAG_EXTRACTOR = new TagExtractor<QueryRequest>() {
private static final TagExtractor<QueryRequest> REQUEST_TAG_EXTRACTOR = new TagExtractor<>() {

private final RequestTags[] TAGS = RequestTags.values();

@Override
public int len(QueryRequest obj) {
return TAGS.length;
}

@Override
public String name(QueryRequest obj, int index) {
return TAGS[index].name;
}

@Override
public String value(QueryRequest obj, int index) {
return TAGS[index].fn.apply(obj);
Expand Down
4 changes: 1 addition & 3 deletions vertx-sql-client/src/test/java/io/vertx/sqlclient/tck/TracingTestBase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
import io.vertx.core.Context;
import io.vertx.core.Future;
import io.vertx.core.Vertx;
import io.vertx.core.VertxOptions;
import io.vertx.core.spi.tracing.SpanKind;
import io.vertx.core.spi.tracing.TagExtractor;
import io.vertx.core.spi.tracing.VertxTracer;
Expand Down Expand Up @@ -124,8 +123,7 @@ public <R> Object sendRequest(Context context, SpanKind kind, TracingPolicy trac
ctx.assertEquals(expectedTuples, query.tuples());
Map<String, String> tags = tagExtractor.extract(request);
ctx.assertEquals("client", tags.get("span.kind"));
ctx.assertEquals("sql", tags.get("db.type"));
ctx.assertEquals(expectedSql, tags.get("db.statement"));
ctx.assertEquals(expectedSql, tags.get("db.query.text"));
String dbSystem = tags.get("db.system");
ctx.assertNotNull(dbSystem);
ctx.assertTrue(isValidDbSystem(dbSystem));
Expand Down
Loading