Configuring New Relic¶

Enhanced functionality using the New Relic contributed module¶

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.

Recommended configuration settings¶

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.

New Relic multisite capabilities¶

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.

Using New Relic to monitor Drush¶

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.

Installing the New Relic Node.js agent¶

To configure New Relic monitoring for your Node.js application:

1. 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.

2. From the newly downloaded node_modules/newrelic directory, copy newrelic.js into the root directory of your application.

3. 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.

4. At line 16, replace license key here with your New Relic license key.

5. Commit the package.json and newrelic.js files to your repository.

6. Trigger a pipelines job by doing one of the following actions:

   • Create or reopen a pull request
   • Push a commit
   • Push a tag
   • Use the Cloud Platform user interface

7. Deploy the build artifact to an environment in Cloud Platform.

8. 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.