Supported Java components and frameworks

更新时间:
复制 MD 格式

Application Real-Time Monitoring Service (ARMS) provides automatic instrumentation for Java applications. The following sections list the supported JDK versions, JDK distributions, and third-party frameworks and components for each ARMS agent series (5.x, 4.x, and 3.x). Refer to the section that corresponds to your deployed agent version.

Supported JDK versions

Upgrade the ARMS agent

Enable continuous profiling

Enable continuous profiling

Enable continuous profiling

[Product changes] ARMS Application Monitoring no longer supports Java 7

VersionDescription
JDK 25Supported by agent version 4.7.x and later.
JDK 21To use JDK 21, you must upgrade the ARMS agent to version 3.1.4 or later.
JDK 17To use advanced ARMS features such as continuous profiling, use JDK 17.0.9 or later. For more information, see Enable continuous profiling.
JDK 11To use advanced ARMS features such as continuous profiling, use JDK 11.0.17 or later. For more information, see Enable continuous profiling.
JDK 1.8For deployments in Kubernetes clusters, use JDK 8u212 or later. To use advanced ARMS features such as continuous profiling, use JDK 8u352 or later. For more information, see Enable continuous profiling.
JDK 1.7ARMS Application Monitoring has ended support for Java 7 in agent versions 3.0.x and later. If you are still using Java 7, upgrade your Java version. For more information, see [Product Change] ARMS Application Monitoring Ends Support for Java 7.

Supported JDK distributions

  • OpenJDK (Recommended)

  • Alibaba Dragonwell (Recommended)

  • Temurin

  • AdoptOpenJDK

  • Amazon Corretto

  • Azul

  • Java HotSpot VM

Avoid Eclipse OpenJ9 because of compatibility issues with ARMS.

5.x agent: Supported frameworks and components

This compatibility information applies to the latest 5.x agent.

For JDBC components, the agent monitors only the create, read, update, and delete (CRUD) operations performed via the JDBC specification, even if a component supports other database access methods.

TypeComponentSupported versionDescription
LLM client/frameworkAgentScope1.0.0+
OpenAI Java SDK1.1.0+, 2.X+, 3.X+Collects metrics and spans for ChatCompletion calls. Collects metrics and spans for Completion calls. Collects metrics and spans for Embedding calls.
Spring AI1.X+Collects metrics and spans for OpenAI ChatModel calls. Collects metrics and spans for Default ChatClient calls. Collects metrics and spans for Default ToolManager calls.
Spring AI Alibaba1.0.0.3+Collects metrics and spans for DashScope ChatModel calls.
Agent protocolA2A (Agent-to-Agent) Java SDK0.3.3+Collects metrics and spans for Agent-to-Agent client and server calls.
MCP Java SDK0.17.0+Collects metrics and spans for Model Context Protocol client and server calls.
Web containerCXF3.0+Collects RED metrics and spans for CXF.
Restlet1.1.0+Collects RED metrics and spans for Restlet.
Tomcat7.X to 10.XCollects RED metrics and spans for HTTP. Collects Tomcat thread pool metrics.
Jetty8.X to 11.XCollects RED metrics and spans for HTTP. Collects Jetty thread pool metrics.
Play Framework2.4+Collects RED metrics and spans for HTTP.
WebLogic10.3.0 to 12.2.XCollects RED metrics and spans for HTTP.
Undertow1.4.0+Collects RED metrics and spans for HTTP. Collects Undertow thread pool metrics.
Vert.x3.0.0+Collects RED metrics and spans for HTTP.
Webflux5.0.0.RELEASE+Collects RED metrics and spans for HTTP.
Spring Cloud Gateway2.0.0.RELEASE+Collects RED metrics and spans for HTTP.
JFinal3.6+Collects RED metrics and spans for HTTP.
WebSphere9.0+Collects RED metrics and spans for HTTP.
HTTP clientApache HTTP Client2.0 to 5.3.1Collects RED metrics and spans for HTTP.
Google HTTP Client1.19.0+Collects RED metrics and spans for HTTP.
Java HTTP ClientJDK 11+Collects RED metrics and spans for HTTP.
OkHttp2.2+Collects RED metrics and spans for HTTP.
Async HTTP Client1.8 to 2.12.3Collects RED metrics and spans for HTTP.
RPC frameworkAlibaba Dubbo2.5.10 to 2.6.12Collects RED metrics and spans for Dubbo.
Apache Dubbo2.7.0+Collects RED metrics and spans for Dubbo.
HSF2.2 to 3.0Collects RED metrics and spans for HSF.
gRPC1.6.0+Collects RED metrics and spans for gRPC.
Motan0.3.0+Collects RED metrics and spans for Motan.
SofaRPC5.4.0+Collects RED metrics and spans for SofaRPC.
JDBCOceanBase2.4.0+Collects metrics and spans for database calls.
MySQL5.1.1+Collects metrics and spans for database calls.
PostgreSQL42.0.0+Collects metrics and spans for database calls.
SQL Server6.2.0.jre7+Collects metrics and spans for database calls.
MariaDB1.5.2+Collects metrics and spans for database calls.
Oracle12.2.0.1+Collects metrics and spans for database calls.
PolarDB1.0.0+Collects metrics and spans for database calls.
ClickHouse0.1.28+Collects metrics and spans for database calls.
NoSQLHBase2.0 to 3.0Collects metrics and spans for NoSQL calls.
Jedis1.4+Collects metrics and spans for NoSQL calls.
Lettuce4.0.Final+Collects metrics and spans for NoSQL calls. Collects Lettuce connection pool metrics. Collects NoSQL response size metrics.
Redisson3.0 to 3.25.2Collects metrics and spans for NoSQL calls.
Memcached2.12.0 to 2.12.3Collects metrics and spans for NoSQL calls.
MongoDB3.1+Collects metrics and spans for NoSQL calls.
Elasticsearch5.0+Collects metrics and spans for NoSQL calls. Monitors Elasticsearch access only over HTTP; access over TCP is not supported.
InfluxDB2.7 to 2.23Collects metrics and spans for NoSQL calls.
Cassandra3.0+Collects metrics and spans for NoSQL calls.
MessagingEclipse Paho Client MQTTv31.0.2+Collects RED metrics and spans for consumer calls.
RocketMQ Java Client4.4.0, 4.5.1+, 5.X+Collects RED metrics and spans for consumer and producer calls. Collects message latency metrics.
RocketMQ Java Client V55.0.0+Collects RED metrics and spans for consumer and producer calls. Collects message latency metrics.
Alibaba Cloud MNS SDK1.3.0+Collects RED metrics and spans for producer and consumer calls.
ApsaraMQ for RocketMQ1.7.0.Final+, 2.0.0.Final+Collects RED metrics and spans for consumer and producer calls. Collects message latency metrics.
Qpid JMS Client0.49.0+Collects RED metrics and spans for consumer calls.
RabbitMQ4.X+Collects RED metrics and spans for consumer and producer calls. Collects spans for all channel and command operations.
Kafka0.11.0.0+, 1.X+, 2.X+, 3.X+Collects RED metrics and spans for consumer and producer calls.
Spring Kafka2.7.0+Collects RED metrics and spans for consumer (Message Listener) calls. To prevent duplicate data, the probe disables the underlying Kafka instrumentation when Spring Kafka instrumentation is active.
Scheduled taskXXLJob2.0.2+Collects RED metrics and spans for scheduled task calls.
SchedulerX 2.01.2.1 to 1.11.6Collects RED metrics and spans for scheduled task calls.
Spring Scheduled3.1.0.RELEASE+Collects RED metrics and spans for scheduled task calls.
ElasticJob3.0.0 to 3.0.4Collects RED metrics and spans for scheduled task calls.
Logging frameworkLog4j1.2+Injects the EagleEye-TraceID into the log context. Collects log count metrics.
Log4j22.0+Injects the EagleEye-TraceID into the log context. Collects log count metrics.
Logback1.0.0 to 1.2.3Injects the EagleEye-TraceID into the log context. Collects log count metrics.
Database connection poolDruid1.0.25+Collects connection pool metrics. Collects spans for connection acquisition operations.
HikariCP3.0.0+Collects connection pool metrics.
C3P00.9.5+Collects connection pool metrics.
MyBatis3.1.0+Collects spans for MyBatis operations.
DBCP2+Collects connection pool metrics.
OtherSpring4.1.0.RELEASE+Instruments Spring's request dispatching code to determine the route for an HTTP request.
Spring Bean4.1.0.RELEASE+Instruments every public method in Spring-managed beans and generates spans.

4.x agent: Supported frameworks and components

The latest 4.x agent supports the following frameworks and components.

For JDBC components, the agent monitors only CRUD (create, read, update, and delete) operations that use the JDBC specification, even if a component supports other database access methods.

TypeComponentSupported versionDescription
LLM client/frameworkAgentScope1.0.0+
OpenAI Java SDK1.1.0+, 2.X+, 3.X+Collects metrics and spans for ChatCompletion calls. Collects metrics and spans for Completion calls. Collects metrics and spans for Embedding calls.
Spring AI1.X+Collects metrics and spans for OpenAI ChatModel calls. Collects metrics and spans for Default ChatClient calls. Collects metrics and spans for Default ToolManager calls.
Spring AI Alibaba1.0.0.3+Collects metrics and spans for DashScope ChatModel calls.
Agent protocolA2A (Agent-to-Agent) Java SDK0.3.3+Collects metrics and spans for Agent-to-Agent client and server calls.
MCP Java SDK0.17.0+Collects metrics and spans for Model Context Protocol client and server calls.
Web containerCXF3.0+Collects RED metrics and spans for CXF.
Restlet1.1.0+Collects RED metrics and spans for Restlet.
Tomcat7.X to 10.XCollects RED metrics and spans for HTTP requests. Collects Tomcat thread pool metrics.
Jetty8.X to 11.XCollects RED metrics and spans for HTTP requests. Collects Jetty thread pool metrics.
Play Framework2.4+Collects RED metrics and spans for HTTP requests.
WebLogic10.3.0 to 12.2.XCollects RED metrics and spans for HTTP requests.
Undertow1.4.0+Collects RED metrics and spans for HTTP requests. Collects Undertow thread pool metrics.
Vert.x3.0.0+Collects RED metrics and spans for HTTP requests.
Webflux5.0.0.RELEASE+Collects RED metrics and spans for HTTP requests.
Spring Cloud Gateway2.0.0.RELEASE+Collects RED metrics and spans for HTTP requests.
JFinal3.6+Collects RED metrics and spans for HTTP requests.
WebSphere9.0+Collects RED metrics and spans for HTTP requests.
HTTP clientApache HTTP Client2.0 to 5.3.1Collects RED metrics and spans for HTTP requests.
Google HTTP Client1.19.0+Collects RED metrics and spans for HTTP requests.
Java HTTP ClientJDK 11+Collects RED metrics and spans for HTTP requests.
OkHttp2.2+Collects RED metrics and spans for HTTP requests.
Async HTTP Client1.8 to 2.12.3Collects RED metrics and spans for HTTP requests.
RPC frameworkAlibaba Dubbo2.5.10 to 2.6.12Collects RED metrics and spans for Dubbo.
Apache Dubbo2.7.0+Collects RED metrics and spans for Dubbo.
HSF2.2 to 3.0Collects RED metrics and spans for HSF.
gRPC1.6.0+Collects RED metrics and spans for gRPC.
Motan0.3.0+Collects RED metrics and spans for Motan.
JDBCOceanBase2.4.0+Collects metrics and spans for database calls.
MySQL5.1.1+Collects metrics and spans for database calls.
PostgreSQL42.0.0+Collects metrics and spans for database calls.
SQL Server6.2.0.jre7+Collects metrics and spans for database calls.
MariaDB1.5.2+Collects metrics and spans for database calls.
Oracle12.2.0.1+Collects metrics and spans for database calls.
PolarDB1.0.0+Collects metrics and spans for database calls.
ClickHouse0.1.28+Collects metrics and spans for database calls.
NoSQLHBase2.0 to 3.0Collects metrics and spans for NoSQL calls.
Jedis1.4+Collects metrics and spans for NoSQL calls.
Lettuce4.0.Final+Collects metrics and spans for NoSQL calls. Collects Lettuce connection pool metrics. Collects NoSQL response size metrics.
Redisson3.0 to 3.25.2Collects metrics and spans for NoSQL calls.
Memcached2.12.0 to 2.12.3Collects metrics and spans for NoSQL calls.
MongoDB3.1+Collects metrics and spans for NoSQL calls.
Elasticsearch5.0+Collects metrics and spans for NoSQL calls. Data collection is supported for clients that access Elasticsearch servers over HTTP. Access over TCP is not supported.
InfluxDB2.7 to 2.23Collects metrics and spans for NoSQL calls.
Cassandra3.0+Collects metrics and spans for NoSQL calls.
MessagingEclipse Paho Client MQTTv31.0.2+Collects RED metrics and spans for consumer calls.
RocketMQ Java Client4.4.0, 4.5.1+, 5.X+Collects RED metrics and spans for producer and consumer calls. Collects message latency metrics.
RocketMQ Java Client V55.0.0+Collects RED metrics and spans for producer and consumer calls. Collects message latency metrics.
Alibaba Cloud MNS SDK1.3.0+Collects RED metrics and spans for producer and consumer calls.
ApsaraMQ for RocketMQ1.7.0.Final+, 2.0.0.Final+Collects RED metrics and spans for producer and consumer calls. Collects message latency metrics.
Qpid JMS Client0.49.0+Collects RED metrics and spans for consumer calls.
RabbitMQ4.X+Collects RED metrics and spans for producer and consumer calls. Collects spans for all channel and command operations.
Kafka0.11.0.0+, 1.X+, 2.X+, 3.X+Collects RED metrics and spans for producer and consumer calls.
Spring Kafka2.7.0+Collects RED metrics and spans for consumer (message listener) calls. To prevent duplicate reporting, the underlying Kafka instrumentation is disabled when the Spring Kafka instrumentation is active.
Scheduled taskXXLJob2.0.2+Collects RED metrics and spans for scheduled task calls.
SchedulerX1.2.1 to 1.11.6Collects RED metrics and spans for scheduled task calls.
Spring Scheduled3.1.0.RELEASE+Collects RED metrics and spans for scheduled task calls.
ElasticJob3.0.0 to 3.0.4Collects RED metrics and spans for scheduled task calls.
Logging frameworkLog4j1.2+Injects the EagleEye-TraceID into the log context. Collects metrics on the number of logs the framework generates.
Log4j22.0+Injects the EagleEye-TraceID into the log context. Collects metrics on the number of logs the framework generates.
Logback1.0.0 to 1.2.3Injects the EagleEye-TraceID into the log context. Collects metrics on the number of logs the framework generates.
Database connection poolDruid1.0.25+Collects connection pool metrics. Collects spans for connection acquisition operations.
HikariCP3.0.0+Collects connection pool metrics.
C3P00.9.5+Collects connection pool metrics.
MyBatis3.1.0+Collects spans for MyBatis operations.
DBCP2+Collects connection pool metrics.
OtherSpring4.1.0.RELEASE+Instruments Spring's request dispatching code to get an HTTP request's route.
Spring Bean4.1.0.RELEASE+Instruments each public method in a Spring-managed bean to create a span.

3.x agent: Supported frameworks and components

The following frameworks and components are supported by the latest 3.x agent.

TypeComponentSupported version
Web containerTomcat7.X to 10.X
Jetty8.1.X to 11.0.X
Play Framework2.2.X to 2.8.X
WebLogic10.3.X to 12.2.X
Undertow1.4.X to 2.2.X
Vert.x3.3.X+
Reactor Netty0.7.X+
Webflux5.0.X+
HTTP clientApache HttpClient3.0.X+
Google HTTP Client1.19.X+
OkHttp/OkHttp32.1.X to 4.11.X
Spring Web (RestTemplate)
AsyncHttpClient2.0.X to 2.12.X
SpringSpring MVC3.0.5.RELEASE+
Spring Scheduled3.1.0.RELEASE+
Spring CloudHystrix1.0.X to 1.5.X
Feign9.0.X to 12.4.X
Spring Webflux5.0.X to 6.0.X
Spring Cloud Gateway2.1.X to 4.0.X
RPC frameworkDubbo2.4.X+
Ali-HSF (High Speed Framework)2.2.X+
gRPC0.7.X to 1.56.X
Thrift0.1.X to 0.18.X
JDBCPolarDB1.1.2+ (Requires agent 4.X or later)
MySQL Connector5.0.X+
PostgreSQL JDBC Driver42.1.X+
Microsoft JDBC Driver for SQL Server6.4.X to 12.2.X
MariaDB Java Client1.5.X to 3.1.X
Oracle ojdbc7, 8, 10, 14
Sharding-jdbc4.0.X to 4.1.X
Druid1.0.X+
Hikari-CP2.3.X+
MyBatis3.1.X to 3.5.X
MyBatisPlus1.0.X to 1.7.X
NoSQL clientJedis2.X to 4.X
Lettuce5.2.X+
Redisson2.5.X+
Memcached2.8.X to 2.12.X
MongoDB Java Driver3.X
Spring Data MongoDB2.0.X to 3.4.X
Elasticsearch Rest Client5.X to 7.X
Elasticsearch Rest High Level Client6.X to 7.X
ClickHouse JDBC Driver0.3.X to 0.4.X
InfluxDB-
Messaging clientRocketMQ Java Client4.4.0, 4.5.1+, 5.X+
RocketMQ Java Client V55.X+
Spring for Apache RocketMQ2.0.2+
Alibaba Cloud ONS1.7.0.Final+, 2.0.0.Final+
RabbitMQ Java Client4.X+
Kafka Client0.11.0.0+, 1.X+, 2.X+, 3.X+
Task scheduling frameworkXXL-JOB2.0.X to 2.4.X
ElasticJob2.0.X to 2.1.X
SchedulerX1.2.X to 1.5.X
Spring Scheduled3.2.X to 5.3.X
Async/reactive programming frameworkSpring @Async4.0.X to 5.3.X
RxJava2.0.X to 3.1.X
Reactor3.0.X to 3.5.X
Logging frameworkLog4j1.2.16 to 1.2.17
Log4j22.0 to 2.20.0
Logback1.0.13 to 1.4.8

ARMS provides automatic instrumentation for the supported components. If your application uses a library not on this list, you can add support using manual instrumentation. For more information, see Add custom instrumentation to traces by using the OpenTelemetry Java SDK.