The following documentation provides instructions on how to configure the New Relic APM Pro account included within an Acquia subscription.
Acquia recommends you install the New Relic contributed module to take advantage of more New Relic APM features as detailed on the module’s project page.
The recommended setting for newrelic.loglevel
is error
rather than
warning
. You should add code to set the newrelic.loglevel
at the end of
your settings.php
file after the Acquia require line as shown in the following example:
if (file_exists('/var/www/site-php')) {
require('/var/www/site-php/<site>/<site>-settings.inc');
}
ini_set('newrelic.loglevel', 'error');
Setting newrelic.loglevel
to warning
can result in too many messages
which can fill up the /mnt
directory and cause PHP errors.
Organization owners can use the included Synthetics Lite subscription to monitor the uptime of their application with Ping Monitors. For detailed instructions on setting up Ping Monitors, see Add and edit monitors.
To disable a New Relic APM license key to a Cloud Platform environment, users with permission to change the environment’s settings can complete the following steps:
If your New Relic account isn’t actively showing performance monitoring data, even after accessing one or more sites on your environments, follow the steps outlined in the Adding a New Relic license key to a Cloud Platform environment section. You should complete the steps to confirm your New Relic License Key has been installed.
Note
Using shared infrastructure for your non-production environments can skew provided performance data due to activity by other websites on the shared infrastructure during periods of high activity.
To remove the New Relic code from your website because of a conflict with JavaScript included in your codebase, view the following documentation:
The following features are also available on Cloud Platform:
If you’re enabling New Relic performance monitoring for a multisite environment (including Site Factory), review the instructions at Using New Relic monitoring in a multisite environment to enable per-site reports in New Relic.
You can use New Relic to monitor Drush and its use of external calls by adding
the following code snippet to your drush.ini
file:
extension=newrelic.so
newrelic.license = "[INSERT LICENSE KEY HERE]"
newrelic.appname = "[sitename].[env]"
newrelic.daemon.port = /run/newrelic.sock
where the [LICENSE_KEY]
is your New Relic key, and [sitename].[env]
is
the environment that you want to monitor.
For more information, see Profile Drush Commands in New Relic in the Acquia Knowledge Base.
To configure New Relic monitoring for your Node.js application:
Run the npm install newrelic --save
command locally for the application
you want to monitor. New Relic libraries are both added to the
node_modules
directory and added as a dependency in the package.json
file.
From the newly downloaded node_modules/newrelic
directory, copy
newrelic.js
into the root directory of your application.
At line 12 of newrelic.js
, replace My Application
with your
application name.
Your New Relic dashboard will display the application name in the list of monitored apps.
At line 16, replace license key here
with your New Relic license key.
Commit the package.json
and newrelic.js
files to your repository.
Trigger a pipelines job by doing one of the following actions:
Deploy the build artifact to an environment in Cloud Platform.
Generate traffic and then wait for the data to display in your New Relic APM user interface.
You can extend New Relic application monitoring within your Node.js application by setting up custom metrics and custom integrations.
Cloud Platform is compatible with the Application Monitoring services provided by New Relic. Acquia doesn’t support New Relic Infrastructure Monitoring services, Log Monitoring services, or any plug-ins.
Cloud Platform isn’t compatible with New Relic APM’s Distributed Tracing feature.
Note
Acquia can’t make changes to the New Relic agent on a per-client basis.
Acquia doesn’t support the installation of New Relic on any non-web infrastructure. While New Relic routinely makes updates to their services and periodically adds new features, Acquia will update versions of this service running on Acquia Cloud twice annually. This allows Acquia to ensure new logic in New Relic’s PHP monitoring agent has had several months to stabilize before introducing it onto Cloud Platform.