Java agent self-installer

Currently the self-installer is fully compatible with Tomcat, Jetty, JBoss, and Glassfish. Other platforms may still require manual editing of the start scripts.

Recommendation: As part of the installation process, change the default application name to a meaningful name. Also, change the default newrelic.yml file permissions to be read/write only for the owner of the app server process.

[video link] For Java agent installation tips, watch this New Relic video (approximately 1 minute).

Using the Java self-installer

To use the Java agent, you need a New Relic account.

  1. Log in to New Relic.
  2. Select Get Started.
  3. From Choose your language, select Java, and follow the installation steps.

Unless you have special considerations, you should be able to complete your New Relic install by following the directions on Get started with Web App Monitoring. This page provides additional information on the install process.

screen java agent get started.png
Get started with New Relic APM and New Relic Insights: Your initial landing page when you first create a New Relic account. You choose your platform with the Choose your language dropdown.

Alternate file download procedure

The Account settings page has a list of the most recent agents by platform in the right-hand column.

  1. From the New Relic menu bar, select (account) > Account settings.

  2. Download the agent for your platform.

  3. Unpack into your app server's root directory. For Glassfish, unpack into your domain's directory.

    unzip -d /path/to/appserver/
  4. Copy a clean config file into the newrelic directory.

screen manual java download.png
Account settings is on the menu bar in the menu under your account name.

Running the installer

The installer is bundled inside the agent jar. Execute it from the newrelic directory with the install command.

cd /path/to/appserver/newrelic
java -jar newrelic.jar install

The installer will find your start script, back it up, and edit it to add the agent switch.

Options for the installer include:

Option Description
-h Display the usage help
-l licensecode Account license key
-s /path/to/applicationserver Location of your application server
Required if newrelic not located in your app server home directory

The installer provides feedback on whether the install succeeded.

  • If it runs successfully, it will tell you to restart your app server, exercise your app, and log in to see your data.
  • If it did not complete, it will explain why, and point you to Java agent manual install.


  1. Rename your backed-up start script to its original name.
  2. Delete the newrelic directory from your app server's root directory.
  3. Restart your server.

JSVC on Windows

On Windows, the installer will add itself to catalina.bat, but not to the jsvc startup command. Look for jsvc support in an upcoming release.

For more help

Additional documentation resources include:

Join the discussion about Java monitoring in the New Relic Community Forum! The Community Forum is a public platform to discuss and troubleshoot your New Relic toolset.

If you need additional help, get support at