Java Compatibility Requirements

Compatibility

The Java Datadog Trace library is open source - view the Github repository for more information.

Datadog officially supports the Java JRE 1.7 and higher of both Oracle JDK and OpenJDK. Datadog does not officially support any early-access versions of Java.

Beta integrations are disabled by default but can be enabled individually:

• System Property: -Ddd.integration.<INTEGRATION_NAME>.enabled=true
• Environment Variable: DD_INTEGRATION_<INTEGRATION_NAME>_ENABLED=true

Web framework compatibility

dd-java-agent includes support for automatically tracing the following web frameworks.

Web Framework tracing provides:

• timing HTTP request to response
• tags for the HTTP request (status code, method, etc)
• error and stacktrace capturing
• linking work created within a web request and Distributed Tracing

Note: Many application servers are Servlet compatible and are automatically covered by that instrumentation, such as Websphere, Weblogic, and JBoss. Also, frameworks like Spring Boot inherently work because it usually uses a supported embedded application server (Tomcat/Jetty/Netty).

Integrations Disabled By Default

The following instrumentations are disabled by default and can be enabled with the following settings:

Note: JAX-WS integration instruments endpoints annotated with @WebService (JAX-WS 1.x) and @WebServiceProvider (JAX-WS 2.x).

Don’t see your desired web frameworks? Datadog is continually adding additional support. Contact Datadog support if you need help.

Networking framework compatibility

dd-java-agent includes support for automatically tracing the following networking frameworks.

Networking tracing provides:

• timing request to response
• tags for the request (e.g. response code)
• error and stacktrace capturing
• distributed tracing

Note: Datadog’s Kafka integration works with Kafka version 0.11+, which supports the Header API. This API is used to inject and extract trace context. If you are running a mixed version environment, the Kafka broker can incorrectly report the newer version of Kafka. This causes an issue when the tracer tries to inject headers that are not supported by the local producer. Additionally, older consumers are unable to consume the message because of the presence of headers. To prevent these issues, if you are running a mixed version Kafka environment with versions older than 0.11, disable context propagation with the environment variable: DD_KAFKA_CLIENT_PROPAGATION_ENABLED=false.

Don’t see your desired networking framework? Datadog is continually adding additional support. Contact Datadog support if you need help.

Data store compatibility

dd-java-agent includes support for automatically tracing the following database frameworks/drivers.

Datastore tracing provides:

• timing request to response
• query info (e.g. a sanitized query string)
• error and stacktrace capturing

dd-java-agent is also compatible with common JDBC drivers including:

• Apache Derby
• Firebird SQL
• H2 Database Engine
• HSQLDB
• IBM DB2
• MariaDB
• MSSQL (Microsoft SQL Server)
• MySQL
• Oracle
• Postgres SQL
• ScalikeJDBC

Integrations Disabled By Default

The following instrumentations are disabled by default and can be enabled with the following settings:

Don’t see your desired datastores? Datadog is continually adding additional support. Contact Datadog support if you need help.

Additional framework compatibility

dd-java-agent includes support for automatically tracing the following frameworks.

Don’t see your desired frameworks? Datadog is continually adding additional support. To request a framework, contact our awesome support team.

To improve visibility into applications using unsupported frameworks, consider:

• Adding custom instrumentation.
• Submitting a pull request with instrumentation for inclusion in a future release.
• Contacting Datadog support and submitting a feature request.

Disabling integrations

Most integrations are enabled by default. The following setting can change the default to disabled.

• System Property: -Ddd.integrations.enabled=false
• Environment Variable: DD_INTEGRATIONS_ENABLED=false

Integrations can be enabled or disabled individually (overriding the default above).

• System Property: -Ddd.integration.<INTEGRATION_NAME>.enabled=true
• Environment Variable: DD_INTEGRATION_<INTEGRATION_NAME>_ENABLED=true

(See above for each integration’s name.)

Known issues

Running the Java tracer in Bitbucket is not supported.

Further Reading

お役に立つドキュメント、リンクや記事:

Instrument Your ApplicationDOCUMENTATION