Analyze PHPUnit test data in New Relic

When you use PHPUnit to manage and run your unit tests, the New Relic PHP agent can automatically capture the test summary results. The agent sends this data to the New Relic platform as events, allowing you to query, chart, and analyze your test results. This feature supports PHPUnit version 8.x only.

php -d newrelic.enabled=false phpunit ...remaining arguments...

Enable PHPUnit test events

To enable PHPUnit test events:

1. Find or add the newrelic.phpunit_events.enabled setting in your newrelic.ini file and set it to true.
2. Restart your web server (apache, PHP-FPM, Nginx, etc) for the setting change to take effect.

View available attributes

When enabled, the PHP Agent detects PHPUnit commands and populates New Relic with two event types that contain data for the test suite (named TestSuite) and individual tests (named Test). You can query the data with NRQL queries and build a dashboard of information important to you.

To query your test events, use FROM TestSuite and FROM Test when specifying your SELECT statements:

SELECT uniqueCount(name) FROM TestSuite

Example queries

A dashboard of test summary data allows you to quickly see a snapshot of overall test success as well as dig into failing suites to determine their cause. These examples illustrate the kinds of widgets you can create with both TestSuite and Test event types.

Percent success

What percent of suites or tests are passing?

SELECT percentage(count(*), WHERE successful IS true) FROM TestSuite

Copy

SELECT percentage(count(*), WHERE outcome = 'passed') FROM Test

Copy

Test outcome

What is the breakdown of test outcomes?

SELECT count(*) FROM Test FACET outcome

Copy

Test failures

What percent of the time does each test pass?

SELECT percentage(count(*), WHERE outcome = 'failed') FROM Test FACET name

Copy

Test suite failures

What percent of the time does each suite pass, and is that consistent over time?

SELECT histogram((passedCount / testCount)*100, 100, 10) FROM TestSuite FACET name

Copy

Duration

How long does each test suite take to run, and is that consistent over time?

SELECT histogram(duration*1000, 10, 20) FROM TestSuite FACET name

Copy

Linked facets

Because a PHPUnit test suite is linked to individual tests via its run ID, you can use FACET widgets to filter results for a specific test run.

For example, if you created a widget with the most recent failing test suites and linked it to the current dashboard, you could click on a test and the surrounding widgets would update with information for only that test suite run.

In the above example, you can see that by clicking on run 5bb37ccee2a1dbc7, we learn that one of two tests, testFoo, failed. Here are the NRQL queries that made up this example:

Recent unsuccessful suites:

SELECT latest(timestamp), latest(name) FROM TestSuite WHERE successful IS false FACET runId

Last unsuccessful suite:

SELECT host, name, duration * 1000 
AS 'duration (ms)', assertionCount, testCount, passedCount, failedCount, incompleteCount, skippedCount, errorCount, riskyCount, warningCount 
FROM TestSuite WHERE successful IS false LIMIT 1

Last unsuccessful test:

SELECT host, name, testSuiteName, duration * 1000 
AS 'duration (ms)', outcome, assertionCount, message 
FROM Test WHERE outcome != 'passed' LIMIT 1

PHPUnit event attributes

TestSuite and Test events contain the following attributes you can query against: