Extension:ApiFeatureUsage
 État de la version : stable |
|
|---|---|
| Implémentation | Page spéciale, API |
| Description | Access API feature usage log summaries |
| 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échargements trimestriels | 24 (Ranked 156th) |
| Utilisé par les wikis publics | 847 (Ranked 302nd) |
| Traduire l’extension ApiFeatureUsage | |
| Problèmes | Tâches ouvertes · Signaler un bogue |
The ApiFeatureUsage extension adds a special page and an API module to fetch summaries of data logged by ApiBase::logFeatureUsage(), which is typically an indication of use of deprecated API features.
Dépendances
Log data must be added to some sort of storage system. Currently Elasticsearch is supported via Extension:Elastica.
Installation
- Téléchargez et placez le(s) fichier(s) dans un répertoire appelé
ApiFeatureUsagedans votre dossierextensions/. - 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.
Configuration
- Parameters
| Name | Description |
|---|---|
$wgApiFeatureUsageQueryEngineConf
|
Configuration array for accessing the log storage backend.
|
- Elastica backend (
ApiFeatureUsageQueryEngineElastica)
Additional configuration values in $wgApiFeatureUsageQueryEngineConf:
serverList- Array of Elasticsearch servers. Required.
maxConnectionAttempts- Maximum connection attempts, default 1.
indexPrefix- Prefix for the indexes to use. Default "
apifeatureusage-". indexFormat- Date formatting for the indexes to use, see the PHP manual. Default "
Y.m.d". type- Elasticsearch type to query. Default "
api-feature-usage-sanitized". featureField- Field name for the logged value of $feature. Default "
feature". timestampField- Field name for the logged timestamp. Default "
@timestamp". agentField- Field name for the logged user agent. Default "
agent".
Utilisation
The extension adds a new special page, Special:ApiFeatureUsage, with a simple form to request a summary of feature usage logs for a user agent and date range.
The extension also adds an API query submodule, meta=featureusage.
See the auto-generated API documentation for details.
Voir aussi
| 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. |