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, 8.1 and 8.2.

Important

Compatibility note: When PHP 8.0, 8.1 or 8.2 detects an observability extension, like the New Relic agent, PHP disables Just-In-Time compilation.

Support for PHP 8.1 and 8.2 does not include Fibers.

Support for PHP versions 5.5 and 5.6 ends in June 2023.

We recommend using a supported release of PHP.
Release 9.19 was the last release to support ZTS builds.

Important

For installations using an unsupported PHP version or platform (examples: 32 bit OSes, FreeBSD, ZTS), it's highly recommended that you disable the auto-update mechanisms for the PHP agent packages. This can be done by adding the PHP agent packages to an exclusion list for package upgrades. Or you could version pin the PHP agent package to an agent version that supports the old, unsupported feature(s). Failure to prevent upgrades may result in a newer agent release being installed and removal of support for the required, unsupported features. This would disrupt APM data collection. The PHP agent packages which are affected are:

newrelic-php5
newrelic-php5-common
newrelic-daemon

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

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.

Operating system	Supported by New Relic's PHP agent
Linux (x86_64)	Alpine 3.12 or higher Amazon Linux 2 Red Hat Enterprise Linux (RHEL) 7 or higher CentOS 7 or higher Debian 9.0 ("stretch") or higher Ubuntu LTS 18.04 ("Bionic Beaver") or higher or Ubuntu non-LTS 21.04 ("Hirsute Hippo") or higher. Any other Linux distribution with: Kernel version 4.9 (long term) or higher glibc 2.17 or higher with NPTL support or musl libc version 1.1.24 or higher
Linux (ARM64)	Amazon Linux 2 (including AWS Graviton 2) CentOS 8 Alpine 3.16 or later Debian 11 or later Important ARM64 support is provided only for PHP 8.0, 8.1, and 8.2. Important New Relic PHP agent 10.10.0 or later provides support for ARM64 by including binaries in a tarball distribution. Important The New Relic PHP agent 9.18.1 - 10.9.0 source distribution provides ARM64 support ONLY on Amazon Linux 2 (including AWS Graviton 2) and Centos 8. For more information on ARM64 support and installation, please see the ARM64 installation info.

Operating system

Supported by New Relic's PHP agent

Linux (x86_64)

Alpine 3.12 or higher
Amazon Linux 2
Red Hat Enterprise Linux (RHEL) 7 or higher
CentOS 7 or higher
Debian 9.0 ("stretch") or higher
Ubuntu LTS 18.04 ("Bionic Beaver") or higher or Ubuntu non-LTS 21.04 ("Hirsute Hippo") or higher.
Any other Linux distribution with:
- Kernel version 4.9 (long term) or higher
- glibc 2.17 or higher with NPTL support or musl libc version 1.1.24 or higher

Linux (ARM64)

Amazon Linux 2 (including AWS Graviton 2)
CentOS 8
Alpine 3.16 or later
Debian 11 or later

Important

ARM64 support is provided only for PHP 8.0, 8.1, and 8.2.

Important

New Relic PHP agent 10.10.0 or later provides support for ARM64 by including binaries in a tarball distribution.

Important

The New Relic PHP agent 9.18.1 - 10.9.0 source distribution provides ARM64 support ONLY on Amazon Linux 2 (including AWS Graviton 2) and Centos 8.

For more information on ARM64 support and installation, please see the ARM64 installation info.

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, 9.0, 9.1, 9.2, and 9.3	Slim 2.x, 3.x, and 4.x
Joomla 3.x	Symfony 3.x, 4.x, and 5.x
Laminas 3.x	Wordpress
Laravel Lumen 6.x, 7.x, and 8.x	Yii 1.x
Zend Framework 1.x, 2.x, and 3.x

Important

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.

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 Support Forum 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 is available for the following:

Database	Extension
MongoDB	mongodb
MySQL	mysql
MySQL	mysqli
MySQL	pdo_mysql
PostgreSQL	pgsql
PostgreSQL	pdo_pgsql
Redis	predis
Redis	redis

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.

Codesteam/Code-level metrics

The PHP agent supports code-level metrics for PHP releases 7.0, 7.1, 7.2, 7.3, 7.4, 8.0, 8.1 and 8.2.

Logs In Context

The PHP agent supports APM logs in context for the following libraries:

Monolog 2 and 3

Message queuing

HTTP
Laravel Queuing

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.
Codestream/Code-level metrics	New Relic CodeStream allows developers to see how the code they're responsible for is performing in production by bringing observability into the IDE and making it part of their daily routine. The PHP agent reports code-level metrics (starting with release 10.4.0) on your application which enables detailed insight into how your code is performing at the method level.
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.