PHP agent compatibility and requirements

Before you install the PHP agent, make sure your system meets the version requirements listed below.

PHP agent compatibility

See PHP agent release notes for the latest PHP agent release.

For an up-to-date list of all currently supported PHP Agent releases, see the PHP Agent EOL Policy.

If you're using an unsupported PHP version or platform (such as a 32 bit OS, FreeBSD, or ZTS builds), we recommend disabling the auto-update mechanisms for the PHP agent packages. If you fail to prevent automatic upgrades, this could lead to the accidental installation of a newer agent version. The newer version may no longer support critical features essential for APM data collection, resulting in disruptions to monitoring capabilities.

To disable auto-update, you have two options:

• Add the PHP agent packages to an exclusion list for package upgrades, or
• Version pin the PHP agent package to an agent version that supports the old, unsupported feature(s). The affected PHP agent packages are:
  • newrelic-php5
  • newrelic-php5-common
  • newrelic-daemon

Zend Thread Safety

PHP builds that are compiled with Zend Thread Safety (ZTS) are not supported.

Just-In-Time Compilation (JIT)

Just-In-Time compilation is supported as of agent release 10.18.0.8. PHP automatically disables JIT for any earlier versions of the PHP Agent.

Fibers

Fibers is not supported.

Permissions

Installing the PHP agent requires root access to:

• Read/write access to the PHP extensions directory.
• Read/write access to PHP configuration data, either in the PHP configuration directory (preferred) or in php.ini.
• Restart the web server or PHP process pool.

Running the agent does not require root access. The agent does need read/write access to the following files (the location of these files can be customized in the PHP agent settings):

• A file storing the agent log files
• A file storing the agent socket endpoint
• A file storing the agent process ID

License key

Your New Relic license key 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 or license key settings in the PHP ini file.

Processors

The following processor architectures are supported:

• x86_64 (also known as amd64)
• aarch64 (also known as ARM64)

Operating systems

When vendors announce end-of-life (such as on Ubuntu's End of Standard Support page), we will continue to support those latest versions for one year after the vendor end-of-life date. However, if the PHP version you're using is no longer officially supported, then support could end sooner than one year.

This is why we recommend always using 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, but we no longer test or officially support the PHP agent with older versions.

Based on the information above the PHP agent, can be installed on operating systems using the install methods listed in the table below.

Web servers

The following web servers are supported:

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

Frameworks

The following frameworks are supported:

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

Databases and libraries

The following databases and libraries are supported:

Other third-party monitoring software

If your application uses any additional monitoring software, we cannot guarantee that our agent will work correctly and 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 following databases and extensions are supported:

To disable collection of host information, configure one of the following in the newrelic.inifile:

• Disable instance reporting with newrelic.datastore_tracer.instance_reporting.enabled = false
• 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 PHP agent, get support at support.newrelic.com.

Message queuing

The following supports message queuing:

• HTTP
• Laravel queuing

  Important

  Laravel Horizon is not supported.

Security requirements

As a standard security measure for data collection, your app server must support SHA-2 (256-bit). SHA-1 is not supported.

New Relic feature support

The PHP agent integrates with other New Relic features to give you end-to-end visibility: