Compatibility and requirements for the Java agent

Before installing the New Relic Java agent, make sure you meet the following requirements.

App/Web servers

To install the Java agent on supported app/web servers, see Install the Java agent.

  • Tomcat 5.5 to 8.x
  • TomEE 1.5 or higher
  • Jetty 6.1.4 to 9.3.x
  • WebLogic 10.3.3 to 12.2.x
  • WebSphere 7.0 to 9.x
  • WebSphere Liberty Profile 8.5.5.3 to 17.x
  • JBoss 4.0.5 to AS 7.x
  • JBoss EAP 6.x
  • WildFly 8 to 10.x
  • WildFly 11.x
  • Glassfish 3.0 to 4.x
  • Mule ESB 3.4 to 3.8
  • Netty 3.4 to 4.x
  • Resin 3.1.9 to 4.0.x
  • ColdFusion 10

Frameworks

To install the Java agent on supported frameworks, see Install the Java agent.

  • Spring 3.x to 4.x
  • Spring Boot 1.4.x or higher
  • Struts 2
  • CXF
  • Jersey 1.x to 2.x
  • JSF (Java Server Faces)
  • Grails 1.3.7 to 2.3.x
  • Play 1.2.4
  • Play 2.0.3 to 2.6.x
  • Hystrix 1.0.2 to 1.5
  • Thrift 0.8.0 or higher
  • OkHttp 3.0 to 3.9
  • Vert.x 3.3.0 to 3.4.2

JDBC drivers

New Relic currently supports MySQL and PostgreSQL to capture explain plans for slow database queries.

  • Generic JDBC (any JDBC compliant driver)
  • DB2 9.1 to 10.x
  • Derby 10.6.1.0 to 10.x
  • H2 1.0.x to 1.4.x
  • HSQL 1.7.2.2 to 2.x
  • INet Oracle Driver (Oranxo) 3.06, 3.14
  • INet MERLIA 7.0.3, 8.04.03, and 8.06
  • jTDS 1.2 to 1.3.x
  • MariaDB 1.1.7 to 1.3.x
  • Microsoft SQL Server 2.0 to 4.2
  • MySQL mysql-connector-java-5.1.4 or higher
  • Oracle ojdbc14, ojdbc5, ojdbc6, ojdbc7
  • Postgres postgressql-8.x to 9.x
  • Sybase (jConnect) JDBC 3 driver

JVM

Fully supported:

  • Oracle Hotspot JVM versions 6 to 9 for Linux, Solaris, Windows, and OS X
  • IBM JVM versions 6 to 8 for Linux
  • Apple Hotspot JVM version 6 for OS X

Supported only with Java agent 2.21.x [ZIP | 2.8 MB] legacy agent:

  • Oracle Hotspot JVM version 5.0 for Linux, Solaris, Windows, OS X (Java SE 5.0)
  • Oracle JRockit up to and including 1.6.0_50

Hosting services

Supported hosting services include:

Asynchronous instrumentation

For supported frameworks, the Java agent usually instruments async work automatically. However, you can use the Java agent API to extend this instrumentation.

Instance-level database information

New Relic collects instance details for a variety of databases and database drivers. The ability to view specific instances and the types of database information in New Relic APM depends on your New Relic agent version.

New Relic's Java agent version 3.33.0 or higher supports the following:

  • Any compatible JDBC driver
  • Amazon DynamoDB 1.11.106 or higher
  • DataStax Cassandra driver 2.1.2, 3.0 to 3.1
  • Jedis Redis driver 1.4 to 2.9
  • Mongo 2.12.0 to 2.13.3, 3.1 to 3.3
  • Spymemcached 2.11 to 2.12

Exception: Instance-level information is not reported for calls to the getBulk() API method.

The Java agent reports the database name and database server/identifier attributes on slow query traces and transaction traces for these database drivers. To request instance-level information from additional datastores, get support at support.newrelic.com.

Other instrumented features

  • Akka 2.0 to 2.4 async tracking
  • Akka HTTP 1.x to 2.5.x
  • Akka HTTP 10
  • Amazon S3 (Simple Storage Service)
  • Amazon DynamoDB 1.11.106 or higher
  • AsyncHttpClient 1.0.2 to 2.0.x
  • DataStax Cassandra 2.1.2 to 3.2.0 (If you use high security, see slow_query_whitelist.)
  • EJB Session Beans 3.0 or higher
  • Hibernate 3.x to 4.x
  • HttpClient 3.0.1 to 4.x
  • java.net (HttpURLConnection)
  • JAX-RS 1.0 to 2.0
  • JCache API
  • Jedis 1.4 to 2.7.2 (Redis client)
  • JMS 1.1 and Spring-JMS
  • JMX
  • JSP (Java Server Pages) 2.0 to 2.2
  • MongoDB Java driver 2.12.0 to 3.4.x
  • Quartz Job Scheduler 1.8.3 to 2.2.x
  • RabbitMQ 2.7 to 5.0.x (AMQP and JMS)
  • Scala 2.9 to 2.12
  • Slick 3.x
  • Solr 1.4.0 to 6.5.x
  • Spymemcached 2.11 to 2.12
  • Spray 1.3.x
  • Spray-can 1.3.1 or higher
  • Spray-client 1.3.x

Security requirements

As a standard security measure for data collection, your app server must support SHA-2 (256-bit). SHA-1 is not supported.

Connect the agent to other New Relic products

The Java agent integrates with other New Relic products to give you end-to-end visibility:

Product Integration
New Relic Browser The Java agent automatically injects the Browser JavaScript agent when you enable auto-instrumentation. After enabling Browser injection, you can view Browser data in the APM Overview page and quickly switch between the APM and Browser data for a particular app. For configuration options and manual instrumentation, see New Relic Browser and the Java agent.
New Relic Infrastructure When you install the Infrastructure and APM agents on the same host, they automatically detect one another. You can then view a list of hosts in the APM UI, and filter your Infrastructure hosts by APM app in the Infrastructure UI. For more information, see New Relic APM data in Infrastructure.
New Relic Insights The Java agent sends default events and attributes to Insights for NRQL queries. You can also record custom events for advanced analysis.
New Relic Synthetics Synthetic transaction traces connect requests from Synthetics monitors to the underlying APM transaction.

For more help

Additional documentation resources include:

Recommendations for learning more: