Mark capture-query-parameters as experimental (open-telemetry#13850)

trask · laurit · web-flow · commit 6f80481a2e84 · 2025-05-15T16:09:08.000+03:00
Co-authored-by: Lauri Tulmin &lt;ltulmin@splunk.com&gt;
diff --git a/instrumentation/jdbc/README.md b/instrumentation/jdbc/README.md
@@ -1,7 +1,7 @@
 # Settings for the JDBC instrumentation
 
-| System property                                              | Type    | Default | Description                                                                                                                                                                                                                                                                   |
-|--------------------------------------------------------------|---------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `otel.instrumentation.jdbc.statement-sanitizer.enabled`      | Boolean | `true`  | Enables the DB statement sanitization.                                                                                                                                                                                                                                        |
-| `otel.instrumentation.jdbc.capture-query-parameters`         | Boolean | `false` | Enable the capture of query parameters as span attributes. Enabling this option disables the statement sanitization. <p>WARNING: captured query parameters may contain sensitive information such as passwords, personally identifiable information or protected health info. |
-| `otel.instrumentation.jdbc.experimental.transaction.enabled` | Boolean | `false` | Enables experimental instrumentation to create spans for COMMIT and ROLLBACK operations.                                                                                                                                                                                      |
+| System property                                                   | Type    | Default | Description                                                                                                                                                                                                                                                                   |
+|-------------------------------------------------------------------|---------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `otel.instrumentation.jdbc.statement-sanitizer.enabled`           | Boolean | `true`  | Enables the DB statement sanitization.                                                                                                                                                                                                                                        |
+| `otel.instrumentation.jdbc.experimental.capture-query-parameters` | Boolean | `false` | Enable the capture of query parameters as span attributes. Enabling this option disables the statement sanitization. <p>WARNING: captured query parameters may contain sensitive information such as passwords, personally identifiable information or protected health info. |
+| `otel.instrumentation.jdbc.experimental.transaction.enabled`      | Boolean | `false` | Enables experimental instrumentation to create spans for COMMIT and ROLLBACK operations.                                                                                                                                                                                      |
diff --git a/instrumentation/jdbc/javaagent/build.gradle.kts b/instrumentation/jdbc/javaagent/build.gradle.kts
@@ -91,7 +91,7 @@ tasks {
     filter {
       includeTestsMatching("PreparedStatementParametersTest")
     }
-    jvmArgs("-Dotel.instrumentation.jdbc.capture-query-parameters=true")
+    jvmArgs("-Dotel.instrumentation.jdbc.experimental.capture-query-parameters=true")
   }
 
   check {
diff --git a/instrumentation/jdbc/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jdbc/JdbcSingletons.java b/instrumentation/jdbc/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jdbc/JdbcSingletons.java
@@ -35,7 +35,7 @@ public final class JdbcSingletons {
 
     CAPTURE_QUERY_PARAMETERS =
         AgentInstrumentationConfig.get()
-            .getBoolean("otel.instrumentation.jdbc.capture-query-parameters", false);
+            .getBoolean("otel.instrumentation.jdbc.experimental.capture-query-parameters", false);
 
     STATEMENT_INSTRUMENTER =
         JdbcInstrumenterFactory.createStatementInstrumenter(
diff --git a/instrumentation/jdbc/library/src/main/java/io/opentelemetry/instrumentation/jdbc/internal/JdbcInstrumenterFactory.java b/instrumentation/jdbc/library/src/main/java/io/opentelemetry/instrumentation/jdbc/internal/JdbcInstrumenterFactory.java
@@ -34,7 +34,7 @@ public final class JdbcInstrumenterFactory {
 
   public static boolean captureQueryParameters() {
     return ConfigPropertiesUtil.getBoolean(
-        "otel.instrumentation.jdbc.capture-query-parameters", false);
+        "otel.instrumentation.jdbc.experimental.capture-query-parameters", false);
   }
 
   public static Instrumenter<DbRequest, Void> createStatementInstrumenter(
diff --git a/instrumentation/jdbc/metadata.yaml b/instrumentation/jdbc/metadata.yaml
@@ -23,7 +23,7 @@ configurations:
     description: Used to specify a mapping from host names or IP addresses to peer services.
     type: map
     default: ""
-  - name: otel.instrumentation.jdbc.capture-query-parameters
+  - name: otel.instrumentation.jdbc.experimental.capture-query-parameters
     description: >
       Sets whether the query parameters should be captured as span attributes named
       <code>db.query.parameter.&lt;key&gt;</code>. Enabling this option disables the statement
diff --git a/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/jdbc/DataSourcePostProcessor.java b/instrumentation/spring/spring-boot-autoconfigure/src/main/java/io/opentelemetry/instrumentation/spring/autoconfigure/internal/instrumentation/jdbc/DataSourcePostProcessor.java
@@ -58,7 +58,8 @@ public Object postProcessAfterInitialization(Object bean, String beanName) {
           .setCaptureQueryParameters(
               configPropertiesProvider
                   .getObject()
-                  .getBoolean("otel.instrumentation.jdbc.capture-query-parameters", false))
+                  .getBoolean(
+                      "otel.instrumentation.jdbc.experimental.capture-query-parameters", false))
           .setTransactionInstrumenterEnabled(
               configPropertiesProvider
                   .getObject()
diff --git a/instrumentation/spring/spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json b/instrumentation/spring/spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json
@@ -352,7 +352,7 @@
       "defaultValue": true
     },
     {
-      "name": "otel.instrumentation.jdbc.capture-query-parameters",
+      "name": "otel.instrumentation.jdbc.experimental.capture-query-parameters",
       "type": "java.lang.Boolean",
       "description": "Sets whether the query parameters should be captured as span attributes named <code>db.query.parameter.&lt;key&gt;</code>. Enabling this option disables the statement sanitization.<p>WARNING: captured query parameters may contain sensitive information such as passwords, personally identifiable information or protected health info.",
       "defaultValue": false

Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,7 @@ tasks {`
`91`	`91`	`filter {`
`92`	`92`	`includeTestsMatching("PreparedStatementParametersTest")`
`93`	`93`	`}`
`94`		`- jvmArgs("-Dotel.instrumentation.jdbc.capture-query-parameters=true")`
	`94`	`+ jvmArgs("-Dotel.instrumentation.jdbc.experimental.capture-query-parameters=true")`
`95`	`95`	`}`
`96`	`96`
`97`	`97`	`check {`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public final class JdbcInstrumenterFactory {`
`34`	`34`
`35`	`35`	`public static boolean captureQueryParameters() {`
`36`	`36`	`return ConfigPropertiesUtil.getBoolean(`
`37`		`- "otel.instrumentation.jdbc.capture-query-parameters", false);`
	`37`	`+ "otel.instrumentation.jdbc.experimental.capture-query-parameters", false);`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`public static Instrumenter<DbRequest, Void> createStatementInstrumenter(`
Original file line number	Diff line number	Diff line change
`@@ -352,7 +352,7 @@`
`352`	`352`	`"defaultValue": true`
`353`	`353`	`},`
`354`	`354`	`{`
`355`		`- "name": "otel.instrumentation.jdbc.capture-query-parameters",`
	`355`	`+ "name": "otel.instrumentation.jdbc.experimental.capture-query-parameters",`
`356`	`356`	`"type": "java.lang.Boolean",`
`357`	`357`	`"description": "Sets whether the query parameters should be captured as span attributes named <code>db.query.parameter.<key></code>. Enabling this option disables the statement sanitization.<p>WARNING: captured query parameters may contain sensitive information such as passwords, personally identifiable information or protected health info.",`
`358`	`358`	`"defaultValue": false`