Rename db-statement-sanitizer property to db.query-sanitization

Author: trask

CHANGELOG.md

@@ -8,9 +8,17 @@
   and deprecated config key `otel.instrumentation.graphql.add-operation-name-to-span-name.enabled`
   in favor of `setQuerySanitizationEnabled()`, `setOperationNameInSpanNameEnabled()`, and
   `otel.instrumentation.graphql.operation-name-in-span-name.enabled`
-- Deprecated the declarative config name `statement_sanitizer` in favor of `query_sanitization`
+- Deprecated the DB query sanitization system property names
+  `otel.instrumentation.common.db-statement-sanitizer.enabled`,
+  `otel.instrumentation.jdbc.statement-sanitizer.enabled`,
+  `otel.instrumentation.mongo.statement-sanitizer.enabled`, and
+  `otel.instrumentation.r2dbc.statement-sanitizer.enabled` in favor of the corresponding
+  `*.query-sanitization.enabled` names, and deprecated the declarative config name
+  `statement_sanitizer` in favor of `query_sanitization`
 - Deprecated the declarative config group `common.database` in favor of `common.db`
-- Deprecated the GraphQL declarative config name `query_sanitizer` in favor of
+- Deprecated the GraphQL system property name
+  `otel.instrumentation.graphql.query-sanitizer.enabled` and declarative config name
+  `query_sanitizer` in favor of `otel.instrumentation.graphql.query-sanitization.enabled` and
   `query_sanitization`
 
 ## Version 2.26.1 (2026-03-23)

declarative-config-bridge/src/main/java/io/opentelemetry/instrumentation/config/bridge/ConfigPropertiesBackedDeclarativeConfigProperties.java

@@ -64,11 +64,8 @@ public final class ConfigPropertiesBackedDeclarativeConfigProperties
         "java.common.http.server.emit_experimental_telemetry/development",
         "otel.instrumentation.http.server.emit-experimental-telemetry");
     SPECIAL_MAPPINGS.put(
-        "java.common.db.query_sanitization.enabled",
+        "java.common.database.statement_sanitizer.enabled",
         "otel.instrumentation.common.db-statement-sanitizer.enabled");
-    SPECIAL_MAPPINGS.put(
-        "java.graphql.query_sanitization.enabled",
-        "otel.instrumentation.graphql.query-sanitizer.enabled");
     SPECIAL_MAPPINGS.put(
         "java.common.db.sqlcommenter/development.enabled",
         "otel.instrumentation.common.experimental.db-sqlcommenter.enabled");

declarative-config-bridge/src/test/java/io/opentelemetry/instrumentation/config/bridge/ConfigPropertiesBackedDeclarativeConfigPropertiesTest.java

@@ -100,20 +100,78 @@ void testGeneralHttpListMapping() {
   }
 
   @Test
-  void testQuerySanitizationMapping() {
+  void testCommonDbQuerySanitizationMapping() {
+    DeclarativeConfigProperties config =
+        createConfig("otel.instrumentation.common.db.query-sanitization.enabled", "false");
+
+    assertThat(
+            config
+                .getStructured("java")
+                .getStructured("common")
+                .getStructured("db")
+                .getStructured("query_sanitization")
+                .getBoolean("enabled"))
+        .isFalse();
+  }
+
+  @Test
+  void testDeprecatedCommonDbStatementSanitizerMapping() {
     DeclarativeConfigProperties config =
         createConfig("otel.instrumentation.common.db-statement-sanitizer.enabled", "false");
 
+    assertThat(
+            config
+                .getStructured("java")
+                .getStructured("common")
+                .getStructured("database")
+                .getStructured("statement_sanitizer")
+                .getBoolean("enabled"))
+        .isFalse();
     assertThat(
             config
                 .getStructured("java")
                 .getStructured("common")
                 .getStructured("db")
                 .getStructured("query_sanitization")
                 .getBoolean("enabled"))
+        .isNull();
+  }
+
+  @Test
+  void testGraphqlQuerySanitizationMapping() {
+    DeclarativeConfigProperties config =
+        createConfig("otel.instrumentation.graphql.query-sanitization.enabled", "false");
+
+    assertThat(
+            config
+                .getStructured("java")
+                .getStructured("graphql")
+                .getStructured("query_sanitization")
+                .getBoolean("enabled"))
         .isFalse();
   }
 
+  @Test
+  void testDeprecatedGraphqlQuerySanitizerMapping() {
+    DeclarativeConfigProperties config =
+        createConfig("otel.instrumentation.graphql.query-sanitizer.enabled", "false");
+
+    assertThat(
+            config
+                .getStructured("java")
+                .getStructured("graphql")
+                .getStructured("query_sanitizer")
+                .getBoolean("enabled"))
+        .isFalse();
+    assertThat(
+            config
+                .getStructured("java")
+                .getStructured("graphql")
+                .getStructured("query_sanitization")
+                .getBoolean("enabled"))
+        .isNull();
+  }
+
   @Test
   void testJavaCommonServicePeerMapping() {
     DeclarativeConfigProperties config =

docs/contributing/documenting-instrumentation.md

@@ -94,8 +94,8 @@ disabled_by_default: true
 classification: library
 library_link: https://github.com/...
 configurations:
-  - name: otel.instrumentation.common.db-statement-sanitizer.enabled
-    description: Enables statement sanitization for database queries.
+  - name: otel.instrumentation.common.db.query-sanitization.enabled
+    description: Enables query sanitization for database queries.
     type: boolean
     default: true
 override_telemetry: false
@@ -221,7 +221,7 @@ If an instrumentation module has configuration options, they should be documente
 
 Each configuration should include:
 
-* `name`: The full configuration property name, for example `otel.instrumentation.common.db-statement-sanitizer.enabled`.
+* `name`: The full configuration property name, for example `otel.instrumentation.common.db.query-sanitization.enabled`.
 * `description`: A brief description of what the configuration does.
 * `type`: The data type of the configuration value. Supported types are: `boolean`, `string`, `list`, and `map`.
 * `default`: The default value for the configuration.