Supported technologiesedit

Oracle JDK

7, 8, 9, 10, 11

--module-path has not been tested yet

Open JDK

7, 8, 9, 10, 11

--module-path has not been tested yet

IBM J9 VM

8

NOTE: Early Java 8 versions before update 40 are not supported because they have several bugs that might result in JVM crashes when a java agent is active, thus agent will not start on those versions.

Here is an example of the message displayed when this happens. ``` Failed ot start agent - JVM version not supported: 1.8.0_31 ```

Servlet API

3+

A transaction will be created for all incoming HTTP requests to your Servlet API-based application. See also Application Servers/Servlet Containers

1.0.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

JavaServer Faces

2.2.x, 2.3.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

Spring Boot

1.5+, 2.x

Supports embedded Tomcat, Jetty and Undertow

1.0.0

JAX-RS

2.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

JAX-WS

The transactions are named based on your @javax.jws.WebService annotated classes and @javax.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

Tomcat

7.x, 8.5.x, 9.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.5. For example, commons dbcp versions before 1.4 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 incubating 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-3.x

The agent creates spans for interactions with the Jedis client.

1.10.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

Apache HttpClient

4.3+

0.7.0

Apache HttpAsyncClient

4.0+

1.6.0

Spring RestTemplate

4+

0.7.0

OkHttp

2, 3

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

ExecutorService

The agent propagates the context when using the java.util.concurrent.ExecutorService methods of any ExecutorService implementation.

1.4.0

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 incubating plugin in 1.7.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

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 in order to create a transaction with the type scheduled, representing the scheduled task execution

1.6.0

Quartz

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 packages configured in application_packages will be instrumented.

1.8.0

slf4j

1.4.1+

When enable_log_correlation is set to true, the agent will add a MDC entry for trace.id and transaction.id. See the enable_log_correlation configuration option for more details.

Automatically captures exceptions for logger.error("message", exception) calls (since 1.10.0)

1.0.0

log4j2

2.0+

When enable_log_correlation is set to true, the agent will add a ThreadContext entry for trace.id and transaction.id. See the enable_log_correlation configuration option for more details.

Automatically captures exceptions for logger.error("message", exception) calls.

1.11.0 (error capturing), 1.13.0 (log correlation via ThreadContext)

log4j

1.x

When enable_log_correlation is set to true, the agent will add a MDC entry for trace.id and transaction.id. See the enable_log_correlation configuration option for more details.

1.13.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 - 1.27.1

Client (synchronous & asynchronous) & Server instrumentation

1.14.0

API/Code

Get the current span (possibly created by auto instrumentation) and create a child span. You can also use the OpenTracing API instead of the Elastic specific API.

This is the most flexible way: you can add labels to the span and customize the span type, name, and timestamp.

Wrong usage of the API may lead to invalid traces (scope leaks).

Annotations

Annotate any method with @CaptureSpan, @CaptureTransaction or @Traced.

Easier and more robust as there’s nothing you can do wrong like forgetting to end a span or close a scope. It’s also a bit more performant than the programmatic way.

Less flexible on it’s own but can be combined with the API. Just get the current span on an annotated method and customize the span to your liking.

Sampling-based profiler (experimental) [1.14.0] Added in 1.14.0.

Leverages async-profiler to periodically record which methods are running (stack traces). Enable by setting profiling_inferred_spans_enabled to true.

Very low overhead, no code changes required. Great to find out which parts of the code make your application slow, without having to apply application-specific configuration.

Does not work on Windows. The duration of profiler-inferred spans are not exact measurements, only estimates. The accuracy depends on profiling_inferred_spans_sampling_interval.

Configuration-based method instrumentation

Use the trace_methods configuration option to specify additional methods to instrument.

You don’t need to modify the source code. That makes it possible to monitor code in 3rd party libraries. You can match methods via wildcards in the package, class or method name, by their modifier (like public), by a particular annotation, and more.

Easy to overuse by matching too many methods which hurts both runtime and startup performance. Use together with trace_methods_duration_threshold if setting for entire packages instead of specific methods in order to reduce overhead and avoid having too many spans in the APM app.

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