Extension:ApiFeatureUsage

Manuel des extensions MediaWiki

ApiFeatureUsage État de la version : stable
Implémentation	Page spéciale , API
Description	Accès au résumé des journaux de l'utilisation des fonctions de l'API
Auteur(s)	Brad Jorsch (Anomiediscussion)
Dernière version	1.0 (2016-12-07)
Politique de compatibilité	Versions ponctuelles alignées avec MediaWiki. Le master n'est pas compatible arrière.
MediaWiki	1.25+
PHP	5.5.9+
Modifie la base de données	Non
Licence	Licence publique générale GNU v2.0 ou supérieur
Téléchargement	Télécharger l'extension Git [?]: Télécharger la branche master de Git parcourir le dépôt (GitHub) historique des validations (commits) contributeurs du dépôt (GitHub) relecture du code
Paramètres $wgApiFeatureUsageQueryEngineConf
Accroches utilisées ApiDeprecationHelp ApiLogFeatureUsage LoadExtensionSchemaUpdates
Téléchargements trimestriels	16 (Ranked 113rd)
Utilisé par les wikis publics	847 (Ranked 303rd)
Traduire l’extension ApiFeatureUsage
Problèmes	Tâches ouvertes · Signaler un bogue

L'extension ApiFeatureUsage ajoute une page spéciale et un module API pour récupérer les résumés des données enregistrées par ApiBase::logFeatureUsage(), ce qui est typiquement une indication de l'utilisation de fonctionnalités obsolètes de l'API.

Les données des journaux doivent être ajoutées à un système de stockage. Actuellement, Elasticsearch est pris en charge via Extension:Elastica .

• Téléchargez et placez le(s) fichier(s) dans un répertoire appelé ApiFeatureUsage dans votre dossier extensions/.
  Les développeurs et les contributeurs au code doivent à la place installer l'extension à partir de Git en utilisant:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/ApiFeatureUsage
• Ajoutez le code suivant à la fin de votre fichier LocalSettings.php  :

  wfLoadExtension( 'ApiFeatureUsage' );
  

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

Paramètres

Serveur Elastica (ApiFeatureUsageQueryEngineElastica)

Valeur de configuration supplémentaires dans $wgApiFeatureUsageQueryEngineConf :

serverList

Tableau des serveurs Elasticsearch. Nécessaire.

maxConnectionAttempts

Nombre maximum de tentatives de connexion; valeur par défaut : 1.

indexPrefix

Préfixe à utiliser pour les indices. Valeur par défaut : apifeatureusage-.

indexFormat

Fomat de la date pour les indices à utiliser, voir le manuel PHP. Valeur par défaut : Y.m.d.

type

Type Elasticsearch à demander. Valeur par défaut : api-feature-usage-sanitized.

featureField

Nom de champ pour la valeur enregistrée de $feature. Valeur par défaut : feature.

timestampField

Nom de champ de l'horodatage enregistré. Valeur par défaut : @timestamp.

agentField

Nom de champ de l'agent utilisateur enregistré. Valeur par défaut : agent.

L'extension ajoute la nouvelle page spéciale Special:ApiFeatureUsage, avec un formulaire simple pour demander un résumé des journaux d'utilisation des fonctionnalités pour un agent utilisateur et un intervalle de dates donné.

L'extension ajoute aussi le sous-module meta=featureusage de requête à l'API. Voir la documentation auto-générée de l'API pour les détails.

• Extension:Elastica

Cette extension est utilisée par au moins un des projets Wikimédia. Cela signifie probablement que l’extension est assez stable et fonctionnelle pour être utilisée sur des sites à fort trafic. Recherchez le nom de cette extension dans le CommonSettings.php de Wikimédia et dans le fichier de configuration InitialiseSettings.php pour situer les endroits où elle est installée. Une liste complète des extensions installées sur un Wiki donné peut être visualisée sur la page Special:Version de ce wiki.