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 v10.x (part of Node.js 20.x LTS) to be installed on your server, otherwise plugin cannot be activated.
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!
Preferably you install this plugin automatically by:
- Login to Matomo as Super User
- Navigate in your Matomo Installation to
Administration
›Marketplace
(categorized underPlatform
) - Search for
Performance Audit
- Click on
Install
and wait up to 5 minutes for the installation to finish
You can also install this plugin manually by:
- downloading the latest plugin zip file
- Login to Matomo as Super User
- Navigate in your Matomo Installation to
Administration
›Marketplace
(categorized underPlatform
) - Click on
upload a Plugin
and upload the zip file from step 1 - 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.
- Matomo 5.0
- PHP 7.2.5
- NPM v10.x (part of Node.js 20.x LTS) to be installed on your server, otherwise plugin cannot be activated.
- If you use a UNIX based OS these dependencies are required
Please keep in mind that Performance Audit uses Lighthouse internally in order to perform performance audits in the background for every Matomo tracked URL within the last 1 month. If the Matomo installation has more than 10,000 tracked unique URLs within the last 1 month, it's suggested to either reduce the number of performed audit iterations in the website settings, group URLs in website settings or increase the server resources. For Matomo installations with over 100,000 tracked unique URLs within the last 1 month, this plugin architecture is rather unsuitable and therefor not recommended.
For more screenshots, check out the screenshot overview.
Run the integration and unit tests with:
./console tests:run PerformanceAudit
Please see the CHANGELOG for more information on what has changed recently.
If you have any questions or inquiries, you can contact github{at}diskoboss{døt}de
.
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.
Licensed under the GPLv3 License.