Our PHP agent auto-instruments your code so you can start monitoring applications. These are the standard procedures to install our PHP agent on Ubuntu or Debian on x86_64 architecture. (This is not the same as the Ubuntu and Debian procedures for the infrastructure agent.) For installation on aarch64 architecture, please use tar file method. For other situations, see the PHP agent procedures for non-standard PHP installations.
PHP versions
The package name for New Relic's PHP agent is newrelic-php5. Although the package name references PHP 5, this package works for all supported PHP versions.
Recommended: Use apt
This is the recommended method for New Relic installation and maintenance.
Important
Run the commands in this procedure as root.
Configure the New Relic apt repository
New Relic's apt repository configuration is only required once per system. To do so, complete these two tasks:
Add
http://apt.newrelic.com/debian/apt repository tosources.list:bash$echo 'deb [signed-by=/usr/share/keyrings/download.newrelic.com-newrelic.gpg] http://apt.newrelic.com/debian/ newrelic non-free' | sudo tee /etc/apt/sources.list.d/newrelic.listThis command adds
deb [signed-by=/usr/share/keyrings/download.newrelic.com-newrelic.gpg] http://apt.newrelic.com/debian/ newrelic non-freeto/etc/apt/sources.list.d/newrelic.list. It creates the file if it does not exist.Trust the New Relic GPG key:
bash$wget -O- https://download.newrelic.com/548C16BF.gpg | sudo gpg --dearmor -o /usr/share/keyrings/download.newrelic.com-newrelic.gpgThis command installs New Relic's GPG key used by
aptto verify signatures of packages inhttp://apt.newrelic.com/debian/apt repository added in previous step.
Update the local package list
Execute the following command as root:
$sudo apt-get updateInstall the PHP agent
Execute the following command to install directly from the New Relic repositories:
$sudo apt-get install newrelic-php5Non-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 installConfigure your application name and New Relic license key
The installation process prompts for your application name and license key. Your appears in the account information section of Account settings. For headless installations, you can also preconfigure your license key and application name by using debconf.
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: 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-php5Manual: Use dpkg
Important
If you use dpkg, you 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:
Copy the URL for the package download
Copy the full URL for the latest newrelic-daemon, newrelic-php5-common, and newrelic-php5 packages from New Relic's repository
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_PACKAGEInstall the PHP agent
Run the install command as root, replacing X.X.X.X with the current version:
$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.debConfigure your application name and New Relic license key
The installation process prompts for your application name and license key. Your appears in the account information section of Account settings. For headless installations, you can also preconfigure your license key and application name by using debconf.
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.
Did this doc help with your installation?
Headless: Preconfigure license key and app name
For headless installations, you need to take steps to preconfigure your and application name. You must use the default php5 packages provided by your distribution. To preconfigure the license key and application name, set values in your debconf database by using debconf-set-selections.
Important
These settings will be ignored if you are not using a packaged PHP. You will be prompted to run newrelic-install.
These keys are located in the newrelic-php5 package:
Name | Type |
|---|---|
The name of your app. This string sets | string |
Your . This string sets | string |
For example, you can run these commands to preconfigure 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