Supported Java libraries and frameworks
Validated libraries and frameworks
The following libraries and frameworks are supported by Observe APM and work with all Observe APM features.
Database Client
Observe supports the following Java database client libraries and services for APM instrumentation:
| Library name | Supported versions | Trace Explorer | Catalog | Service Inspector | RED Metrics | Database Statements | Service Maps |
|---|---|---|---|---|---|---|---|
| JDBC | Java 8+ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| MongoDB Driver | >= 3.1 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ 1️⃣ |
1️⃣ Service maps are limited due to a context propagation issue in MongoDB drivers.
ORM
Observe supports the following Java ORM libraries and services for APM instrumentation:
| Library name | Supported versions | Trace Explorer | Catalog | Service Inspector | RED Metrics | Database Statements | Service Maps |
|---|---|---|---|---|---|---|---|
| Hibernate | >= 3.3 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
Web / HTTP Server
Observe supports the following Java HTTP server libraries and services for APM instrumentation:
| Library name | Supported versions | Trace Explorer | Catalog | Service Inspector | RED Metrics | Deployments | Service Maps | Error & Exception Tracking |
|---|---|---|---|---|---|---|---|---|
| Dropwizard | >= 0.7 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Netty | >= 3.8 | ✅ 1️⃣ | ✅ | ✅ 1️⃣ | ✅ | ✅ | ✅ | |
| Micronaut | >= 3.0 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Quarkus | >= 2.16.7 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Servlet | >= 2.2 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Spring Web MVC | >= 3.1 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Spring WebFlux | >= 5.3 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Vert.x | >= 3.0 | ✅ 1️⃣ | ✅ | ✅ | ✅ 1️⃣ | ✅ | ✅ | ✅ |
1️⃣ Span names may not work correctly with Netty. Since Vert.x is built atop Netty, you many encounter similar problems with Vert.x applications.
Other libraries and frameworks supported by Observe APM
The libraries and frameworks in this section are supported by OTel but may not work seamlessly with Observe APM features.
Cache Client
Cache client libraries may
| Library name | Supported versions | Trace Explorer |
|---|---|---|
| Jedis (Redis) | >= 1.4 | ✅ |
| Lettuce (Redis) | >= 4.0 | ✅ |
Cloud SDK
Library name | Supported versions | Trace Explorer |
|---|---|---|
AWS SDK |
| ✅ |
Connection Pool
| Library name | Supported versions | Trace Explorer |
|---|---|---|
| HikariCP | >= 3.0 | ✅ |
Database / Cache
| Library name | Supported versions | Trace Explorer |
|---|---|---|
| Redisson | >= 3.0 | ✅ |
Database Client
Observe supports the following Java database client libraries and services for APM instrumentation:
| Library name | Supported versions | Trace Explorer |
|---|---|---|
| Cassandra Driver | >= 3.0 | ✅ |
| Elasticsearch REST Client | >= 5.0 | ✅ |
| R2DBC | >= 1.0 | ✅ |
GenAI
| Library name | Supported versions | Trace Explorer |
|---|---|---|
| OpenAI Java SDK | >= 1.1 | ✅ |
HTTP Client
| Library name | Supported versions | Trace Explorer |
|---|---|---|
| Apache HTTP Client | >= 2.0 | ✅ |
| Java HTTP Client | Java 11+ | ✅ |
| OkHttp | >= 2.2 | ✅ |
| Spring RestTemplate | >= 3.1 | ✅ |
Messaging
| Library name | Supported versions | Trace Explorer |
|---|---|---|
| Apache Kafka | >= 0.11 | ✅ |
| Apache Pulsar | >= 2.8 | ✅ |
| JMS | >= 1.1 | ✅ |
| RabbitMQ Client | >= 2.7 | ✅ |
GraphQL
Observe supports the following Java GraphQL libraries and services for APM instrumentation:
| Library name | Supported versions | Trace Explorer |
|---|---|---|
| GraphQL Java | >= 12.0 | ✅ |
Web / HTTP Server
| Library name | Supported versions | Trace Explorer |
|---|---|---|
| JAX-RS | >= 0.5 | ✅ |
| Ktor | >= 1.0 | ✅ |
Web / RPC
Observe supports the following Java Web/RPC libraries and services for APM instrumentation:
| Library name | Supported versions | Trace Explorer |
|---|---|---|
| gRPC | >= 1.6 | ✅ |
Updated 1 day ago