Issue tracker: #ApiFeatureUsage

Extension:ApiFeatureUsage/pt

From Linux Web Expert

Manual de extensões do MediaWiki
File:OOjs UI icon advanced-invert.svg
ApiFeatureUsage
Estado de lançamento: estável
Implementação Página espacial , API
Descrição Access API feature usage log summaries
Autor(es) Brad Jorsch (Anomietalk)
Última versão 1.0 (2016-12-07)
Política de compatibilidade Lançamentos de capturas de ecrã junto com o MediaWiki. Original não é compatível com versões anteriores.
MediaWiki 1.25+
PHP 5.5.9+
Alterações à base de dados Não
Licença Licença não especificada
Transferência
<translate> Download extension</translate>
<translate> Git</translate> [?]:
Quarterly downloads Lua error in Module:Extension at line 172: bad argument #1 to 'inNamespace' (unrecognized namespace name 'skin').
Public wikis using Lua error in Module:Extension at line 172: bad argument #1 to 'inNamespace' (unrecognized namespace name 'skin').
Traduza a extensão ApiFeatureUsage
Problemas Tarefas em aberto · Reportar um erro

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.

Dependências

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

Installation

  • <translate> [[<tvar name=2>Special:ExtensionDistributor/ApiFeatureUsage/pt</tvar>|Download]] and move the extracted <tvar name=name>ApiFeatureUsage/pt</tvar> folder to your <tvar name=ext>extensions/</tvar> directory.</translate>
    <translate> Developers and code contributors should install the extension [[<tvar name=git>Special:MyLanguage/Download from Git</tvar>|from Git]] instead, using:</translate>cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/ApiFeatureUsage%2Fpt
  • <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar> file:</translate> 
    wfLoadExtension( 'ApiFeatureUsage/pt' );
  • File:OOjs UI icon check-constructive.svg <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>

Configuration

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".

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.

See also

Retrieved from "https://www.linuxwebexpert.com/wiki/index.php?title=Extension:ApiFeatureUsage/pt&oldid=50544"