Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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: 9 additions & 1 deletion docs/instrumentation-list.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5200,6 +5200,7 @@ libraries:
- name: jdbc
description: |
The JDBC instrumentation provides database client spans and metrics. Each call produces a span named after the SQL verb, enriched with standard DB client attributes (system, database, operation, sanitized statement, peer address) and error details if an exception occurs.
The instrumentation unwraps pooled connections (via java.sql.Wrapper) to cache database metadata against the underlying physical connection. Without proper unwrapping support, caching is limited to the wrapper instance, which typically changes each time a connection is retrieved from the pool. This can result in repeated metadata extraction, potentially causing performance degradation.
There is also a "jdbc-datasource" instrumentation that creates spans for datasource connections, but is disabled by default due to the volume of telemetry produced.
library_link: https://docs.oracle.com/javase/8/docs/api/java/sql/package-summary.html
source_path: instrumentation/jdbc
Expand Down Expand Up @@ -5536,6 +5537,13 @@ libraries:
Enables experimental receive telemetry, which will cause consumers to start a new trace, with only a span link connecting it to the producer trace.
type: boolean
default: false
- name: kafka-connect-2.6
source_path: instrumentation/kafka/kafka-connect-2.6
scope:
name: io.opentelemetry.kafka-connect-2.6
target_versions:
javaagent:
- org.apache.kafka:connect-api:[2.6.0,)
- name: kafka-streams-0.11
library_link: https://kafka.apache.org/documentation/streams/
source_path: instrumentation/kafka/kafka-streams-0.11
Expand Down Expand Up @@ -7663,9 +7671,9 @@ libraries:
- org.springframework.security:spring-security-config:[6.0.0,]
library:
- io.projectreactor:reactor-core:3.5.0
- jakarta.servlet:jakarta.servlet-api:[6.0.0,6.1.0)
- org.springframework.security:spring-security-config:6.0.0
- org.springframework:spring-web:6.0.0
- jakarta.servlet:jakarta.servlet-api:6.0.0
- org.springframework.security:spring-security-web:6.0.0
configurations:
- name: otel.instrumentation.common.enduser.id.enabled
Expand Down
9 changes: 9 additions & 0 deletions instrumentation/jdbc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,12 @@
| `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. |
| `otel.instrumentation.jdbc.experimental.sqlcommenter.enabled` | Boolean | `false` | Enables augmenting queries with a comment containing the tracing information. See [sqlcommenter](https://google.github.io/sqlcommenter/) for more info. WARNING: augmenting queries with tracing context will make query texts unique, which may have adverse impact on database performance. Consult with database experts before enabling. |

## Connection Pool Unwrapping

The instrumentation unwraps pooled connections (via java.sql.Wrapper) to cache database metadata
against the underlying physical connection. Most connection pools support this by default.

In the case that a connection pool doesn't support this, caching is limited
to the wrapper instance, which typically changes each time a connection is retrieved from the pool.
This can result in repeated metadata extraction, potentially causing performance degradation.
7 changes: 6 additions & 1 deletion instrumentation/jdbc/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,12 @@ description: >
The JDBC instrumentation provides database client spans and metrics. Each call produces a span
named after the SQL verb, enriched with standard DB client attributes (system, database,
operation, sanitized statement, peer address) and error details if an exception occurs.


The instrumentation unwraps pooled connections (via java.sql.Wrapper) to cache database metadata
against the underlying physical connection. Without proper unwrapping support, caching is limited
to the wrapper instance, which typically changes each time a connection is retrieved from the pool.
This can result in repeated metadata extraction, potentially causing performance degradation.

There is also a "jdbc-datasource" instrumentation that creates spans for datasource connections,
but is disabled by default due to the volume of telemetry produced.
library_link: https://docs.oracle.com/javase/8/docs/api/java/sql/package-summary.html
Expand Down
Loading