PHP agent compatibility and requirements

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.

PHP releases

New Relic supports PHP versions 5.5, 5.6, 7.0, 7.1, 7.2, 7.3, 7.4, 8.0, and 8.1.

Important

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.
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.
PHP 5.3 and PHP 5.4 support was deprecated in release 9.15 of the agent, and removed in release 9.17.
32-bit support for PHP versions 5.5, 5.6, 7.0, 7.1, 7.2, 7.3, 7.4 was deprecated in release 9.19.
Release 9.19 is the last release to support ZTS builds. In the future, ZTS builds may not be provided and support may be completely pulled from the codebase.

Permissions

Installation: Root access is required for most installations.
Running: Root access is not required.

License key

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.

Processor type

Intel (and compatible) platforms
ARM64

Operating systems

Important

The Windows operating system is not supported.

Operating system	Supported by New Relic's PHP agent
Linux (x86_64) Linux (x86) DEPRECATED	Important As of June 2022, we're discontinuing support for x86 architecture. For more information, see our PHP agent release notes v9.19.0. AWS Linux 2 Red Hat Enterprise Linux (RHEL) 6 or higher Important As of March 2022, we deprecated support for Red Hat Enterprise Linux (RHEL) 6. For more information, see our PHP agent release notes v9.20.0. It will no longer be supported starting June, 2022. Important As of January 2021, we discontinued support for Red Hat Enterprise Linux (RHEL) 5. For more information, see our PHP agent release notes v9.15.0 and our Explorers Hub post. CentOS 6 or higher Important As of March 2022, we deprecated support for Centos 6. For more information, see our PHP agent release notes v9.20.0. It will no longer be supported starting June, 2022. Important As of January 2021, we discontinued support for CentOS 5. For more information, see our PHP agent release notes v9.15.0 and our Explorers Hub post. Debian 7.0 ("wheezy") or higher Ubuntu LTS 14.04 ("Trusty Tahr") or higher or Ubuntu non-LTS 19.04 ("Disco Dingo") or higher. Any other Linux distribution with: Kernel version 2.6.13 or higher (2.6.26 or higher highly recommended) glibc 2.5 or higher with NPTL support or musl libc version 1.1 or higher
Linux (ARM64)	AWS Linux 2 (including AWS Graviton 2) CentOS 8 Important ARM64 is only supported with: PHP 8.0 and with New Relic PHP Agent 9.18.1 or later. PHP 8.1 and with New Relic PHP Agent 9.19.0 or later. For more information on ARM64 support, please see the ARM64 installation info.
macOS (x86_64 only) UNSUPPORTED	Important As of January 2021, we're discontinuing support for macOS. For more information, see our PHP agent release notes v9.15.0 and our Explorers Hub post. macOS 10.6 or higher. Because 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) DEPRECATED	Important As of June, 2022, we're discontinuing support for FreeBSD. For more information, see our PHP agent release notes v9.19.0. The latest agent supports the latest production release.

Web servers

Apache 2.2 or 2.4 via mod_php
Any web server that supports FastCGI using PHP-FPM

Frameworks

Supported PHP frameworks include:

Frameworks
CakePHP 2.x	Magento 1.x and 2.x, CE and EE
CodeIgniter 2.x	MediaWiki
Drupal 6.x, 7.x, 8.x, and 9.x
Joomla 3.x	Slim 2.x, 3.x, and 4.x
Kohana 3.2 and 3.3	Symfony 3.x, 4.x, 5.x
Laminas 3.x	Wordpress
Laravel 4.x, 5.x, 6.x, and 7.x	Yii 1.x
Laravel Lumen 6.x, 7.x, and 8.x	Zend Framework 1.x, 2.x, and 3.x

Important

Joomla 3.x is not supported on PHP 8.x

Important

As of PHP agent version 9.17, the following frameworks or framework versions are no longer supported and may be removed from future agent builds: Cake PHP 1.x Joomla 1.5, 1.6, and 2.x Kohana Silex 1.x and 2.x * Symfony 1.x and 2.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.

For more information, see PHP frameworks: Integrating support for New Relic. If you want to suggest support for other popular PHP frameworks, visit us at the Explorers Hub and create a Feature Idea!

Databases and libraries

Supported databases and libraries:

Databases and Libraries
Firebird	Oracle
Guzzle	PHPUnit
Informix	PDO
Memcached	Postgres
MongoDB	Predis
Microsoft SQL Server	Redis
MySQL	SQLite
ODBC	Sybase

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.

Instance details

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
MongoDB	mongodb	7.1
MySQL	mysql	6.8
MySQL	mysqli	6.8
MySQL	pdo_mysql	6.8
PostgreSQL	pgsql	6.9
PostgreSQL	pdo_pgsql	6.9
Redis	predis	7.1
Redis	redis	7.1

To disable collection of host information, use either of these options:

Set newrelic.datastore_tracer.instance_reporting.enabled to false in the newrelic.ini.
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.

Message queuing

HTTP
Laravel Queuing, available as an experimental feature in the PHP Agent 6.6.0.169 release, enabled by default since PHP Agent 8.0.0.204.

Security requirements

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:

Product	Integration
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.