Jump to content

Extension:ApiFeatureUsage/pt

From mediawiki.org
This page is a translated version of the page Extension:ApiFeatureUsage and the translation is 3% complete.
Manual de extensões do MediaWiki
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 (Anomiediscussão)
Ú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 GNU - Licença Pública Geral 2.0 ou superior
Transferência
  • $wgApiFeatureUsageQueryEngineConf
Quarterly downloads 16 (Ranked 115th)
Public wikis using 847 (Ranked 303rd)
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

  • Exporte e coloque o ficheiro, ou ficheiros, num diretório chamado ApiFeatureUsage, na sua pasta 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
  • Acrescente o seguinte código ao fundo do ficheiro $LocalSettings:
    wfLoadExtension( 'ApiFeatureUsage' );
    
  • Yes Pronto – Na página especial Special:Version da sua wiki verifique se a extensão foi instalada.

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