Before you install New Relic for PHP, make sure your system meets the applicable requirements.
If you don't have one already, create a New Relic account. It's free, forever.
New Relic supports PHP versions 5.5, 5.6, 7.0, 7.1, 7.2, 7.3, 7.4, 8.0, and 8.1.
Compatibility note: When PHP 8.0 or 8.1 detects an observability extension, like the New Relic agent, PHP disables Just-In-Time compilation.
Support for PHP 8.1 does not include Fibers.
- We recommend using a supported release of PHP, especially 7.4, 8.0, and 8.1.
- Release 9.19 was the last release to support ZTS builds.
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
The New Relic PHP Agent is supported on Ubuntu, Debian, Amazon Linux, Alpine, RHEL and CentOS Operating Systems (OS). When vendors announce end of life (e.g., Standard Support for Ubuntu, EOL LTS for Debian, Maintenance Support for RHEL and Maintenance Update for CentOS), New Relic will continue to support those latest versions for one year. After the year has passed, New Relic will end support for those versions. If the version of PHP you’re using is no longer officially available for an OS, then support could end sooner than one year. It is highly recommended to use the latest version of the OS that is officially supported by the vendor. The latest versions of our agent may work on OS versions that are past End of Life, however it is no longer tested or officially supported by the New Relic PHP Agent.
Supported by New Relic's PHP agent
- Apache 2.2 or 2.4 via
- Any web server that supports FastCGI using PHP-FPM
Supported PHP frameworks include:
Magento 1.x and 2.x, CE and EE
Slim 2.x, 3.x, and 4.x
Symfony 3.x, 4.x, and 5.x
Kohana 3.2 and 3.3
Zend Framework 1.x, 2.x, and 3.x
Laravel Lumen 6.x, 7.x, and 8.x
Joomla 3.x is not supported on PHP 8.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.
Supported databases and libraries:
Databases and Libraries
Microsoft SQL Server
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 is available for the following:
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.
The PHP agent supports APM logs in context for the following libraries:
- Monolog 2 and 3
- Laravel Queuing
As a standard security measure for data collection, your app server must support SHA-2 (256-bit). SHA-1 is not supported.
The PHP agent integrates with other New Relic features to give you end-to-end visibility:
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.
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.
Synthetic transaction traces connect requests from synthetic monitors to the underlying APM transaction.