PHP agent installation: Ubuntu and Debian

These are the standard procedures to install New Relic APM's PHP agent using Ubuntu or Debian. This is not the same as the Ubuntu and Debian procedures for New Relic Infrastructure. For other situations, see the PHP agent procedures for non-standard PHP installations.

The package name for the New Relic for PHP agent is newrelic-php5. Although the name references PHP 5, this package works for all supported PHP versions, including PHP 7 versions.

Recommended: Use apt

This is the recommended method for New Relic installation and maintenance.

Run the commands in this procedure as root.

Step Notes
1.

Configure the New Relic apt repository.

echo 'deb http://apt.newrelic.com/debian/ newrelic non-free' | sudo tee /etc/apt/sources.list.d/newrelic.list

This command adds deb http://apt.newrelic.com/debian/ newrelic non-free to /etc/apt/sources.list.d/newrelic.list. It creates the file if it does not exist.

This step is only required once per system.

2.

Trust the New Relic GPG key.

This step is required to register New Relic as an authenticated source where apt-get will look for new packages. To get the New Relic public apt-key from global key servers, run the following command as root:

wget -O- https://download.newrelic.com/548C16BF.gpg | sudo apt-key add -

If you do not run this command as root, you may see an error message about the public key.

3.

Update the local package list.

Execute the following command as root:

sudo apt-get update
4.

Install the PHP agent.

Execute the following command to install directly from the New Relic repositories:

sudo apt-get install newrelic-php5
5.

Non-standard installations: Complete installation manually.

If you are not using the default Ubuntu or Debian PHP packages, the newrelic-php5 package may be unable to configure PHP automatically. You may see this error:

Please run newrelic-install as root to complete installation.

If so, run the following command:

sudo newrelic-install install
6.

Configure your application name and New Relic license key.

The installation process prompts for your application name and license key. Your license key appears in the account information section of Account settings. For headless installations, you can also preseed your license key and application name by using debconf.

7.

Restart your web server or FastCGI Process Manager (FPM).

Generate traffic for your app, and wait a few minutes for your application to send data to New Relic. Then, check your app's performance in the New Relic UI.

Optional: Use unattended installation

To run an unattended installation, you can use non-interactive mode. Include the -y flag to automatically respond yes to any prompt during package installation. For example:

DEBIAN_FRONTEND=noninteractive apt-get -y install newrelic-php5

Manual: Use dpkg

If you use this method, must manually install updates. This is why New Relic recommends the apt method for installation and maintenance. Run the commands in this procedure as root.

To install the PHP agent manually using dpkg:

Step Notes
1.

Copy the URL for the package download.

Navigate to the appropriate URL for your architecture, and copy the full URL for the latest newrelic-daemon, newrelic-php5-common, and newrelic-php5 packages:

2.

Download the package.

Run the following wget command, replacing https://LINK_TO_PACKAGE with the full URL of the package:

wget -L https://LINK_TO_PACKAGE
3.

Install the PHP agent.

Run the appropriate command as root, replacing X.X.X.X with the current version:

32-bit:

dpkg -i newrelic-php5-common_X.X.X.X_all.deb newrelic-daemon_X.X.X.X_i386.deb newrelic-php5_X.X.X.X_i386.deb

64-bit:

dpkg -i newrelic-php5-common_X.X.X.X_all.deb newrelic-daemon_X.X.X.X_amd64.deb newrelic-php5_X.X.X.X_amd64.deb
4.

Configure your application name and New Relic license key.

The installation process prompts for your application name and license key. Your license key appears in the account information section of Account settings. For headless installations, you can also preseed your license key and application name by using debconf.

5.

Restart your web server or FastCGI Process Manager (FPM).

Generate traffic for your app, and wait a few minutes for your application to send data to New Relic. Then, check your app's performance in the New Relic UI.

Headless: Preseed license key and app name

For headless installations, you can preseed your license key and application name. You must use the default php5 packages provided by your distribution. To preseed, set values in your debconf database by using debconf-set-selections.

These settings will be ignored if you are not using a packaged PHP, and you will be prompted to run newrelic-install.

These keys are located in the newrelic-php5 package:

Name Type
newrelic-php5/application-name

The name of your app. This string sets newrelic.appname in your newrelic.ini.

string
newrelic-php5/license-key

Your New Relic license key. This string sets newrelic.license in your newrelic.ini.

string

For example, you can run these commands to preseed your app name and license key:

echo newrelic-php5 newrelic-php5/application-name string "My App Name" | debconf-set-selections
echo newrelic-php5 newrelic-php5/license-key string "YOUR_LICENSE_KEY" | debconf-set-selections

For more help

Recommendations for learning more: