Erweiterung:ApiFeatureUsage
![]() Freigabestatus: stabil |
|
---|---|
Einbindung | Spezialseite , API |
Beschreibung | Access API feature usage log summaries |
Autor(en) | Brad Jorsch (AnomieDiskussion) |
Letzte Version | 1.0 (2016-12-07) |
Kompatibilitätspolitik | Snapshots releases along with MediaWiki. Master is not backward compatible. |
MediaWiki | 1.25+ |
PHP | 5.5.9+ |
Datenbankänderungen | Nein |
Lizenz | GNU General Public License 2.0 oder neuer |
Herunterladen | |
|
|
Übersetze die ApiFeatureUsage-Erweiterung | |
Probleme | Offene Aufgaben · Einen Fehler melden |
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.
Dependencies
Log data must be added to some sort of storage system. Currently Elasticsearch is supported via Extension:Elastica .
Installation
- Die Erweiterung herunterladen und die Datei(en) in ein Verzeichnis namens
ApiFeatureUsage
im Ordnerextensions/
ablegen. - Folgenden Code am Ende deiner
LocalSettings.php
hinzufügen:wfLoadExtension( 'ApiFeatureUsage' );
- Erledigt – Zu Special:Version in dem Wiki (bei Einstellung auf deutsch nach Spezial:Version) navigieren, um die erfolgreiche Installierung der Erweiterung zu überprüfen.
Konfiguration
- Parameter
$wgApiFeatureUsageQueryEngineConf
— Configuration array for accessing the log storage backend.class
- Backend access class to instantiate. Either this or factory is required.
factory
- PHP callable which must return an instance of a backend access class. Either this or class is required.
- 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
".
Verwendung
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.
Siehe auch
Diese Erweiterung wird in einem oder mehreren Wikis von Wikimedia verwendet. Das bedeutet mit hoher Wahrscheinlichkeit, dass die Erweiterung stabil ist und gut genug funktioniert, um auf solch häufig besuchten Webseiten benutzt zu werden. Suche nach dem Erweiterungs-Namen in den Wikimedia CommonSettings.php und den InitialiseSettings.php-Konfigurations-Dateien, um zu nachzusehen, wo es installiert ist. Eine vollständige Liste der installierten Erweiterungen in einem bestimmten Wiki wird auf Special:Version im Wiki generiert und angezeigt. |