兼容性列表

文档来源说明

本文档内容来源于 OpenTelemetry Java Instrumentation 官方文档

最后更新日期： 2025 年 1 月 22 日

支持的库、框架、应用服务器和 JVM

OTel Java Agent 自动插桩并集成了大量的库、框架和应用服务器，开箱即用。

目录

• 库和框架
• 应用服务器
• JVM 和操作系统
• 禁用的插桩

库和框架

这些是支持的库和框架：

库/框架	自动插桩版本	独立库插桩 [1]	语义约定
Akka Actors	2.3+	N/A	上下文传播
Akka HTTP	10.0+	N/A	HTTP 客户端 Spans, HTTP 客户端指标, HTTP 服务端 Spans, HTTP 服务端指标, 提供 http.route [2]
Alibaba Druid	1.0+	opentelemetry-alibaba-druid-1.0	数据库连接池指标
Apache Axis2	1.6+	N/A	提供 http.route [2], 控制器 Spans [3]
Apache Camel	2.20+ (不包括 3.0+)	N/A	取决于使用的组件
Apache CXF JAX-RS	3.2+ (不包括 4.0+)	N/A	Provides http.route [2], Controller Spans [3]
Apache CXF JAX-WS	3.0+ (不包括 4.0+)	N/A	Provides http.route [2], Controller Spans [3]
Apache DBCP	2.0+	opentelemetry-apache-dbcp-2.0	数据库连接池指标
Apache Dubbo	2.7+	opentelemetry-apache-dubbo-2.7	RPC 客户端 Spans, RPC 服务端 Spans
Apache HttpAsyncClient	4.1+	N/A	HTTP 客户端 Spans, HTTP 客户端指标
Apache HttpClient	2.0+	opentelemetry-apache-httpclient-4.3, opentelemetry-apache-httpclient-5.2	HTTP 客户端 Spans, HTTP 客户端指标
Apache ShenYu	2.4+	N/A	Provides http.route [2]
Apache Kafka Producer/Consumer API	0.11+	opentelemetry-kafka-clients-2.6	消息传递 Spans
Apache Kafka Streams API	0.11+	N/A	消息传递 Spans
Apache MyFaces	1.2+ (不包括 4.0+)	N/A	Provides http.route [2], Controller Spans [3]
Apache Pekko Actors	1.0+	N/A	Context propagation
Apache Pekko HTTP	1.0+	N/A	HTTP 客户端 Spans, HTTP 客户端指标, HTTP 服务端 Spans, HTTP 服务端指标, Provides http.route [2]
Apache Pulsar	2.8+	N/A	消息传递 Spans
Apache RocketMQ gRPC/Protobuf-based Client	5.0+	N/A	消息传递 Spans
Apache RocketMQ Remoting-based Client	4.8+	opentelemetry-rocketmq-client-4.8	消息传递 Spans
Apache Struts	2.3+	N/A	Provides http.route [2], Controller Spans [3]
Apache Tapestry	5.4+	N/A	Provides http.route [2], Controller Spans [3]
Apache Wicket	8.0+	N/A	Provides http.route [2]
Armeria	1.3+	opentelemetry-armeria-1.3	HTTP 客户端 Spans, HTTP 客户端指标, HTTP 服务端 Spans, HTTP 服务端指标
Armeria gRPC	1.14+		RPC 客户端 Spans, RPC 客户端指标, RPC 服务端 Spans, RPC 服务端指标
AsyncHttpClient	1.9+	N/A	HTTP 客户端 Spans, HTTP 客户端指标
AWS Lambda	1.0+	opentelemetry-aws-lambda-core-1.0, opentelemetry-aws-lambda-events-2.2	FaaS 服务端 Spans
AWS SDK	1.11 - 1.12.583, 2.2+	opentelemetry-aws-sdk-1.11, opentelemetry-aws-sdk-1.11-autoconfigure, opentelemetry-aws-sdk-2.2, opentelemetry-aws-sdk-2.2-autoconfigure	消息传递 Spans, 数据库客户端 Spans, 数据库客户端指标 [6], HTTP 客户端 Spans
Azure Core	1.14+	N/A	Context propagation
Cassandra Driver	3.0+	opentelemetry-cassandra-4.4	数据库客户端 Spans, 数据库客户端指标 [6]
Clickhouse Client	0.5+	N/A	数据库客户端 Spans, 数据库客户端指标 [6]
Couchbase Client	2.0 - 2.7.x	N/A	数据库客户端 Spans, 数据库客户端指标 [6]
Couchbase Client	3.1+	N/A	数据库客户端 Spans
c3p0	0.9.2+	opentelemetry-c3p0-0.9	数据库连接池指标
Dropwizard Metrics	4.0+ (默认禁用)	N/A	none
Dropwizard Views	0.7+	N/A	Controller Spans [3]
Eclipse Grizzly	2.3+	N/A	HTTP 服务端 Spans, HTTP 服务端指标
Eclipse Jersey	2.0+	N/A	Provides http.route [2], Controller Spans [3]
Eclipse Jetty HTTP Client	9.2 - 9.4.x, 12.0+	opentelemetry-jetty-httpclient-9.2, opentelemetry-jetty-httpclient-12.0	HTTP 客户端 Spans, HTTP 客户端指标
Eclipse Metro	2.2+	N/A	Provides http.route [2], Controller Spans [3]
Eclipse Mojarra	1.2+ (不包括 4.0+)	N/A	Provides http.route [2], Controller Spans [3]
Elasticsearch API Client	7.16 - 7.17.19, 8.0 - 8.9.+ [4]	N/A	Elasticsearch 客户端 Spans
Elasticsearch REST Client	5.0+	N/A	数据库客户端 Spans, 数据库客户端指标 [6]
Elasticsearch Transport Client	5.0+	N/A	数据库客户端 Spans, 数据库客户端指标 [6]
Finagle	23.11+	N/A	none
Finatra	2.9+	N/A	Provides http.route [2], Controller Spans [3]
Geode Client	1.4+	N/A	数据库客户端 Spans, 数据库客户端指标 [6]
Google HTTP Client	1.19+	N/A	HTTP 客户端 Spans, HTTP 客户端指标
Grails	3.0+	N/A	Provides http.route [2], Controller Spans [3]
GraphQL Java	12.0+	opentelemetry-graphql-java-12.0, opentelemetry-graphql-java-20.0	GraphQL 服务端 Spans
gRPC	1.6+	opentelemetry-grpc-1.6	RPC 客户端 Spans, RPC 客户端指标, RPC 服务端 Spans, RPC 服务端指标
Guava ListenableFuture	10.0+	opentelemetry-guava-10.0	Context propagation
GWT	2.0+	N/A	RPC 服务端 Spans
Hibernate	3.3+	N/A	none
Hibernate Reactive	1.0+	N/A	none
HikariCP	3.0+	opentelemetry-hikaricp-3.0	数据库连接池指标
HttpURLConnection	Java 8+	N/A	HTTP 客户端 Spans, HTTP 客户端指标
Hystrix	1.4+	N/A	none
InfluxDB Client	2.4+	N/A	数据库客户端 Spans, 数据库客户端指标 [6]
Java Executors	Java 8+	N/A	Context propagation
Java Http Client	Java 11+	opentelemetry-java-http-client	HTTP 客户端 Spans, HTTP 客户端指标
java.util.logging	Java 8+	N/A	none
Java Platform	Java 8+	opentelemetry-runtime-telemetry-java8, opentelemetry-runtime-telemetry-java17, opentelemetry-resources	JVM 运行时指标
Javalin	5.0+	N/A	Provides http.route [2]
JAX-RS	0.5+	N/A	Provides http.route [2], Controller Spans [3]
JAX-RS Client	1.1+	N/A	HTTP 客户端 Spans, HTTP 客户端指标
JAX-WS	2.0+ (不包括 3.0+)	N/A	Provides http.route [2], Controller Spans [3]
JBoss Log Manager	1.1+	N/A	none
JDBC	Java 8+	opentelemetry-jdbc	数据库客户端 Spans, 数据库客户端指标 [6]
Jedis	1.4+	N/A	数据库客户端 Spans, 数据库客户端指标 [6]
JMS	1.1+	N/A	消息传递 Spans
Jodd Http	4.2+	N/A	HTTP 客户端 Spans, HTTP 客户端指标
JSP	2.3.x only	N/A	Controller Spans [3]
Kotlin Coroutines	1.0+	N/A	Context propagation
Ktor	1.0+	opentelemetry-ktor-1.0, opentelemetry-ktor-2.0, opentelemetry-ktor-3.0	HTTP 客户端 Spans, HTTP 客户端指标, HTTP 服务端 Spans, HTTP 服务端指标
Kubernetes Client	7.0+	N/A	HTTP 客户端 Spans
Lettuce	4.0+	opentelemetry-lettuce-5.1	数据库客户端 Spans, 数据库客户端指标 [6]
Log4j 1	1.2+	N/A	none
Log4j 2	2.11+	opentelemetry-log4j-appender-2.17, opentelemetry-log4j-context-data-2.17-autoconfigure	none
Logback	1.0+	opentelemetry-logback-appender-1.0, opentelemetry-logback-mdc-1.0	none
Micrometer	1.5+	opentelemetry-micrometer-1.5	none
MongoDB Driver	3.1+	opentelemetry-mongo-3.1	数据库客户端 Spans, 数据库客户端指标 [6]
MyBatis	3.2+	N/A	none
Netty HTTP codec [5]	3.8+	opentelemetry-netty-4.1	HTTP 客户端 Spans, HTTP 客户端指标, HTTP 服务端 Spans, HTTP 服务端指标
OpenSearch Rest Client	1.0+		数据库客户端 Spans, 数据库客户端指标 [6]
OkHttp	2.2+	opentelemetry-okhttp-3.0	HTTP 客户端 Spans, HTTP 客户端指标
Oracle UCP	11.2+	opentelemetry-oracle-ucp-11.2	数据库连接池指标
OSHI	5.3.1+	opentelemetry-oshi	系统指标 (部分支持)
Play MVC	2.4+	N/A	Provides http.route [2], Controller Spans [3]
Play WS	1.0+	N/A	HTTP 客户端 Spans, HTTP 客户端指标
PowerJob	4.0.0+	N/A	none
Quarkus Resteasy Reactive	2.16.7+	N/A	Provides http.route [2]
Quartz	2.0+	opentelemetry-quartz-2.0	none
R2DBC	1.0+	opentelemetry-r2dbc-1.0	数据库客户端 Spans, 数据库客户端指标 [6]
RabbitMQ Client	2.7+	N/A	消息传递 Spans
Ratpack	1.4+	opentelemetry-ratpack-1.7	HTTP 客户端 Spans, HTTP 客户端指标, HTTP 服务端 Spans, HTTP 服务端指标
Reactor	3.1+	opentelemetry-reactor-3.1	Context propagation
Reactor Netty	0.9+	N/A	HTTP 客户端 Spans, HTTP 客户端指标
Rediscala	1.8+	N/A	数据库客户端 Spans, 数据库客户端指标 [6]
Redisson	3.0+	N/A	数据库客户端 Spans, 数据库客户端指标 [6]
RESTEasy	3.0+ (不包括 6.0+)	N/A	Provides http.route [2], Controller Spans [3]
RESTEasy	3.0+ (不包括 6.0+)	N/A	Provides http.route [2], Controller Spans [3]
Restlet	1.0+	opentelemetry-restlet-1.1, opentelemetry-restlet-2.0	HTTP 服务端 Spans, HTTP 服务端指标
RMI	Java 8+		RPC 客户端 Spans, RPC 服务端 Spans
RxJava	1.0+	opentelemetry-rxjava-1.0, opentelemetry-rxjava-2.0, opentelemetry-rxjava-3.0, opentelemetry-rxjava-3.1.1	Context propagation
Scala ForkJoinPool	2.8+	N/A	Context propagation
Servlet	2.2+	N/A	HTTP 服务端 Spans, HTTP 服务端指标
Spark Web Framework	2.3+	N/A	Provides http.route [2]
Spring Batch	3.0+ (不包括 5.0+)	N/A	none
Spring Boot		opentelemetry-spring-boot-resources	none
Spring Cloud AWS	3.0+	N/A	消息传递 Spans
Spring Cloud Gateway	2.0+	N/A	Provides http.route [2]
Spring Core	2.0+	N/A	Context propagation
Spring Data	1.8+	N/A	none
Spring Integration	4.1+ (不包括 6.0+)	opentelemetry-spring-integration-4.1	消息传递 Spans
Spring JMS	2.0+	N/A	消息传递 Spans
Spring Kafka	2.7+	opentelemetry-spring-kafka-2.7	消息传递 Spans
Spring RabbitMQ	1.0+	N/A	消息传递 Spans
Spring RestTemplate	3.1+	opentelemetry-spring-web-3.1	HTTP 客户端 Spans, HTTP 客户端指标
Spring RMI	4.0+	N/A	RPC 客户端 Spans, RPC 服务端 Spans
Spring Scheduling	3.1+	N/A	none
Spring Web MVC	3.1+	opentelemetry-spring-webmvc-5.3, opentelemetry-spring-webmvc-6.0	HTTP 服务端 Spans, HTTP 服务端指标, Provides http.route [2], Controller Spans [3]
Spring Web Services	2.0+ (不包括 4.0+)	N/A	none
Spring WebFlux	5.3+	opentelemetry-spring-webflux-5.3	HTTP 客户端 Spans, HTTP 客户端指标, HTTP 服务端 Spans, HTTP 服务端指标, Provides http.route [2], Controller Spans [3]
Spymemcached	2.12+	N/A	数据库客户端 Spans, 数据库客户端指标 [6]
Tomcat JDBC Pool	8.5+	N/A	数据库连接池指标
Twilio	6.6+ (不包括 8.0+)	N/A	none
Undertow	1.4+	N/A	HTTP 服务端 Spans, HTTP 服务端指标
Vaadin	14.2+	N/A	Provides http.route [2], Controller Spans [3]
Vert.x HttpClient	3.0+	N/A	HTTP 客户端 Spans, HTTP 客户端指标
Vert.x Kafka Client	3.6+	N/A	消息传递 Spans
Vert.x Redis Client	4.0+	N/A	数据库客户端 Spans, 数据库客户端指标 [6]
Vert.x RxJava2	3.5+	N/A	context propagation only
Vert.x SQL Client	4.0+	N/A	数据库客户端 Spans, 数据库客户端指标 [6]
Vert.x Web	3.0+	N/A	Provides http.route [2]
Vibur DBCP	11.0+	opentelemetry-vibur-dbcp-11.0	数据库连接池指标
XXL-JOB	1.9.2+	N/A	none
ZIO	2.0+	N/A	Context propagation

[1] 独立库插桩是指可以在不使用 Java agent 的情况下使用的插桩。

[2] 提供 http.route：为现有的 SERVER span 提供基于路由的 span 名称。如果适用，在现有的 SERVER span 和指标上提供 http.route span 和指标属性。

[3] 控制器 Spans 是捕获控制器和/或视图执行的 INTERNAL spans。参见 禁用控制器和/或视图 spans。

[4] 较新版本的库内置了遥测功能。

[5] 目前不支持捕获 HTTP/2 流量。

[6] 数据库客户端指标适用于选择加入 语义约定稳定性 的用户。

应用服务器

应用服务器	版本	JVM	操作系统
Jetty	9.4.53	OpenJDK 8, 11, 17, 21, 23 OpenJ9 8, 11, 17, 21, 23	ubuntu-latest, windows-latest
Jetty	10.0.19, 11.0.19	OpenJDK 11, 17, 21, 23 OpenJ9 11, 17, 21, 23	ubuntu-latest, windows-latest
Jetty	12.0.6	OpenJDK 17, 21, 23 OpenJ9 17, 21, 23	ubuntu-latest, windows-latest
Open Liberty	20.0.0.12	OpenJDK 8, 11 OpenJ9 8, 11	ubuntu-latest, windows-latest
Open Liberty	21.0.0.12, 22.0.0.12	OpenJDK 8, 11, 17 OpenJ9 8, 11, 17	ubuntu-latest, windows-latest
Open Liberty	23.0.0.12	OpenJDK 8, 11, 17, 20 OpenJ9 8, 11, 17, 20	ubuntu-latest, windows-latest
Payara	5.2020.6, 5.2021.8	OpenJDK 8, 11 OpenJ9 8, 11	ubuntu-latest, windows-latest
Payara	6.2023.12	OpenJDK 11, 17 OpenJ9 11, 17, 21, 23	ubuntu-latest, windows-latest
Tomcat	7.0.109	OpenJDK 8 OpenJ9 8	ubuntu-latest, windows-latest
Tomcat	8.5.98, 9.0.85	OpenJDK 8, 11, 17, 21, 23 OpenJ9 8, 11, 17, 21, 23	ubuntu-latest, windows-latest
Tomcat	10.1.18	OpenJDK 11, 17, 21, 23 OpenJ9 11, 17, 21, 23	ubuntu-latest, windows-latest
TomEE	7.0.9, 7.1.4	OpenJDK 8 OpenJ9 8	ubuntu-latest, windows-latest
TomEE	8.0.16	OpenJDK 8, 11, 17, 21, 23 OpenJ9 8, 11, 17, 21, 23	ubuntu-latest, windows-latest
TomEE	9.1.2	OpenJDK 11, 17, 21, 23 OpenJ9 11, 17, 21, 23	ubuntu-latest, windows-latest
Websphere Traditional	8.5.5.22, 9.0.5.14	IBM JDK 8	Red Hat Enterprise Linux 8.4
WildFly	13.0.0.Final	OpenJDK 8 OpenJ9 8	ubuntu-latest, windows-latest
WildFly	17.0.1.Final, 21.0.0.Final	OpenJDK 8, 11, 17, 21 OpenJ9 8, 11, 17, 21	ubuntu-latest, windows-latest
WildFly	28.0.1.Final, 29.0.1.Final, 30.0.1.Final	OpenJDK 11, 17, 21, 23 OpenJ9 11, 17, 21, 23	ubuntu-latest, windows-latest

tip

应用服务器详细配置请参考这里

JVM 和操作系统

JVM	版本	操作系统
OpenJDK (Eclipse Temurin)	8, 11, 17, 21, 23	ubuntu-latest
OpenJ9 (IBM Semeru Runtimes)	8, 11, 17, 21, 23	ubuntu-latest

禁用的插桩

有些插桩可能会产生太多 Span 并使调用链非常繁杂。

因此，以下插桩默认情况下是禁用的：

插桩名称	说明
jdbc-datasource	每次调用 java.sql.DataSource#getConnection 方法时都会创建 Span。
dropwizard-metrics	可能会创建非常低质量的指标数据，因为 Dropwizard 指标 API 缺乏标签/属性支持。

要启用它们，请添加 otel.instrumentation.<name>.enabled 系统属性：

• -Dotel.instrumentation.jdbc-datasource.enabled=true
• -Dotel.instrumentation.dropwizard-metrics.enabled=true