Information for: DEVELOPERS   PARTNERS

Configuring performance monitoring tools

Acquia Cloud environments are compatible with New Relic, a third-party application performance monitoring service. 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.

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

To add a New Relic APM license key to an Acquia Cloud environment, users with permission to change the environment’s settings can complete the following steps:

  1. Sign in to Acquia Cloud.

  2. Click the name of the application containing the environments for which you want to add New Relic monitoring.

  3. Click your desired environment, and then click the Configure icon.

    Acquia Cloud will display the Configuration panel.

  4. In the Configuration panel, scroll down to the Performance monitoring section.

    Performance monitoring section

  5. In the Provider drop-down list, ensure you select New Relic.

  6. Enter the License Key associated with your New Relic APM account into the Installed New Relic License Key field.

    Note

    If desired, you may also customize the name of the environment reporting into New Relic by adding a custom name to the Application Name in New Relic field. Otherwise, the application will report into New Relic with the format sitename.env.

Application performance monitoring data for your environment will begin to flow through to New Relic once traffic begins hitting your site.

Claiming your New Relic APM Pro account

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

To claim the New Relic account associated with your Acquia Cloud Professional or Acquia Cloud subscription, your organization Owner must follow steps one through six outlined in the Configuring New Relic performance monitoring for an environment section earlier. The organization Owner must then complete the following steps:

  1. Under the Performance Monitoring section, click Claim New Relic Account.

  2. On the Add-ons page for the subscription associated with the desired application, click Claim Account.

    Claim New Relic account on the Application Performance Monitoring page

    Note

    If you have already claimed your New Relic account, Acquia Cloud will display the New Relic license key included with your Acquia Cloud subscription.

  3. In the Enable New Relic APM Pro License dialog, click Claim Account.

    The Acquia Cloud user interface will send the organization Owner’s name and email address to New Relic and make the Owner an Admin user on the New New Relic APM Pro account Acquia has provisioned for that subscription.

Note

  • Claiming your New Relic APM Pro account won’t overwrite any New Relic License Keys you installed on your environments before.
  • 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:

Managing New Relic users and permissions

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 shouldn’t use the associated New Relic license key outside of Acquia Cloud.

Upgrading your New Relic account

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. New relic will then 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.

Troubleshooting

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 Configuring New Relic performance monitoring for an environment section. You should complete the steps to confirm your New Relic License Key has been installed.

To remove the New Relic code from your website because of a conflict with JavaScript included in your codebase, view the following documentation:

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.

You can use the New Relic license key from production environments on non-production environments.

Note

Using shared hardware 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

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.

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. 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 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 doesn’t support New Relic Server Monitoring services, Log Monitoring services, or any plug-ins.

Acquia Cloud 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 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 in the updates are in a stable, non-beta state before release.