Extension:ApiFeatureUsage/pl

This page is a translated version of the page Extension:ApiFeatureUsage and the translation is 3% complete.
Podręcznik rozszerzeń MediaWiki
OOjs UI icon advanced-invert.svg
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 is not backward compatible.
MediaWiki 1.25+
PHP 5.5.9+
Zmiany w bazie danych Nie
Licencja GNU General Public License 2.0 or later
Pobieranie
  • $wgApiFeatureUsageQueryEngineConf
Translate the ApiFeatureUsage extension

Sprawdź wykorzystywanie i matrycę wersji.

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.

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

Installation

  • Pobierz i umieść plik(i) w katalogu o nazwie ApiFeatureUsage w folderze extensions/.
  • Dodaj poniższy kod na dole swojego pliku LocalSettings.php :
    wfLoadExtension( 'ApiFeatureUsage' );
    
  • Yes Zrobione – Przejdź do Special:Version na swojej wiki, aby sprawdzić czy rozszerzenie zostało pomyślnie zainstalowane.

Configuration

Parameters
  • $wgApiFeatureUsageQueryEngineConfConfiguration 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".

Usage

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ż