Phabricator のプロジェクト名 #ApiFeatureUsage

Extension:ApiFeatureUsage

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Extension:ApiFeatureUsage and the translation is 86% complete.
Other languages:
English • ‎中文 • ‎日本語
MediaWiki 拡張機能マニュアル
OOjs UI icon advanced.svg
ApiFeatureUsage
リリースの状態: 安定
実装 特別ページ , API
説明 Access API feature usage log summaries
作者 Brad Jorsch (Anomietalk)
最新バージョン 1.0 (2016-12-07)
互換性ポリシー リリースブランチ
MediaWiki 1.25+
PHP 5.5.9+
データベースの変更 いいえ
ライセンス GNU 一般公衆利用許諾書 2.0 以降
ダウンロード
$wgApiFeatureUsageQueryEngineConf
translatewiki.net で翻訳を利用できる場合は、ApiFeatureUsage 拡張機能の翻訳にご協力ください
使用状況とバージョン マトリクスを確認してください。
問題点 未解決のタスク · バグを報告

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.

インストール

  • ダウンロードして、ファイルを extensions/ フォルダー内の ApiFeatureUsage という名前のディレクトリ内に配置します。
  • 以下のコードを LocalSettings.php の末尾に追加します:
    require_once "$IP/extensions/ApiFeatureUsage/ApiFeatureUsage.php";
    
  • Yes 完了 – ウィキの「Special:Version」に移動して、拡張機能が正しくインストールされたことを確認します。

設定

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

使用法

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.

関連項目