Rename db-statement-sanitizer property to db.query-sanitization#17464
Merged
trask merged 7 commits intoopen-telemetry:mainfrom Apr 4, 2026
Merged
Rename db-statement-sanitizer property to db.query-sanitization#17464trask merged 7 commits intoopen-telemetry:mainfrom
trask merged 7 commits intoopen-telemetry:mainfrom
Conversation
otelbot-java-instrumentation
Bot
added
the
test native
Contributor
There was a problem hiding this comment.
Pull request overview
Renames non-declarative (flat/system property) database query sanitization configuration keys from “statement sanitizer” terminology to “query sanitization”, aligning with the declarative config terminology changes introduced in #17116, and updates related docs/metadata/tests.
Changes:
- Renamed common DB config from
otel.instrumentation.common.db-statement-sanitizer.enabledtootel.instrumentation.common.db.query-sanitization.enabled, keeping deprecated fallbacks. - Renamed instrumentation-specific keys (e.g., JDBC/Mongo/R2DBC/GraphQL) from
*.statement-sanitizer.enabled/*.query-sanitizer.enabledto*.query-sanitization.enabledacross metadata/docs. - Added/updated tests and deprecation warnings for deprecated keys (including common DB sqlcommenter).
Reviewed changes
Copilot reviewed 48 out of 48 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| smoke-tests-otel-starter/spring-boot-reactive-common/src/main/resources/application.yaml | Update starter YAML to new common.db.query-sanitization key |
| smoke-tests-otel-starter/spring-boot-reactive-common/src/main/java/io/opentelemetry/spring/smoketest/AbstractOtelReactiveSpringStarterSmokeTest.java | Update config key reference in test comment |
| smoke-tests-otel-starter/spring-boot-common/src/main/resources/application.yaml | Update starter YAML to new common.db.query-sanitization key |
| smoke-tests-otel-starter/spring-boot-common/src/main/java/io/opentelemetry/spring/smoketest/AbstractOtelSpringStarterSmokeTest.java | Update config key reference in test comment |
| instrumentation/vertx/vertx-sql-client/vertx-sql-client-5.0/metadata.yaml | Rename documented config option to common.db.query-sanitization |
| instrumentation/vertx/vertx-sql-client/vertx-sql-client-4.0/metadata.yaml | Rename documented config option to common.db.query-sanitization |
| instrumentation/vertx/vertx-redis-client-4.0/metadata.yaml | Rename documented config option to common.db.query-sanitization |
| instrumentation/spring/spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json | Rename Spring config metadata entries to *.query-sanitization.enabled |
| instrumentation/r2dbc-1.0/README.md | Update documented R2DBC property name |
| instrumentation/r2dbc-1.0/metadata.yaml | Rename R2DBC/common DB config names to *.query-sanitization.enabled |
| instrumentation/mongo/README.md | Update documented Mongo property name |
| instrumentation/mongo/mongo-async-3.3/metadata.yaml | Rename Mongo/common DB config names to *.query-sanitization.enabled |
| instrumentation/mongo/mongo-4.0/metadata.yaml | Rename Mongo/common DB config names to *.query-sanitization.enabled |
| instrumentation/mongo/mongo-3.7/metadata.yaml | Rename Mongo/common DB config names to *.query-sanitization.enabled |
| instrumentation/mongo/mongo-3.1/metadata.yaml | Rename Mongo/common DB config names to *.query-sanitization.enabled |
| instrumentation/lettuce/lettuce-5.1/metadata.yaml | Rename documented common DB config option |
| instrumentation/lettuce/lettuce-5.0/metadata.yaml | Rename documented common DB config option |
| instrumentation/jedis/jedis-4.0/metadata.yaml | Rename documented common DB config option |
| instrumentation/jedis/jedis-3.0/metadata.yaml | Rename documented common DB config option |
| instrumentation/jedis/jedis-1.4/metadata.yaml | Rename documented common DB config option |
| instrumentation/jdbc/README.md | Update documented JDBC property name + wording |
| instrumentation/jdbc/metadata.yaml | Rename JDBC/common DB property names in metadata |
| instrumentation/jdbc/library/src/main/java/io/opentelemetry/instrumentation/jdbc/OpenTelemetryDriver.java | Add deprecated common sqlcommenter flat-property fallback + warning |
| instrumentation/jdbc/library/src/main/java/io/opentelemetry/instrumentation/jdbc/internal/JdbcInstrumenterFactory.java | Prefer new common DB query-sanitization property, fallback to deprecated |
| instrumentation/influxdb-2.4/metadata.yaml | Rename documented common DB config option |
| instrumentation/graphql-java/README.md | Update documented GraphQL property name |
| instrumentation/graphql-java/graphql-java-20.0/metadata.yaml | Rename GraphQL config option to query-sanitization.enabled |
| instrumentation/graphql-java/graphql-java-20.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/graphql/v20_0/GraphqlSingletons.java | Update deprecation warning text for GraphQL config renames |
| instrumentation/graphql-java/graphql-java-12.0/metadata.yaml | Rename GraphQL config option to query-sanitization.enabled |
| instrumentation/graphql-java/graphql-java-12.0/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/graphql/v12_0/GraphqlSingletons.java | Update deprecation warning text for GraphQL config renames |
| instrumentation/geode-1.4/metadata.yaml | Rename documented common DB config option |
| instrumentation/couchbase/couchbase-2.6/metadata.yaml | Rename documented common DB config option |
| instrumentation/couchbase/couchbase-2.0/metadata.yaml | Rename documented common DB config option |
| instrumentation/clickhouse/clickhouse-client-v2-0.8/metadata.yaml | Rename documented common DB config option |
| instrumentation/clickhouse/clickhouse-client-v1-0.5/metadata.yaml | Rename documented common DB config option |
| instrumentation/cassandra/cassandra-4.4/metadata.yaml | Rename documented common DB config option |
| instrumentation/cassandra/cassandra-4.0/metadata.yaml | Rename documented common DB config option |
| instrumentation/cassandra/cassandra-3.0/metadata.yaml | Rename documented common DB config option |
| instrumentation-docs/src/test/java/io/opentelemetry/instrumentation/docs/utils/YamlHelperTest.java | Update metadata parsing test expectations for renamed config |
| instrumentation-docs/readme.md | Update documentation example for renamed config |
| instrumentation-api-incubator/src/test/java/io/opentelemetry/instrumentation/api/incubator/config/internal/DbConfigTest.java | Add tests for new precedence + deprecated fallbacks |
| instrumentation-api-incubator/src/main/java/io/opentelemetry/instrumentation/api/incubator/config/internal/DbConfig.java | Implement new common DB config lookup + deprecation warnings/fallbacks |
| docs/instrumentation-list.yaml | Update generated instrumentation list config names/descriptions |
| docs/contributing/documenting-instrumentation.md | Update contributing docs example property name |
| declarative-config-bridge/src/test/java/io/opentelemetry/instrumentation/config/bridge/ConfigPropertiesBackedDeclarativeConfigPropertiesTest.java | Add/adjust mapping tests for new and deprecated flat keys |
| declarative-config-bridge/src/main/java/io/opentelemetry/instrumentation/config/bridge/ConfigPropertiesBackedDeclarativeConfigProperties.java | Remove no-longer-needed special mappings for renamed keys |
| CHANGELOG.md | Document deprecations for renamed flat properties |
| .github/agents/knowledge/config-property-stability.md | Update config stability guidance example for new sqlcommenter key |
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
laurit
approved these changes
Apr 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Renamed the declarative configuration properties in
This PR now renames the non-declarative configuration properties.