Skip to content

Mark capture-query-parameters as experimental #13850

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 4 commits into from
May 15, 2025
Merged

Mark capture-query-parameters as experimental #13850

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3ed5965
Mark capture-query-parameters as experimental
trask May 14, 2025
485d80e
format
trask May 14, 2025
c482163
spotless
trask May 14, 2025
be5bbb4
Merge branch 'main' into query-parameters-experimental
laurit May 15, 2025
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: 5 additions & 5 deletions instrumentation/jdbc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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. |
2 changes: 1 addition & 1 deletion instrumentation/jdbc/javaagent/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
2 changes: 1 addition & 1 deletion ...vaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/jdbc/JdbcSingletons.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
2 changes: 1 addition & 1 deletion ...src/main/java/io/opentelemetry/instrumentation/jdbc/internal/JdbcInstrumenterFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
2 changes: 1 addition & 1 deletion instrumentation/jdbc/metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,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
Expand Down
3 changes: 2 additions & 1 deletion ...mentation/spring/autoconfigure/internal/instrumentation/jdbc/DataSourcePostProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down
2 changes: 1 addition & 1 deletion ...t-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading