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, and 7.1.
- New Relic recommends using a supported release of PHP, especially 7.0 and 7.1.
- 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 New Relic 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)||
|SmartOS and Solaris (x64)||
|Mac OS X (x86_64 only)||Mac OS X 10.6 or higher (See Mac OS X specific notes)
New Relic removed support for 32-bit Mac OS X with PHP agent release 4.6.
|FreeBSD (x64)||The latest agent supports the latest Production Release.|
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, and 8.x||Slim 2.x and 3.x|
|Joomla 1.5, 1.6, 2.x, and 3.x||Symfony 1.x, 2.x, and 3.x|
|Kohana 3.2 and 3.3||Wordpress|
|Laravel 4.x, 5.0, 5.1, 5.2, and 5.3||Yii 1.x|
|Magento 1.x and 2.x, CE and EE||Zend Framework 1.x, 2.x, and 3.x|
The New Relic PHP agent's list of frameworks continues to grow. Even if the framework you are using is not listed here, New Relic's engineers may be able to provide you with useful information about your app.
Databases and libraries
Supported databases and libraries:
|Databases and Libraries|
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 New Relic 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 (experimental support). Disabled by default. To enable, see PHP Agent 126.96.36.199 release note.
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 products
The PHP agent integrates with other New Relic products to give you end-to-end visibility:
|New Relic Infrastructure||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 New Relic APM data in Infrastructure.|
|New Relic Insights||The PHP agent sends default events and attributes to Insights for NRQL queries. You can also record custom events for advanced analysis.|
|New Relic Synthetics||Synthetic transaction traces connect requests from Synthetics monitors to the underlying APM transaction.|
For more help
Additional documentation resources include: