Information for: DEVELOPERS   PARTNERS

Configuring performance monitoring tools

Acquia Cloud environments are compatible with New Relic, a third-party application performance monitoring service.

About New Relic

New Relic Application Performance Monitoring (APM) is a web application performance management tool that lets IT teams monitor live Drupal (and other PHP) applications, troubleshoot issues, and tune for optimal performance.

Note

  • For issues with legacy alerts failing, see Legacy alerts from New Relic fail with the removal of TLS 1.0

  • By default, the Acquia Support team can’t access New Relic accounts not provisioned by Acquia, even if the license key associated with the account is installed on Acquia Cloud. To provide Acquia Support access to New Relic accounts outside of Acquia’s control, add the following email address to the list of users associated with your paid New Relic account:

    support-systems+newrelic@acquia.com

Configuring New Relic performance monitoring for an environment

New Relic Application Performance Monitoring (APM) Pro is available for all non-trial Acquia Cloud subscriptions.

To access to New Relic APM Pro, the organization Owner for Acquia Cloud Professional and Acquia Cloud Enterprise subscriptions must complete the following steps to enable New Relic:

  1. Sign in to Acquia Cloud as a user with the Owner role.

  2. In the top menu, click Manage.

  3. Click the name of the organization that contains the subscriptions for which you want to add New Relic monitoring.

  4. In the left menu, click Subscriptions.

  5. Find the subscription for which you want to add New Relic monitoring, and then click its View link.

  6. In the left menu, click the Add-ons link.

    Add-ons link

    Acquia Cloud will display the Add-ons page.

  7. Click Enable.

    APM page

    Note

    If you have already enabled New Relic, Acquia Cloud will display the New Relic license key.

  8. In the Enable New Relic APM Pro License dialog, click Enable to enable New Relic.

The Acquia Cloud user interface will then send the Organization Owner’s name and email address to New Relic and make the Owner an Admin user on a free New Relic APM Pro account.

Note

Acquia Cloud Site Factory subscribers must contact Acquia Support to gain access to their free New Relic account.

The free New Relic APM Pro account will also give the Organization Owner access to:

After an organization’s Owner has been added to a New Relic APM Pro account as an Admin user, the Owner can add and manage users and their permissions. The Owner shouldn’t remove the default Acquia Support email address associated with the account, and also should not use the associated New Relic license key outside of Acquia Cloud.

To upgrade your free New Relic APM Pro subscription and gain access to more New Relic Pro features, complete the New Relic sign-up form to have New Relic contact you to decide which solution best fits your needs. New Relic may request the New Relic Pro account ID associated with your Acquia-provisioned New Relic account, which can be found in the URL of your Account Settings page in New Relic.

If you’re enabling New Relic performance monitoring for a multisite environment (including Acquia Cloud Site Factory), review the instructions at Using New Relic monitoring in a multisite environment to enable per-site reports in New Relic.

To remove the New Relic code from your website because of a conflict with JavaScript included in your codebase, contact Acquia Support.

Additional features

The following features are also available on Acquia Cloud:

Non-production environments

Your non-production Acquia environments can also report to your existing paid New Relic account. To set this up, create an Acquia Support ticket.

The New Relic license key from production environments can be used on non-production environments.

Note

Using shared hardward resources for your non-production environments can skew provided performance data due to activity by other websites on the shared instance during periods of high activity.

New Relic multisite capabilities

New Relic can be used with multisite installations. For additional information, see Using New Relic monitoring in a multisite environment.

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, complete the following steps:

  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. On 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. On 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 Acquia Cloud user interface
  7. Deploy the build artifact to an environment in Acquia Cloud.

  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.

Compatibility statement

Acquia Cloud is compatible with the Application Monitoring services provided by New Relic. Acquia does not support New Relic Server Monitoring services, Log Monitoring services, or any plug-ins.

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 instances, except for dedicated search instances. 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 after testing the updates. Testing the updates helps to ensure any new features or feature changes included in the updates are in a stable, non-beta state before release.