New Relic Monitoring Installation

New Relic is an application performance monitoring solution that provides real-time insight into application performance and reliability. It can track web transaction throughput, analyse exceptions, identify slow requests and queries, and support faster troubleshooting.

New Relic monitoring add-on — The New Relic add-on simplifies APM agent installation inside a platform environment.

The platform provides a JPS-based New Relic add-on that installs the monitoring agent with a guided workflow. It also includes an option for applying available New Relic updates later.

On this page

Requirements
Supported Environments
Install the New Relic Add-On
Installation Settings
Configuration File Locations
Restart Application Nodes
Review Application Metrics
What’s next?

Requirements

A registered New Relic account.
The New Relic license key associated with that account.
An existing platform environment containing the application that needs to be monitored.

After installation, the embedded update option can be used to move the installed New Relic agent to a newer available version.

Supported Environments

Java Environments New Relic is installed as a Java agent. The documented supported application servers are Tomcat, TomEE, and Jetty.

PHP Environments New Relic is installed as a PHP extension on the selected application server.

The installation workflow is similar for both environment types. The example below uses a Java environment with a Tomcat application server.

Install the New Relic Add-On

1Open Marketplace

Click Marketplace in the upper dashboard toolbar.

2Locate New Relic APM

Open the Add-ons section, search for New Relic APM, and click Install.

New Relic add-on package — Install the New Relic APM package from the Add-ons section.

The New Relic agent is also available in the JPS Collection and can be imported through its manifest.jps file.

3Complete the installation form

Provide the application label, license key, target environment, and application-server node.

New Relic add-on installation — Specify the application name, license key, environment, and node.

Installation Settings

Field	Description
Application name	Label used for the application in the New Relic dashboard. The environment domain is inserted automatically by default.
License key	Unique identifier connected to the New Relic account. It ensures that collected metrics are reported to the correct account.
Environment name	Target environment where the New Relic agent will be installed.
Nodes	Application-server instance selected for monitoring.

The license key is available in the New Relic account settings.

New Relic license key — Copy the license key from the New Relic administration panel.

License key mask: The installation form contains a masked placeholder by default. Installation can continue without replacing it, but collected data will not be connected to a usable New Relic account until a valid license key is configured.

Click Install to start deploying the agent.

Configuration File Locations

The license key and other New Relic settings can be changed later through the platform Configuration Manager.

Server Type	Configuration File
Tomcat / TomEE	`/opt/tomcat/lib/newrelic/newrelic.yml`
Jetty	`/opt/jetty/lib/newrelic/newrelic.yml`
PHP application server	`/etc/php.d/newrelic.ini` — update the `newrelic.license` parameter.

Other agent settings can also be adjusted inside these configuration files.

Restart Application Nodes

After a few minutes, the add-on reports that installation has completed successfully.

New Relic successfully installed — The New Relic add-on has been installed successfully.

4Restart the node

Restart the selected application-server node so the New Relic agent starts collecting performance information.

Restart Tomcat server — Restart the application-server node after installing the monitoring agent.

Single-node downtime: Restarting a single application-server node temporarily interrupts the application. Choose an appropriate maintenance time.

For a horizontally scaled application layer, nodes can be restarted sequentially. A delay between node restarts can be configured so that other instances remain active while one node is undergoing maintenance.

Review Application Metrics

Sign in to the New Relic account after the agent starts reporting. The dashboard can then display application performance metrics, custom reports, throughput, response times, transaction activity, and notifications for critical issues.

Application monitoring with New Relic — Review real-time application performance information in the New Relic dashboard.