Supported technologiesedit

Oracle JDK

7u60+, 8u40+, 9, 10, 11, 17

--module-path has not been tested yet

OpenJDK

7u60+, 8u40+, 9, 10, 11, 17

--module-path has not been tested yet

IBM J9 VM

8 service refresh 5+ (build 2.9 or 8.0.5.0)

Sampling profiler is not supported

HP-UX JVM

7.0.10+, 8.0.02+

SAP JVM

8.1.065+

Servlet API

3+

A transaction will be created for all incoming HTTP requests to your Servlet API-based application. Starting in version 1.18.0, additional spans are created if the servlet dispatches execution to another servlet through the forward or include APIs, or to an error page. See also Application Servers/Servlet Containers

1.0.0, 4.0+ (jakarta.servlet) since 1.28.0

Spring Web MVC

4.x, 5.x

If you are using Spring MVC (for example with Spring Boot), the transactions are named based on your controllers (ControllerClass#controllerMethod).

1.0.0

Spring Webflux

5.2.3+

Creates transactions for incoming HTTP requests, supports annotated and functional endpoints.

1.24.0 (experimental)

JavaServer Faces

2.2.x, 2.3.x, 3.0.x

If you are using JSF, transactions are named based on the requested Facelets and spans are captured for visibility into execution and rendering

1.0.0, jakarta.faces since 1.28.0

Spring Boot

1.5+, 2.x

Supports embedded Tomcat, Jetty and Undertow

1.0.0

JAX-RS

2.x, 3.x

The transactions are named based on your resources (ResourceClass#resourceMethod). Note that only the packages configured in application_packages are scanned for JAX-RS resources. If you don’t set this option, all classes are scanned. This comes at the cost of increased startup times, however.

Note: JAX-RS is only supported when running on a supported Application Server/Servlet Container.

1.0.0, jakarta.ws.rs since 1.28.0

JAX-WS

The transactions are named based on your @javax.jws.WebService, @jakarta.jws.WebService annotated classes and @javax.jws.WebMethod, @jakarta.jws.WebMethod annotated method names (WebServiceClass#webMethod). Note that only the packages configured in application_packages are scanned for JAX-WS resources. If you don’t set this option, all classes are scanned. This comes at the cost of increased startup times, however.

Note: JAX-WS is only supported when running on a supported Application Server/Servlet Container and when using the HTTP binding.

1.4.0, jakarta.jws since 1.28.0

Grails

3+

1.17.0

Apache Struts

2.x

The transactions are named based on your action (ActionClass#actionMethod).

1.24.0

Vert.x Web

3.6+

Captures incoming HTTP requests as transactions

1.24.0 (experimental)

Sparkjava (not Apache Spark)

2.x

The transactions are named based on your route (GET /foo/:bar).

1.25.0

com.sun.net.httpserver.HttpServer

1.7+

Captures incoming HTTP requests as transactions

1.25.0 (experimental)

Javalin

3.13.8+

1.25.0

Java API for WebSocket

1.0

Captures methods annotated with @OnOpen, @OnMessage, @OnError, or @OnClose as transactions for classes that are annotated with @ServerEndpoint.

1.29.0

Tomcat

7.x, 8.5.x, 9.x, 10.x

WildFly

8-16

JBoss EAP

6.4, 7.0, 7.1, 7.2

Jetty (only the ServletContextHandler is supported)

9.2, 9.3, 9.4

WebSphere Liberty

8.5.5, 18.0.x

Undertow Servlet

1.4

Payara

4.x, 5.x

Oracle WebLogic

12.2

JDBC

4.1+

The agent automatically creates DB spans for all your JDBC queries. This includes JDBC queries executed by O/R mappers like Hibernate.

Note: Make sure that your JDBC driver is at least compiled for Java 1.4. Drivers compiled with a lower version are not supported. IBM DB2 db2jcc drivers are also not supported. Please update to db2jcc4.

1.0.0

Elasticsearch

5.0.2+

The agent automatically creates Elasticsearch spans for queries done through the official REST client.

1.0.0, async queries since 1.5.0

Hibernate Search

5.x (on by default), 6.x (off by default)

The agent automatically creates Hibernate Search spans for queries done through the Hibernate Search API.

Note: this feature is marked as experimental for version 6.x, which means it is off by default. In order to enable, set the disable_instrumentations ( [1.0.0] Added in 1.0.0. Changing this value at runtime is possible since version 1.15.0 ) config option to an empty string

1.9.0

Redis Jedis

1.4.0-4.x

The agent creates spans for interactions with the Jedis client.

1.10.0, 4.x since 1.31.0

Redis Lettuce

3.4+

The agent creates spans for interactions with the Lettuce client.

1.13.0

Redis Redisson

2.1.5+

The agent creates spans for interactions with the Redisson client.

1.15.0

MongoDB driver

3.x

The agent creates spans for interactions with the MongoDB driver. At the moment, only the synchronous driver (mongo-java-driver) is supported. The asynchronous and reactive drivers are currently not supported.

The name of the span is <db>.<collection>.<command>. The actual query will not be recorded.

1.12.0

Cassandra

2.x+

1.23.0

Apache HttpClient

4.3+

0.7.0

Apache HttpAsyncClient

4.0+

1.6.0

Spring RestTemplate

3.1.1+

0.7.0

OkHttp

2, 3, 4 (4.4+ since 1.22.0)

1.4.0 (synchronous calls via Call#execute()) 1.5.0 (async calls via Call#enquene(Callback))

HttpUrlConnection

1.4.0

JAX-WS client

JAX-WS clients created via javax.xml.ws.Service inherently support context propagation as they are using HttpUrlConnection underneath.

1.4.0

AsyncHttpClient

2.x

1.7.0

Apache Dubbo

2.5+, except for 2.7.0, 2.7.1, and 2.7.2

This is an experimental plugin. Remove experimental from disable_instrumentations to enable.

1.17.0

JDK 11 HttpClient

1.18.0

Vert.x WebClient

3.6+

1.25.0

ExecutorService

The agent propagates the context for ExecutorService s.

1.4.0

ScheduledExecutorService

The agent propagates the context for ScheduledExecutorService#schedule (this does not include scheduleAtFixedRate or scheduleWithFixedDelay.

1.17.0

ForkJoinPool

The agent propagates the context for ForkJoinPool s.

1.17.0

Scala Future

2.13.x

The agent propagates the context when using the scala.concurrent.Future or scala.concurrent.Promise. It will propagate the context when using chaining methods such as map, flatMap, traverse, …​ NOTE: To enable Scala Future support, you need to enable experimental plugins.

1.18.0

Reactor

3.2.x+

The agent propagates the context for Flux and Mono.

1.24.0 (experimental)

JMS

1.1, 2.0

The agent captures JMS sends and receives as spans/transactions. In addition, it propagates the context when using javax.jms.MessageProducer#send and javax.jms.JMSProducer#send methods through a Message property. On receiver side, the agent reads the context from the Message property through javax.jms.MessageConsumer#receive, javax.jms.MessageConsumer#receiveNoWait, javax.jms.JMSConsumer#receive, javax.jms.JMSConsumer#receiveNoWait or javax.jms.MessageListener#onMessage and uses it for enabling distributed tracing.

Enabled by default since 1.13.0, added as an experimental plugin in 1.7.0, jakarta.jms since 1.28.0

Kafka

<0.11.0 - without distributed tracing; 0.11.0+ - full support

The agent captures Kafka record sends and polls. If org.apache.kafka.clients.consumer.Consumer#poll is invoked from within a traced transaction, a span will be created. Otherwise, the agent attempts to create a transaction for each record read from the returned batch as the consumer iterates over returned records. This requires some heuristics on the agent part, so in some cases kafka-transactions may seem missing or out of order. If both producer and consumer are traced, then distributed tracing is supported, meaning the transaction on the consumer side will be a part of the same trace containing the producer side as well. Kafka streams are not traced.

1.13.0

RabbitMQ

3.x - 5.x

The agent captures RabbitMQ Message sends, consumption and polling. When the producer sends a message within a traced transaction, a send span will be created and the transaction resulting from the message consumption will be correlated to the same trace. When a message is consumed, a transaction is created, regardless if the send action is traced. When a message is polled, a span is created for the polling operation and optionally have message fields if a message has been returned.

1.20.0

Scheduling Annotation

The agent instruments any method defined in a package configured in application_packages and annotated with one of the following: org.springframework.scheduling.annotation.Scheduled org.springframework.scheduling.annotation.Schedules javax.ejb.Schedule javax.ejb.Schedules jakarta.ejb.Schedule jakarta.ejb.Schedules in order to create a transaction with the type scheduled, representing the scheduled task execution

1.6.0, jakarta.ejb.Schedule since 1.28.0

Quartz

1.0+

The agent instruments the execute method of any class implementing org.quartz.Job, as well as the executeInternal method of any class extending org.springframework.scheduling.quartz.QuartzJobBean, and creates a transaction with the type scheduled, representing the job execution

NOTE: only classes from the quartz-jobs dependency will be instrumented automatically. For the instrumentation of other jobs the package must be added to the application_packages parameter.

1.8.0 - 2.0+

1.26.0 - 1.0+

TimerTask

The agent instruments the run method in a package configured in application_packages of any class extending java.util.TimerTask, and creates a transaction with the type scheduled, representing the job execution

1.18.0

slf4j

1.4.1+

Automatically captures exceptions for logger.error("message", exception) calls (since 1.10.0). When doing so, the ID corresponding the captured error (error.id) is added to the MDC as well (since 1.16.0).

1.10.0

log4j2

Trace correlation - 2.0+

ECS Reformatting - 2.6+

The agent adds ThreadContext entries for active trace.id, transaction.id and error.id.

The agent sets the service name for the EcsLayout if not provided explicitly (since 1.29.0).

When log_ecs_reformatting is enabled, logs will be automatically reformatted into ECS-compatible format (since 1.22.0, experimental)

Automatically captures exceptions for logger.error("message", exception) calls. When doing so, the ID corresponding the captured error (error.id) is added to the MDC as well (since 1.16.0).

Trace correlation - 1.13.0

Error capturing - 1.10.0

ECS Service Name - 1.29.0

ECS Reformatting - 1.22.0

log4j1

Trace correlation and error capture - 1.x

ECS Reformatting - 1.2.17

The agent adds MDC entries for active trace.id, transaction.id and error.id.

When log_ecs_reformatting is enabled, logs will be automatically reformatted into ECS-compatible format (since 1.22.0, experimental)

Automatically captures exceptions for logger.error("message", exception) calls. When doing so, the ID corresponding the captured error (error.id) is added to the MDC as well.

Trace correlation - 1.13.0

ECS Reformatting - 1.22.0

Error capturing - 1.30.0

Logback

1.1.0+

The agent adds slf4j MDC entries for active trace.id, transaction.id and error.id.

When log_ecs_reformatting is enabled, logs will be automatically reformatted into ECS-compatible format (since 1.22.0, experimental)

Trace correlation - 1.0.0

ECS Reformatting - 1.22.0

JBoss Logging

3.0.0+

The agent adds MDC entries for trace.id, transaction.id and error.id.

1.23.0

JBoss LogManager - 1.30.0

JUL - java.util.logging

All supported Java versions

When log_ecs_reformatting is enabled, logs will be automatically reformatted into ECS-compatible format

1.31.0

java.lang.Process

Instruments java.lang.Process execution. Java 9 API using ProcessHandler is not supported yet.

1.13.0

Apache commons-exec

1.3

Async process support through org.apache.commons.exec.DefaultExecutor and subclasses instrumentation.

1.13.0

gRPC

1.6.1+

Client (synchronous & asynchronous) & Server instrumentation. Streaming calls are currently not instrumented.

1.16.0

11

Java 11 (Corretto)

Amazon Linux 2

yes

8.al2

Java 8 (Corretto)

Amazon Linux 2

yes

8

Java 8 (OpenJDK)

Amazon Linux 2018.03

no

Built-in metrics

The agent sends various system, JVM, and application metrics. See the metrics documentation.

1.3.0

JMX

Set the configuration option capture_jmx_metrics in order to monitor any JMX metric.

1.11.0

Micrometer (beta)

Automatically detects and reports the metrics of each MeterRegistry. See Micrometer metrics for more details.

1.18.0