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:

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

    magento-cloud subscription:info services.newrelic
    
  2. 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:

      magento-cloud variable:update php:newrelic.license --value <newrelic-license-key>
      

    Optionally, you can add it from the Commerce Admin.

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

  1. List environment variables.

    magento-cloud variable:list
    

    Sample response:

     +----------------------+-------------+----------------------+---------+
     | Name                 | Level       | Value                | Enabled |
     +----------------------+-------------+----------------------+---------+
     | php:newrelic.license | environment | newrelic-license-key | true    |
     +----------------------+-------------+----------------------+---------+
    
    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
  2. Delete the license variable.

    magento-cloud variable:delete php:newrelic.license
    
Previous pageNew Relic overview
Next pagePolicies, alerts, and workflows

Commerce