Skip to content

Commit f27845a

Browse files
Copilottrask
Copilot
and
trask
authored
Rename internal statementSanitizationEnabled to querySanitizationEnabled (#16143)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: trask <218610+trask@users.noreply.github.com> Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>
1 parent cfa0383 commit f27845a

11 files changed

Lines changed: 46 additions & 53 deletions

File tree

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

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,18 +31,17 @@ private MultiQuery(
3131
this.querySummary = querySummary;
3232
}
3333

34-
static MultiQuery analyze(
35-
Collection<String> rawQueryTexts, boolean statementSanitizationEnabled) {
36-
return analyzeInternal(rawQueryTexts, statementSanitizationEnabled, false);
34+
static MultiQuery analyze(Collection<String> rawQueryTexts, boolean querySanitizationEnabled) {
35+
return analyzeInternal(rawQueryTexts, querySanitizationEnabled, false);
3736
}
3837

3938
static MultiQuery analyzeWithSummary(
40-
Collection<String> rawQueryTexts, boolean statementSanitizationEnabled) {
41-
return analyzeInternal(rawQueryTexts, statementSanitizationEnabled, true);
39+
Collection<String> rawQueryTexts, boolean querySanitizationEnabled) {
40+
return analyzeInternal(rawQueryTexts, querySanitizationEnabled, true);
4241
}
4342

4443
private static MultiQuery analyzeInternal(
45-
Collection<String> rawQueryTexts, boolean statementSanitizationEnabled, boolean withSummary) {
44+
Collection<String> rawQueryTexts, boolean querySanitizationEnabled, boolean withSummary) {
4645
UniqueValue uniqueCollectionName = new UniqueValue();
4746
UniqueValue uniqueStoredProcedureName = new UniqueValue();
4847
UniqueValue uniqueOperationName = new UniqueValue();
@@ -59,8 +58,7 @@ private static MultiQuery analyzeInternal(
5958
uniqueStoredProcedureName.set(storedProcedureName);
6059
String operationName = sanitizedQuery.getOperationName();
6160
uniqueOperationName.set(operationName);
62-
uniqueQueryTexts.add(
63-
statementSanitizationEnabled ? sanitizedQuery.getQueryText() : rawQueryText);
61+
uniqueQueryTexts.add(querySanitizationEnabled ? sanitizedQuery.getQueryText() : rawQueryText);
6462
uniqueQuerySummary.set(sanitizedQuery.getQuerySummary());
6563
}
6664

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -350,18 +350,18 @@ public final class RedisCommandSanitizer {
350350
SANITIZERS = unmodifiableMap(sanitizers);
351351
}
352352

353-
public static RedisCommandSanitizer create(boolean statementSanitizationEnabled) {
354-
return new RedisCommandSanitizer(statementSanitizationEnabled);
353+
public static RedisCommandSanitizer create(boolean querySanitizationEnabled) {
354+
return new RedisCommandSanitizer(querySanitizationEnabled);
355355
}
356356

357-
private final boolean statementSanitizationEnabled;
357+
private final boolean querySanitizationEnabled;
358358

359-
private RedisCommandSanitizer(boolean statementSanitizationEnabled) {
360-
this.statementSanitizationEnabled = statementSanitizationEnabled;
359+
private RedisCommandSanitizer(boolean querySanitizationEnabled) {
360+
this.querySanitizationEnabled = querySanitizationEnabled;
361361
}
362362

363363
public String sanitize(String command, List<?> args) {
364-
if (!statementSanitizationEnabled) {
364+
if (!querySanitizationEnabled) {
365365
return KeepAllArgs.INSTANCE.sanitize(command, args);
366366
}
367367
return SANITIZERS

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,18 +62,18 @@ public static <REQUEST, RESPONSE> SqlClientAttributesExtractorBuilder<REQUEST, R
6262
private final InternalNetworkAttributesExtractor<REQUEST, RESPONSE> internalNetworkExtractor;
6363
private final ServerAttributesExtractor<REQUEST, RESPONSE> serverAttributesExtractor;
6464
private final AttributeKey<String> oldSemconvTableAttribute;
65-
private final boolean statementSanitizationEnabled;
65+
private final boolean querySanitizationEnabled;
6666
private final boolean captureQueryParameters;
6767

6868
SqlClientAttributesExtractor(
6969
SqlClientAttributesGetter<REQUEST, RESPONSE> getter,
7070
AttributeKey<String> oldSemconvTableAttribute,
71-
boolean statementSanitizationEnabled,
71+
boolean querySanitizationEnabled,
7272
boolean captureQueryParameters) {
7373
this.getter = getter;
7474
this.oldSemconvTableAttribute = oldSemconvTableAttribute;
7575
// capturing query parameters disables statement sanitization
76-
this.statementSanitizationEnabled = !captureQueryParameters && statementSanitizationEnabled;
76+
this.querySanitizationEnabled = !captureQueryParameters && querySanitizationEnabled;
7777
this.captureQueryParameters = captureQueryParameters;
7878
internalNetworkExtractor = new InternalNetworkAttributesExtractor<>(getter, true, false);
7979
serverAttributesExtractor = ServerAttributesExtractor.create(getter);
@@ -95,7 +95,7 @@ public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST
9595
internalSet(
9696
attributes,
9797
DB_STATEMENT,
98-
statementSanitizationEnabled ? sanitizedQuery.getQueryText() : rawQueryText);
98+
querySanitizationEnabled ? sanitizedQuery.getQueryText() : rawQueryText);
9999
internalSet(attributes, DB_OPERATION, operationName);
100100
internalSet(attributes, oldSemconvTableAttribute, sanitizedQuery.getCollectionName());
101101
}
@@ -106,7 +106,7 @@ public void onStart(AttributesBuilder attributes, Context parentContext, REQUEST
106106
internalSet(attributes, DB_OPERATION_BATCH_SIZE, batchSize);
107107
}
108108
boolean parameterizedQuery = getter.isParameterizedQuery(request);
109-
boolean shouldSanitize = statementSanitizationEnabled && !parameterizedQuery;
109+
boolean shouldSanitize = querySanitizationEnabled && !parameterizedQuery;
110110
if (rawQueryTexts.size() == 1) {
111111
String rawQueryText = rawQueryTexts.iterator().next();
112112
SqlQuery sanitizedQuery =

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,22 +23,22 @@ public final class SqlQuerySanitizer {
2323
private static final Cache<CacheKey, SqlQuery> sqlToQueryCacheWithSummary = Cache.bounded(1000);
2424
private static final int LARGE_QUERY_THRESHOLD = 10 * 1024;
2525

26-
public static SqlQuerySanitizer create(boolean statementSanitizationEnabled) {
27-
return new SqlQuerySanitizer(statementSanitizationEnabled);
26+
public static SqlQuerySanitizer create(boolean querySanitizationEnabled) {
27+
return new SqlQuerySanitizer(querySanitizationEnabled);
2828
}
2929

30-
private final boolean statementSanitizationEnabled;
30+
private final boolean querySanitizationEnabled;
3131

32-
private SqlQuerySanitizer(boolean statementSanitizationEnabled) {
33-
this.statementSanitizationEnabled = statementSanitizationEnabled;
32+
private SqlQuerySanitizer(boolean querySanitizationEnabled) {
33+
this.querySanitizationEnabled = querySanitizationEnabled;
3434
}
3535

3636
public SqlQuery sanitize(@Nullable String query) {
3737
return sanitize(query, SqlDialect.DEFAULT);
3838
}
3939

4040
public SqlQuery sanitize(@Nullable String query, SqlDialect dialect) {
41-
if (!statementSanitizationEnabled || query == null) {
41+
if (!querySanitizationEnabled || query == null) {
4242
return SqlQuery.create(query, null, null);
4343
}
4444
// sanitization result will not be cached for queries larger than the threshold to avoid
@@ -63,7 +63,7 @@ public SqlQuery sanitizeWithSummary(@Nullable String query) {
6363

6464
/** Sanitize and extract query summary. */
6565
public SqlQuery sanitizeWithSummary(@Nullable String query, SqlDialect dialect) {
66-
if (!statementSanitizationEnabled || query == null) {
66+
if (!querySanitizationEnabled || query == null) {
6767
return SqlQuery.createWithSummary(query, null, null);
6868
}
6969
// sanitization result will not be cached for queries larger than the threshold to avoid

‎instrumentation/cassandra/cassandra-4.4/library/src/main/java/io/opentelemetry/instrumentation/cassandra/v4_4/CassandraTelemetryBuilder.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,15 +62,15 @@ public CassandraTelemetry build() {
6262

6363
@SuppressWarnings("deprecation") // to support old database semantic conventions
6464
protected Instrumenter<CassandraRequest, ExecutionInfo> createInstrumenter(
65-
OpenTelemetry openTelemetry, boolean statementSanitizationEnabled) {
65+
OpenTelemetry openTelemetry, boolean querySanitizationEnabled) {
6666
CassandraSqlAttributesGetter attributesGetter = new CassandraSqlAttributesGetter();
6767

6868
return Instrumenter.<CassandraRequest, ExecutionInfo>builder(
6969
openTelemetry, INSTRUMENTATION_NAME, DbClientSpanNameExtractor.create(attributesGetter))
7070
.addAttributesExtractor(
7171
SqlClientAttributesExtractor.builder(attributesGetter)
7272
.setTableAttribute(DB_CASSANDRA_TABLE)
73-
.setQuerySanitizationEnabled(statementSanitizationEnabled)
73+
.setQuerySanitizationEnabled(querySanitizationEnabled)
7474
.build())
7575
.addAttributesExtractor(new CassandraAttributesExtractor())
7676
.addOperationMetrics(DbClientMetrics.get())

‎instrumentation/jdbc/library/src/main/java/io/opentelemetry/instrumentation/jdbc/internal/JdbcInstrumenterFactory.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ public static Instrumenter<DbRequest, Void> createStatementInstrumenter(
4646
static Instrumenter<DbRequest, Void> createStatementInstrumenter(
4747
OpenTelemetry openTelemetry, boolean captureQueryParameters) {
4848
@SuppressWarnings("deprecation") // using deprecated config property
49-
boolean statementSanitizationEnabled =
49+
boolean querySanitizationEnabled =
5050
DeclarativeConfigUtil.getInstrumentationConfig(openTelemetry, "common")
5151
.get("database")
5252
.get("statement_sanitizer")
@@ -55,31 +55,31 @@ static Instrumenter<DbRequest, Void> createStatementInstrumenter(
5555
ConfigPropertiesUtil.getBoolean(
5656
"otel.instrumentation.common.db-statement-sanitizer.enabled", true));
5757
return createStatementInstrumenter(
58-
openTelemetry, emptyList(), true, statementSanitizationEnabled, captureQueryParameters);
58+
openTelemetry, emptyList(), true, querySanitizationEnabled, captureQueryParameters);
5959
}
6060

6161
public static Instrumenter<DbRequest, Void> createStatementInstrumenter(
6262
OpenTelemetry openTelemetry,
6363
boolean enabled,
64-
boolean statementSanitizationEnabled,
64+
boolean querySanitizationEnabled,
6565
boolean captureQueryParameters) {
6666
return createStatementInstrumenter(
67-
openTelemetry, emptyList(), enabled, statementSanitizationEnabled, captureQueryParameters);
67+
openTelemetry, emptyList(), enabled, querySanitizationEnabled, captureQueryParameters);
6868
}
6969

7070
public static Instrumenter<DbRequest, Void> createStatementInstrumenter(
7171
OpenTelemetry openTelemetry,
7272
List<AttributesExtractor<DbRequest, Void>> extractors,
7373
boolean enabled,
74-
boolean statementSanitizationEnabled,
74+
boolean querySanitizationEnabled,
7575
boolean captureQueryParameters) {
7676
return Instrumenter.<DbRequest, Void>builder(
7777
openTelemetry,
7878
INSTRUMENTATION_NAME,
7979
DbClientSpanNameExtractor.create(JdbcAttributesGetter.INSTANCE))
8080
.addAttributesExtractor(
8181
SqlClientAttributesExtractor.builder(JdbcAttributesGetter.INSTANCE)
82-
.setQuerySanitizationEnabled(statementSanitizationEnabled)
82+
.setQuerySanitizationEnabled(querySanitizationEnabled)
8383
.setCaptureQueryParameters(captureQueryParameters)
8484
.build())
8585
.addAttributesExtractors(extractors)

‎instrumentation/lettuce/lettuce-5.1/library/src/main/java/io/opentelemetry/instrumentation/lettuce/v5_1/LettuceTelemetry.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ public static LettuceTelemetryBuilder builder(OpenTelemetry openTelemetry) {
3737

3838
LettuceTelemetry(
3939
OpenTelemetry openTelemetry,
40-
boolean statementSanitizationEnabled,
40+
boolean querySanitizationEnabled,
4141
boolean encodingEventsEnabled,
4242
OperationListener metrics) {
4343
this.metrics = metrics;
@@ -47,7 +47,7 @@ public static LettuceTelemetryBuilder builder(OpenTelemetry openTelemetry) {
4747
tracerBuilder.setInstrumentationVersion(version);
4848
}
4949
tracer = tracerBuilder.build();
50-
sanitizer = RedisCommandSanitizer.create(statementSanitizationEnabled);
50+
sanitizer = RedisCommandSanitizer.create(querySanitizationEnabled);
5151
this.encodingEventsEnabled = encodingEventsEnabled;
5252
}
5353

‎instrumentation/mongo/mongo-3.1/library/src/main/java/io/opentelemetry/instrumentation/mongo/v3_1/MongoTelemetry.java‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,11 @@ public static MongoTelemetryBuilder builder(OpenTelemetry openTelemetry) {
3333
MongoTelemetry(
3434
OpenTelemetry openTelemetry,
3535
String instrumentationName,
36-
boolean statementSanitizationEnabled,
36+
boolean querySanitizationEnabled,
3737
int maxNormalizedQueryLength) {
3838
this.instrumenter =
3939
MongoInstrumenterFactory.createInstrumenter(
40-
openTelemetry,
41-
instrumentationName,
42-
statementSanitizationEnabled,
43-
maxNormalizedQueryLength);
40+
openTelemetry, instrumentationName, querySanitizationEnabled, maxNormalizedQueryLength);
4441
}
4542

4643
/**

‎instrumentation/mongo/mongo-3.1/library/src/main/java/io/opentelemetry/instrumentation/mongo/v3_1/internal/MongoDbAttributesGetter.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,12 @@ class MongoDbAttributesGetter implements DbClientAttributesGetter<CommandStarted
4040
.orElse(null);
4141
}
4242

43-
private final boolean statementSanitizationEnabled;
43+
private final boolean querySanitizationEnabled;
4444
private final int maxNormalizedQueryLength;
4545
@Nullable private final JsonWriterSettings jsonWriterSettings;
4646

47-
MongoDbAttributesGetter(boolean statementSanitizationEnabled, int maxNormalizedQueryLength) {
48-
this.statementSanitizationEnabled = statementSanitizationEnabled;
47+
MongoDbAttributesGetter(boolean querySanitizationEnabled, int maxNormalizedQueryLength) {
48+
this.querySanitizationEnabled = querySanitizationEnabled;
4949
this.maxNormalizedQueryLength = maxNormalizedQueryLength;
5050
this.jsonWriterSettings = createJsonWriterSettings(maxNormalizedQueryLength);
5151
}
@@ -109,7 +109,7 @@ String sanitizeQuery(BsonDocument command) {
109109
? new JsonWriter(stringWriter, jsonWriterSettings)
110110
: new JsonWriter(stringWriter);
111111

112-
if (statementSanitizationEnabled) {
112+
if (querySanitizationEnabled) {
113113
writeScrubbed(command, jsonWriter, /* isRoot= */ true);
114114
} else {
115115
new BsonDocumentCodec().encode(jsonWriter, command, EncoderContext.builder().build());

‎instrumentation/mongo/mongo-3.1/library/src/main/java/io/opentelemetry/instrumentation/mongo/v3_1/internal/MongoInstrumenterFactory.java‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,24 +26,22 @@ public final class MongoInstrumenterFactory {
2626
new MongoAttributesExtractor();
2727

2828
public static Instrumenter<CommandStartedEvent, Void> createInstrumenter(
29-
OpenTelemetry openTelemetry,
30-
String instrumentationName,
31-
boolean statementSanitizationEnabled) {
29+
OpenTelemetry openTelemetry, String instrumentationName, boolean querySanitizationEnabled) {
3230
return createInstrumenter(
3331
openTelemetry,
3432
instrumentationName,
35-
statementSanitizationEnabled,
33+
querySanitizationEnabled,
3634
DEFAULT_MAX_NORMALIZED_QUERY_LENGTH);
3735
}
3836

3937
public static Instrumenter<CommandStartedEvent, Void> createInstrumenter(
4038
OpenTelemetry openTelemetry,
4139
String instrumentationName,
42-
boolean statementSanitizationEnabled,
40+
boolean querySanitizationEnabled,
4341
int maxNormalizedQueryLength) {
4442

4543
MongoDbAttributesGetter dbAttributesGetter =
46-
new MongoDbAttributesGetter(statementSanitizationEnabled, maxNormalizedQueryLength);
44+
new MongoDbAttributesGetter(querySanitizationEnabled, maxNormalizedQueryLength);
4745
SpanNameExtractor<CommandStartedEvent> spanNameExtractor =
4846
new MongoSpanNameExtractor(dbAttributesGetter, attributesExtractor);
4947

0 commit comments

Comments
 (0)