Before you install New Relic for PHP, make sure your system meets the applicable requirements.
New Relic supports PHP versions 5.3, 5.4, 5.5, 5.6, 7.0, 7.1, 7.2, 7.3, 7.4.
- New Relic recommends using a supported release of PHP, especially 7.3 and 7.4.
- PHP 5.1 support was deprecated in release 4.0 of the agent, and removed in release 4.5.
- PHP 5.2 support was deprecated in release 6.8 of the agent, and removed in release 7.0.
For any installation, you will need your New Relic license key. This is a 40-character hexadecimal string that New Relic provides when you sign up for your account. For more information, see the PHP install script and license key settings in the PHP INI file.
- Intel (and compatible) platforms only
- Support for SSE2 instructions is required
The Windows operating system is not supported.
|Operating system||Supported by New Relic's PHP agent|
|Linux (x86 and x86_64)||
|macOS (x86_64 only)||macOS 10.6 or higher (see macOS specific notes)
Since modern versions of macOS can't run 32-bit applications, New Relic removed support for 32-bit macOS with PHP agent release 4.6.
|FreeBSD (x64)||The latest agent supports the latest Production Release.|
|SmartOS and Solaris (x64) (DEPRECATED)||
Apache 2.2 or 2.4 via
Any web server that supports FastCGI using PHP-FPM
Supported PHP frameworks include:
|CakePHP 1.2, 1.3, and 2.x||MediaWiki|
|CodeIgniter 2.x||Silex 1.x and 2.x|
|Drupal 6.x, 7.x, 8.x, and 9.x||Slim 2.x, 3.x, and 4.x|
|Joomla 1.5, 1.6, 2.x, and 3.x||Symfony 1.x, 2.x, 3.x, 4.x, 5.x|
|Kohana 3.2 and 3.3||Wordpress|
|Laravel 4.x, 5.x, 6.x, and 7.x||Yii 1.x|
|Magento 1.x and 2.x, CE and EE||Zend Framework 1.x, 2.x, and 3.x|
The PHP agent's list of frameworks continues to grow. Even if the framework you are using is not listed here, the PHP agent may be able to provide you with useful information about your app.
Databases and libraries
Supported databases and libraries:
|Databases and Libraries|
|Microsoft SQL Server||Redis|
Other APM software
If your application uses other application performance monitoring (APM) software besides our agent, we cannot guarantee that our agent will work correctly and we cannot offer technical support. For more information, see Errors when using other monitoring software.
New Relic collects instance details for a variety of databases and database drivers. The ability to view specific instances and the types of database information in APM depends on your New Relic agent version.
New Relic's PHP agent version 6.8 or higher supports instance details for the following:
|Database||Extension||Minimum agent version|
To disable collection of host information, use either of these options:
- Omit the database name with
newrelic.datastore_tracer.database_name_reporting.enabled = false.
To request instance-level information from datastores currently not listed for your New Relic agent, get support at support.newrelic.com.
- Laravel Queuing, available as an experimental feature in the PHP Agent 184.108.40.206 release, enabled by default since PHP Agent 220.127.116.11.
As a standard security measure for data collection, your app server must support SHA-2 (256-bit). SHA-1 is not supported.
Connect the agent to other New Relic features
The PHP agent integrates with other New Relic features to give you end-to-end visibility:
|Browser monitoring||The PHP agent automatically injects the browser agent's JS code when you enable auto-instrumentation. After enabling browser injection, you can view data in the APM Summary page and quickly switch between the APM and browser data for a particular app. For configuration options and manual instrumentation, see Browser monitoring and the PHP agent.|
|Infrastructure monitoring||When you install the infrastructure and APM agents on the same host, they automatically detect one another. You can then view a list of hosts in the APM UI, and filter your Infrastructure hosts by APM app in the Infrastructure UI. For more information, see APM data in infrastructure monitoring.|
|New Relic Dashboards||The PHP agent sends default events and attributes for NRQL queries. You can also record custom events for advanced analysis.|
|Synthetic monitoring||Synthetic transaction traces connect requests from synthetic monitors to the underlying APM transaction.|