Configure the agent

You can customize some of the default behavior of the New Relic agent by adjusting configuration settings. Depending on the agent, you may be able to customize settings in these locations:

  • New Relic APM user interface (server-side configuration)
  • Configuration file
  • Environment variables
  • Other agent-specific options; for example, Java system properties, Python per-request configuration, etc.

At a minimum, every New Relic agent requires you to identify the license key and app name from the configuration file or environment variable settings. You cannot identify the license key or app name from server-side configuration, although you can change the app's display name or alias there.

Agent-specific config options

For details of the configuration options available in each agent, see the agent-specific documentation:

New Relic APM:

New Relic Servers:

Server-side configuration

Server-side configuration transitions some core settings from your language agent’s configuration file to the New Relic servers. This change allows you to configure and manage these values centrally from the New Relic UI, with any change automatically applied to all agents even if running across multiple hosts. The agent still follows the local configurations for any settings not available from the UI.

Available options to change settings, and the order of precedence they take when you utilize environment variables or other configuration options, will depend on the language agent used. For more information about the hierarchy of settings, see the illustration for the specific agent:

Enable server-side configuration

Owner or Admins

Neither the PHP agent nor the Go agent support server-side configuration.

To enable server-side configuration settings for your app:

  1. From the New Relic menu bar, select APM > (selected app) > Settings > Application.

    OR

    From the New Relic menu bar, select APM. Next, from the index of applications, select the app's gear fa-gear icon, and then select fa-pencil Change settings.

  2. From Control your application, select Move configuration to New Relic.

    APM Settings: server-side configuration

  3. Select Save application settings.

After you enable server-side configuration, you can view and change the available settings through the UI.

View or change server-side configuration settings

Owner or Admins

The PHP agent does not support server-side configuration.

If you use server-side configuration, you must still include your license_key and app_name in the local config file. These settings are required for the agent to communicate with the New Relic server.

To view or change the available server-side configuration settings through the UI:

  1. From the New Relic menu bar, select APM > (selected app) > Settings > Application.

    OR

    From the New Relic menu bar, select APM. Next, from the index of applications, select the app's gear fa-gear icon, and then select fa-pencil Change settings.

  2. From Application settings, select your choice of available options.
  3. Optional: Select Show advanced settings or Hide advanced settings to toggle between the short and expanded list of available settings.
  4. Select Save application settings.

Once you set any of these options from the UI, they will override any conflicting configuration options in the agent's configuration file.

Disable server-side configuration

To disable server-side configuration completely, get support at support.newrelic.com. This helps mitigate issues that could arise from conflicts with configuration settings if you need to transition back to a local configuration setup.

For more help

Join the discussion about New Relic APM in the New Relic Community Forum! The Community Forum is a public platform to discuss and troubleshoot your New Relic toolset.

If you need additional help, get support at support.newrelic.com.