PHP agent compatibility and requirements

Before you install New Relic for PHP, make sure your system meets the applicable requirements.

PHP releases

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.

Permissions

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 New Relic PHP install script and license key settings in the PHP INI file.

Processor type

  • Intel (and compatible) platforms only
  • Support for SSE2 instructions is required

Operating systems

The Windows operating system is not supported.

Operating system Supported by New Relic's PHP agent
Linux (x86 and x86_64)
  • RedHat Enterprise Linux (RHEL) 5 or higher
  • CentOS 5.5 or higher (except 5.6)
  • Debian 5.0 ("lenny") or higher
  • Ubuntu 9.10 ("Karmic Koala") 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
SmartOS and Solaris (x64)
  • SmartOS: All versions
  • OpenSolaris 10: snv_134b or higher
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.

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

For more information, see PHP frameworks: Integrating support for New Relic. Or, if you need help or if you want to request other popular PHP frameworks, get support at support.newrelic.com.

Databases and libraries

Supported databases and libraries:

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

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

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 products

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

Product Integration
New Relic Browser The PHP agent automatically injects the Browser JavaScript agent when you enable auto-instrumentation. After enabling Browser injection, you can view Browser data in the APM Overview page and quickly switch between the APM and Browser data for a particular app. For configuration options and manual instrumentation, see New Relic Browser and the PHP agent.
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:

Join the discussion about PHP in the New Relic Online Technical Community! The Technical Community is a public platform to discuss and troubleshoot your New Relic toolset.

If you need additional help, get support at support.newrelic.com.