Matomo Application
 | Extension to setup Matomo Tracking in XWiki |
| Type | XAR |
| Category | |
| Developed by | Ludovic Dubost, Cami Andrei, Paul Pantiru |
| Active Installs | 38 |
| Rating | |
| License | GNU Lesser General Public License 2.1 |
| Compatibility | Should work with most versions of XWiki since at least version 3.0 |
Description
Extension to setup Matomo (previously named Piwik) Tracking in XWiki. Matomo is the very popular Open Source alternative to Google Analytics (you can take a look at their demo server).
To use Matomo in XWiki, visit the Piwik tab in the Administration and fill the various fields as explained below:
Matomo Configuration
- Take a look on the Matomo website for the Matomo server installation guide.
- Each tracked website has a dedicated "SITE ID" on the Matomo server, you can find the information on Administration>Websites>Manage:
Example
What information this extension asks to be tracked from the wiki?
- pageview tracking
- link tracking
- if the user tracking is activated the current xwiki user page name ($xcontext.user)
- if the multidomain tracking is activated, the document title and the document domain
Troubleshooting
Why are some users not tracked in Matomo?
- An user could disable tracking from his browser: https://en.wikipedia.org/wiki/Do_Not_Track.
- Using a different domain (or the direct IP) to access the wiki may impact the tracked results.
- Actions taken on different browser can be grouped by user on a single Entry so it may appear they are "not recorded" (See How a visit is defined in Matomo?)
- Check the status of "Respect DoNotTrack preference" option from Matomo (see https://matomo.org/docs/privacy/)
- Check for Ad blockers on the user side (see also https://github.com/matomo-org/matomo/issues/7364)
How to check Matomo requests?
- The Matomo requests done from XWiki can be checked when specific actions don't seem to be recorded (maybe on a specific browser or a specific user)
- Example on Firefox:
Prerequisites & Installation Instructions
We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.
You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:
- Log in the wiki with a user having Administration rights
- Go to the Administration page and select the Import category
- Follow the on-screen instructions to upload the downloaded XAR
- Click on the uploaded XAR and follow the instructions
- You'll also need to install all dependent Extensions that are not already installed in your wiki
Release Notes
v1.5.1
v1.5
The following translations have been updated with this release:
v1.4
v1.3.3
Fix parent pom
v1.3.2
v1.3.1
v1.3
v1.2
v1.1
v1.0
Initial version
Dependencies
Dependencies for this extension (org.xwiki.contrib:application-piwik-extension 1.5.1):
- org.xwiki.platform:xwiki-platform-localization-macro 8.4
- org.xwiki.platform:xwiki-platform-rendering-macro-velocity 8.4
- org.xwiki.platform:xwiki-platform-rendering-macro-include 8.4
- org.xwiki.rendering:xwiki-rendering-macro-html 8.4
