Extension:EventLogging

L'extension EventLogging permet de collecter des données structurées sur la manière dont les utilisateurs interagisssent avec les sites MediaWiki.

• EventLogging prend en charge la connexion à partir du JavaScript côté client et du côté serveur à partir de PHP.
• Le comportement de la connexion peut être configuré dynamiquement en utilisant Extension:EventStreamConfig .
• Les événements sont des objets JSON définis par des schémas JSON versionnés (JSONSchemas) enregistrés dans dépôt Git de schémas.
• L'extension n'inclut aucun code du serveur pour transporter, analyser ou charger ces événements. Si vous êtes intéressé par les composants séparés que Wikimedia utilise à ce sujet, voir la section EventLogging pour Wikimedia.

Cette page concerne l'utilisation générale de l'extension EventLogging.

La Fondation Wikimedia utilise l'extension EventLogging comme partie d'un système plus large de collecte, d'agrégation, d'enregistrement et d'analyse des données utilisateur à l'intérieur des limites fixées par notre politique de confidentialité et nos règles de conservation des données. Pour la documentation spécifique à ce système voir wikitech:Event Platform.

• Téléchargez et placez le(s) fichier(s) dans un répertoire appelé EventLogging dans votre dossier extensions/.
  Les développeurs et les contributeurs au code doivent à la place installer l'extension à partir de Git en utilisant:

  cdextensions/
  gitclonehttps://gerrit.wikimedia.org/r/mediawiki/extensions/EventLogging
  

• Ajoutez le code suivant à la fin de votre fichier LocalSettings.php  :

  wfLoadExtension( 'EventLogging' );
  $wgEventLoggingBaseUri = '/beacon/event';
  $wgEventLoggingServiceUri = '/beacon/intake-analytics';
  $wgEventLoggingStreamNames = false;
  

• Yes Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.

Installer Vagrant :

• Si vous utilisez Vagrant , installez avec vagrant roles enable eventlogging --provision

Par défaut, l'extension cherche les schémas sur Meta-Wiki. Les paramètres par défaut significatifs sont :

# (default) $wgEventLoggingSchemaApiUri = 'https://meta.wikimedia.org/w/api.php';
# (default) $wgEventLoggingDBname = 'metawiki';

Pour utiliser des schémas locaux, ou des schémas du wiki central de votre propre ferme de wikis, il faut réécrire ces lignes. Par exemple pour utiliser l'espace de noms Schema du wiki local, déclarez :

$wgEventLoggingSchemaApiUri = $wgServer . '/w/api.php';
$wgEventLoggingDBname = $wgDBname;

(et assurez-vous que le compte utilisateur qui va créer les schémas est autoconfirmé).

• Extension:EventLogging/Guide – pour développer et déployer les schémas EventLogging, et plus
• Extension:EventLogging/Programming – conseils et suggestions pour les développeurs qui écrivent du code pour tracer les événements

En tant que développeur, vous voudrez configurer et utiliser EventLogging sur votre wiki de développement pour simuler son utilisation en production.

Voir MediaWiki-Docker/Configuration recipes/EventLogging

Si vous développez avec mediawiki-vagrant, tout ce dont vous avez besoin est encapsulé dans le rôle eventlogging. Pour l'activer, exécutez :

$ vagrantrolesenableeventlogging
$ vagrantprovision

Si vous travaillez sur le client JavaScript, vous devrez installler les dépendances avec npm install à partir du dossier dans lequel vous développez. Puis vous pouvez utiliser npm test pour exécuter ESLint par exemple. La section « Comment exécuter les tests » ci-dessous montre comment voir le résultat des tests JavaScript.

Lorsque vous ajoutez le paramètre trackdebug=true à l'URL, la console des outils développeur du navigateur affiche l'événement tracé en cours de traitement.

Il existe des tests PHP, Python, et JavaScript.

Pour exécuter les tests JavaScript, visitez Special:JavaScriptTest/qunit sur votre wiki de développement. (Voir Manuel:Tests unitaires JavaScript ).

Pour exécuter les tests PHP, nous utilisons PHPUnit. Vérifiez qu'elle est installée, puis :

$ vagrantssh
vagrant@mediawiki-vagrant:/vagrant/mediawiki$ composerphpunit:entrypoint--extensions/EventLogging/testsEventLoggingExtensionFunctionsTest.php

• Stable extensions/fr
• Special page extensions/fr
• Database extensions/fr
• ContentHandler extensions/fr
• ApiMain::moduleManager extensions/fr
• BeforePageDisplay extensions/fr
• CanonicalNamespaces extensions/fr
• CodeEditorGetPageLanguage extensions/fr
• EditFilterMergedContent extensions/fr
• GetPreferences extensions/fr
• MovePageIsValidMove extensions/fr
• GPL licensed extensions/fr
• Extensions in Wikimedia version control/fr
• All extensions/fr
• Extensions used on Wikimedia/fr
• Extensions included in Canasta/fr
• Extensions included in Miraheze/fr
• Analytics extensions/fr
• Statistics extensions/fr

• Extensions with manual MediaWiki version/fr