Extension:Matomo

From mediawiki.org
This page is a translated version of the page Extension:Matomo and the translation is 100% complete.
Manuel des extensions MediaWiki
Matomo
État de la version : stable
Implémentation Activité utilisateur
Description Insère le script Matomo dans les pages pour le suivi
Auteur(s)
Dernière version 5.0.0 (2023-10-27)
MediaWiki 1.34+
PHP 7.2+
Composer mediawiki/matomo
Licence Licence publique générale GNU v2.0 ou supérieur
Téléchargement
README

  • $wgMatomoIDSite
  • $wgMatomoURL
  • $wgMatomoIgnoreEditors
  • $wgMatomoIgnoreSysops
  • $wgMatomoIgnoreBots
  • $wgMatomoCustomJS
  • $wgMatomoUsePageTitle
  • $wgMatomoActionName
  • $wgMatomoDisableCookies
  • $wgMatomoProtocol
  • $wgMatomoTrackUsernames
  • $wgMatomoJSFileURL

L'extension Matomo (anciennement Piwik Integration) insère votre code de trace Matomo (anciennement Piwik) en bas de chaque page. Elle peut exclure les vues des utilisateurs ayant le priviliège bot (les robots) ainsi que protect (administrateurs système).

Cette extension est basée sur l'extension Google Analytics Integration de Tim Laqua.

Elle a été renommée en février 2019 de Piwik Integration en Matomo, étant donné que le logiciel sur lequel elle s'appuie a changé de nom en janvier 2018 (plus d'informations).

Installation

  • Téléchargez et placez le(s) fichier(s) dans un répertoire appelé Matomo dans votre dossier extensions/.
  • Ajoutez le code suivant à la fin de votre fichier LocalSettings.php  :
    wfLoadExtension( 'Matomo' );
    
  • Configurez l'URL de Matomo et l'ID du site en initialisant les variables suivantes sous l'appel de cette extension :
$wgMatomoURL = "matomo-host.tld/dir";
$wgMatomoIDSite = "piwik_idsite";

Vérifiez avoir initialisé $wgMatomoIDSite avec l'ID de votre site dans Matomo. Pour le premier site, cet ID sera habituellement 1. Dans Matomo, cliquer sur le lien Administration dans le menu supérieur et aller sur la page Websites. Sur cette page vous trouverez la liste de tous les sites web. L'ID du site web se trouve à gauche de cette table qui liste tous les sites web.[1]

Ne déclarez pas le protocole de $wgMatomoURL.
  • Yes Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.
  • Vous pouvez essayer de visiter une page quelconque du wiki et vérifier si cette visite est visible dans Matomo. Si non, vérifiez que votre profil n’est pas ignoré (par exemple si vous êtes administrateur et que $wgMatomoIgnoreSysops est true) et vérifiez cette documentation d’aide sur Matomo.org.


Mise à jour

Cette extension a été renommée de Piwik Integration en Matomo à partir de la version 4.0 :

  • si vous l'avez installé avec Composer, renommez le paquet mediawiki/piwik-integration en mediawiki/matomo;
  • si vous l'avez installé comme une extension classique MediaWiki, renommez le dossier Piwik ou Piwik Integration en Matomo.

Dans les deux cas, vous devrez activer maintenant explicitement l'extension avec wfLoadExtension( 'Matomo' );

Paramètres de configuration

Désactivez les cookies en mettant la variable $wgMatomoDisableCookies à true  :

$wgMatomoDisableCookies = true;

Pour déclarer des balises personnalisées JavaScript dans le JavaScript Matomo, vous pouvez définir la variable $wgMatomoCustomJS. Par exemple, pour insérer une seule déclaration, utiliser le code suivant :

$wgMatomoCustomJS = "_paq.push(['trackGoal', '1']);";

Si vous devez définir plusieurs variables, utilisez un tableau. Par exemple :

$wgMatomoCustomJS = array( 
    "_paq.push(['setCustomVariable', '1','environment','production']);",
    "_paq.push(['setCustomVariable', '1','is_user','yes']);"
);

Pour modifier le titre de vos pages dans le traceur Matomo, initialisez $wgMatomoActionName dans votre fichier LocalSettings.php.

Pour inclure le titre par exemple sous la forme « wiki/Titre de la page », vous pouvez mettre $wgMatomoUsePageTitle à true et $wgMatomoActionName à wiki/. L'extension imprimera piwik_action_name = 'wiki/Titre de la page';

En mettant $wgMatomoIgnoreSysops à false vous permettez à Matomo de compter également les pages vues par les utilisateurs MediaWiki ayant les droits protect. Par défaut, les administrateurs système ont ce droit et donc - toujours par défault - les pages qu'ils ont vues ne sont pas comptabilisées. Valeur par défaut : $wgMatomoIgnoreSysops = true.

En initialisant $wgMatomoIgnoreBots à false, vous pouvez indiquer à Matomo de compter également les pages vues par les utilisateurs MediaWiki ayant les droits 'bot' (robots). Par défaut le nombre de vues de ces pages n'est pas comptabilisé. Valeur par défaut : $wgMatomoIgnoreBots = true

Quand JavaScript est désactivé, il existe une méthode de repli utilisant une image cachée. Vous pouvez déclarer le protocole (HTTP ou HTTPS) appelant cette image avec $wgMatomoProtocol avec l'une des valeurs suivantes : 'http', 'https', 'auto' (protocole mis à jour automatiquement en fonction des protocoles utilisés par le wiki).

A partir de Matomo 2.7.0 vous pouvez initialiser $wgMatomoTrackUsernames si vous souhaitez enregistrer le nom des utilisateurs connectés dans Matomo.

Si vous utilisez un CDN pour distribuer le fichier piwik.js, il faut que la version incorpore cette demande d'obtention (2.4.3+) et vous pouvez déclarer $wgMatomoJSFileURL = 'assets.example.org/piwik.js'; (n'écrivez pas le protocole http:// ni https://, il est ajouté automatiquement); le paramètre $wgMatomoURL doit encore être configuré avec le server Matomo qui récupère les analyses.

Tracer avec MobileFrontend

Suite à un bogue dans Hooks/SkinAfterBottomScripts , Matomo ne fonctionne pas dans le mode 'vue pour mobile' avec l'Extension MobileFrontend.

Si vous souhaitez tracer dans les deux modes (bureau et mobile), mettez en commentaire ou supprimez les entrées Matomo dans LocalSettings.php et ajoutez au fichier :

$wgUseSiteJS = true;

Puis collez le code de trace de Matomo généré par le tableau de bord de Matomo, dans http://www.example.com/wiki/MediaWiki:Common.js. Matomo trace dorénavant les utilisateurs à la fois dans la version pour bureau et dans la version pour mobile. Attention : ce contournement rend actuellement (1er octobre 2015), l'Extension VisualEditor non compatible.

Configuration de Matomo optimisée pour MediaWiki

Paramètres de recherche

Par défaut Matomo reconnait les recherches avec le moteur de recherche interne (la page Special:Search), car le paramètre d'URL utilisé par MediaWiki (c'est à dire search) se trouve dans les paramètres reconnus par défaut.

Ceci peut être légèrement amélioré en initialisant les paramètres suivants :

  • Paramètre de requête = search — ceci va supprimer certains faux positifs comparé à la valeur par défaut;
  • Paramètre de catégorie = profile — Matomo va reconnaître comme catégorie recherchée, le profil en haut de la page de recherche de MediaWiki.

Cela peut être soit des paramètres globaux dans Administration > Sites web > Paramètres > Tracer les recherches internes du site, ou de préférence dans la configuration spécifique au site c'est à dire dans Administration > Sites web > Gérer > [votre wiki] > Modifiez et décochez Utiliser les paramètres de recherche par défaut du site et saisir les paramètres.

Voir aussi

Références