Extension:ApiFeatureUsage/pl

Podręcznik rozszerzeń MediaWiki

ApiFeatureUsage Status wydania: stabilne
Realizacja	Strona specjalna , API
Opis	Access API feature usage log summaries
Autor(zy)	Brad Jorsch (Anomiedyskusja)
Ostatnia wersja	1.0 (2016-12-07)
Polityka zgodności	Snapshots releases along with MediaWiki. Master nie jest kompatybilny wstecznie.
MediaWiki	1.25+
PHP	5.5.9+
Zmiany w bazie danych	Nie
Licencja	Licencja GNU General Public License 2.0 lub nowsza
Pobieranie	Pobierz rozszerzenie Git [?]: przeglądaj repozytorium (GitHub) ocena kodu historia wprowadzeń Download source tarball
Parametry $wgApiFeatureUsageQueryEngineConf
Użyte haki ApiDeprecationHelp ApiLogFeatureUsage LoadExtensionSchemaUpdates
Translate the ApiFeatureUsage extension
Problemy	Otwarte zadania · Zgłoś błąd

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.

Zależności

Log data must be added to some sort of storage system. Currently Elasticsearch is supported via Extension:Elastica .

Instalacja

• Pobierz i umieść plik(i) w katalogu o nazwie ApiFeatureUsage w folderze extensions/.
  Developers and code contributors should install the extension from Git instead, using:

  cd extensions/
  git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/ApiFeatureUsage
  

• Dodaj poniższy kod na dole twojego pliku LocalSettings.php :

  wfLoadExtension( 'ApiFeatureUsage' );
  

• Zrobione – Przejdź do Special:Version na twojej wiki, aby sprawdzić czy rozszerzenie zostało pomyślnie zainstalowane.

Konfiguracja

Parameters

Name	Description
$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".

Użycie

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.

Zobacz też

• Extension:Elastica