Documentation Commerce Commerce on Cloud Infrastructure Guide

New Relic account management

Last update: Tue Sep 10 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

Admin

When Adobe provisions your cloud infrastructure project, the License Owner receives an email from New Relic with credentials and instructions for accessing the New Relic account. If you did not receive the email, use the License Owner email address to reset the New Relic password.

Manage user access

NOTE

Only grant full access to users that strictly require access to the complete feature set.

To access User management in New Relic:

Log in to your New Relic account.
Select your username from the lower left navigation.
Click Administration and select one of the following from the list:
- User management to add a user and manage active users and pending invites.
- Access management to manage user groups, roles, and accounts.

See User management in the New Relic documentation.

Configure New Relic for Starter environment

NOTE

Pro environments are preconfigured to use New Relic services and can skip enable and connect instructions. If New Relic APM is not installed on the Staging and Production environments or New Relic Infrastructure is not available in the Production environment, submit an Adobe Commerce Support ticket to request installation.

For Starter environments, you must check the .magento.app.yaml file to verify that the runtime section includes the New Relic extension. If the extension has not been configured, add the following:

.magento.app.yaml

runtime:
    extensions:
        - newrelic

Apply license key

To connect a Cloud environment to New Relic, add the New Relic license key to the environment.

For Pro projects, Adobe adds the license key to your Production and Staging environments during the provisioning process. You can log in to your New Relic account to verify connectivity between your Adobe Commerce on cloud infrastructure site and New Relic.
For Starter projects, you have a New Relic license key that supports up to three environments. You must add the key to your environment configurations manually. Starter environments are not pre-provisioned to use the New Relic service.

For Starter environments, enable the New Relic integration by adding the New Relic license key to the environment configuration. Add the key to the Staging and Production environments and one other environment of your choice. Only the New Relic license key is required for configuration. You can find information about additional configuration options in the New Relic Reporting topic in the Adobe Commerce User Guide.

WARNING

The deployment process begins when you perform a merge, push, or synchronization of your environment, or when you trigger a manual redeployment, during which the Commerce application is in maintenance mode. For a Production environment, Adobe recommends completing this work during off-peak hours to avoid service disruptions.

PREREQUISITES

Login credentials for the Adobe Commerce account page, or for the New Relic license associated with your project
Admin-level access to the Starter environments to configure
Credentials to access the Admin for the environment

To configure New Relic for Starter environments:

Find your New Relic license key from the Cloud Console or the Cloud CLI.

Cloud Console method:

Open your cloud project account page.
On the Projects tab, find your project.
Click View Details for project infrastructure information.
Expand the New Relic Service section to view the license key.
Copy the license key.

Cloud CLI method:

code language-bash
`magento-cloud subscription:info services.newrelic`

Add the New Relic license key to an environment using the magento-cloud CLI.

Change to the environment that needs the license key.

Update the variable value using the following magento-cloud CLI command:

code language-bash
`magento-cloud variable:update php:newrelic.license --value <newrelic-license-key>`

Optionally, you can add it from the Commerce Admin.

Log in to your New Relic account to verify that you can view data from the Adobe Commerce environment. See Investigate performance.

Remove license key

You can only use your New Relic license key on three active environments. If the key is in use in three environments, you must remove the key from one of the environments before you can add it to a different environment.

To remove a license key from an environment:

List environment variables.

code language-bash
`magento-cloud variable:list`

Sample response:

code language-none

code language-none
`+----------------------+-------------+----------------------+---------+ \| Name \| Level \| Value \| Enabled \| +----------------------+-------------+----------------------+---------+ \| php:newrelic.license \| environment \| newrelic-license-key \| true \| +----------------------+-------------+----------------------+---------+`

 +----------------------+-------------+----------------------+---------+
 | Name                 | Level       | Value                | Enabled |
 +----------------------+-------------+----------------------+---------+
 | php:newrelic.license | environment | newrelic-license-key | true    |
 +----------------------+-------------+----------------------+---------+

note warning
WARNING
If you added the license key as a project variable, you must remove that project-level variable. A project variable adds the license to every environment branch created, which can consume or exceed the license limit. To list project variables: `magento-cloud variable:list --level project`

Delete the license variable.

code language-bash
`magento-cloud variable:delete php:newrelic.license`

recommendation-more-help

05f2f56e-ac5d-4931-8cdb-764e60e16f26