Rozšíření:ApiFeatureUsage
From mediawiki.org
This page is a translated version of the page Extension:ApiFeatureUsage and the translation is 100% complete.
Languages:
Stav rozšíření: stabilní |
|
|---|---|
| Implementace | Speciální stránka , API |
| Popis | Přehledy protokolu využití funkcí Access API |
| Autoři | Brad Jorsch (Anomie diskuse ) |
| Nejnovější verze | 1.0 (2016年12月07日) |
| Zásady kompatibility | Vydání snímků současně s MediaWiki. Hlavní vývojová větev není zpětně kompatibilní. |
| MediaWiki | 1.25+ |
| PHP | 5.5.9+ |
| Změny v databázi | Ne |
| Virtuální doména | virtual-apifeatureusage |
|
|
| Licence | GNU General Public License 2.0 nebo novější |
| Stáhnout | |
| Přeložte rozšíření ApiFeatureUsage | |
| Problémy | Otevřené úkoly · Nahlásit chybu |
Rozšíření ApiFeatureUsage přidává speciální stránku a modul API pro načítání souhrnů dat zaznamenaných pomocí ApiBase::logFeatureUsage(), což je obvykle známkou použití zastaralých funkcí API.
Závislosti
Data protokolů musí být přidána do nějakého úložného systému. V současné době je Elasticsearch podporován prostřednictvím služby Extension:Elastica .
Instalace
- Stáhněte soubor/y a vložte je do adresáře pojmenovaného
ApiFeatureUsageve vaší složceextensions/.
Vývojáři a přispěvatelé kódu by si místo toho měli nainstalovat rozšíření from Git pomocí:cdextensions/ gitclonehttps://gerrit.wikimedia.org/r/mediawiki/extensions/ApiFeatureUsage - Na konec vašeho souboru LocalSettings.php přidejte následující kód:
wfLoadExtension( 'ApiFeatureUsage' );
- Yes Dokončeno – Přejděte na stránku
Special:Versionvaší wiki a zkontrolujte, zda bylo rozšíření úspěšně nainstalováno.
Nastavení
- Parametry
| Name | Description |
|---|---|
$wgApiFeatureUsageQueryEngineConf
|
Konfigurační pole pro přístup k backendu úložiště protokolů.
|
| Name | Required? | Description | Default |
|---|---|---|---|
serverList |
Požadované | Pole serverů Elasticsearch. | |
maxConnectionAttempts |
Volitelné | Maximální počet pokusů o připojení, výchozí hodnota je 1. | 1 |
indexPrefix |
Volitelné | Předpona pro indexy, které se mají použít. | apifeatureusage-
|
indexFormat |
Volitelné | Formátování data pro indexy, které se mají použít, viz příručka PHP. | Y.m.d
|
type |
Volitelné | Typ Elasticsearch pro dotaz. | api-feature-usage-sanitized
|
featureField |
Volitelné | Název pole pro zaznamenanou hodnotu $feature. | feature
|
timestampField |
Volitelné | Název pole pro zaznamenané časové razítko. | @timestamp
|
agentField |
Volitelné | Název pole pro přihlášeného uživatelského agenta. | agent
|
Použití
Rozšíření přidává novou speciální stránku s názvem Special:ApiFeatureUsage s jednoduchým formulářem pro vyžádání souhrnu protokolů využití funkcí pro daného uživatelského agenta a rozsah dat.
Rozšíření také přidává submodul dotazů API s názvem meta=featureusage.
Podrobnosti naleznete v automaticky generované dokumentaci k API.
Související odkazy
Toto rozšíření se používá na jednom nebo více projektech Wikimedia. Pravděpodobně to znamená, že rozšíření je stabilní a funguje dostatečně dobře, aby jej mohly používat weby s tak vysokou návštěvností. Vyhledejte tento název rozšíření v konfiguračních souborech CommonSettings.php a InitialiseSettings.php Wikimedie, abyste viděli, kde je nainstalováno. Úplný seznam rozšíření nainstalovaných na konkrétní wiki lze vidět na stránce wiki Special:Version.