Performance Audit Plugin for Matomo

Description

Daily performance audits of all your sites in Matomo for the following metrics based on Google Lighthouse:

• First Contentful Paint
• Speed Index
• Largest Contentful Paint
• Time To Interactive
• Total Blocking Time
• Cumulative Layout Shift
• Overall Score

Continuously monitor those Web Vital metrics over time, allowing detection of underlying problems before they have an adverse effect for users or simply track changes made to the web application, allowing you to establish a baseline for comparison too.

Note: Requires minimum NPM v6.13 (part of Node.js 10.18 LTS) to be installed on your server, otherwise plugin cannot be activated.

Support me

If you installed this plugin and it was useful for you or your business, please don't hesitate to make a donation, I would highly appreciate it. Thank you!

Installation

Preferably you install this plugin automatically by:

1. Login to Matomo as Super User
2. Navigate in your Matomo Installation to Administration › Marketplace (categorized under Platform)
3. Search for Performance Audit
4. Click on Install and wait up to 5 minutes for the installation to finish

You can also install this plugin manually by:

1. downloading the latest plugin zip file
2. Login to Matomo as Super User
3. Navigate in your Matomo Installation to Administration › Marketplace (categorized under Platform)
4. Click on upload a Plugin and upload the zip file from step 1
5. Activate this plugin PerformanceAudit and wait up to 5 minutes for the process to finish

Note: If plugin upload is disabled, enable it in your config/config.ini.php like that:

[General]
enable_plugin_upload = 1

If any errors occur during activation, please follow the instruction or information of the error message.

Minimum requirements

• Matomo 3.12
• PHP 7.1
• NPM v6.13 (part of Node.js 10.18 LTS) to be installed on your server, otherwise plugin cannot be activated.
• If you use a UNIX based OS these dependencies are required

Screenshots

Dashboard

Overall Scores

First Contentful Paint

For more screenshots, check out the screenshot overview.

Testing

Run the integration and unit tests with:

./console tests:run PerformanceAudit

Changelog

Please see the CHANGELOG for more information on what has changed recently.

ToDo

• Add support for mobile Matomo app.

Contact

If you have any questions or inquiries, you can contact github {at} diskoboss {døt} de.

Security

If you discover any security related issues, please contact github {at} diskoboss {døt} de instead of using the issue tracker.

Please note that the performance audits will be performed with Chromium which renders Matomo-tracked web pages on your server without the sandbox mode of Chromium. You can find more information about this possible issue on the lighthouse-cli repository.

License

Licensed under the GPLv3 License.