opentelemetry-java-instrume.../instrumentation/oracle-ucp-11.2/library/README.md

47 lines
1.4 KiB
Markdown

# Library Instrumentation for Oracle UCP version 11.2 and higher
Provides OpenTelemetry instrumentation for [Oracle UCP](https://docs.oracle.com/database/121/JJUCP/).
## Quickstart
### Add these dependencies to your project
Replace `OPENTELEMETRY_VERSION` with the [latest
release](https://search.maven.org/search?q=g:io.opentelemetry.instrumentation%20AND%20a:opentelemetry-oracle-ucp-11.2).
For Maven, add to your `pom.xml` dependencies:
```xml
<dependencies>
<dependency>
<groupId>io.opentelemetry.instrumentation</groupId>
<artifactId>opentelemetry-oracle-ucp-11.2</artifactId>
<version>OPENTELEMETRY_VERSION</version>
</dependency>
</dependencies>
```
For Gradle, add to your dependencies:
```groovy
implementation("io.opentelemetry.instrumentation:opentelemetry-oracle-ucp-11.2:OPENTELEMETRY_VERSION")
```
### Usage
The instrumentation library allows registering `UniversalConnectionPool` instances for collecting
OpenTelemetry-based metrics.
```java
OracleUcpTelemetry oracleUcpTelemetry;
void configure(OpenTelemetry openTelemetry, UniversalConnectionPool universalConnectionPool) {
oracleUcpTelemetry = OracleUcpTelemetry.create(openTelemetry);
oracleUcpTelemetry.registerMetrics(universalConnectionPool);
}
void destroy(UniversalConnectionPool universalConnectionPool) {
oracleUcpTelemetry.unregisterMetrics(universalConnectionPool);
}
```