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 69% complete.
Other languages:
English • ‎Türkçe • ‎العربية • ‎বাংলা • ‎中文 • ‎日本語
MediaWiki 拡張機能マニュアル
OOjs UI icon advanced.svg
ApiFeatureUsage
リリースの状態: 安定
実装 特別ページ , API
説明 Access API機能の使用ログ要約
作者 Brad Jorsch (Anomieトーク)
最新バージョン 1.0 (2016-12-07)
互換性ポリシー Snapshots releases along with MediaWiki. Master is not backwards compatible.
MediaWiki 1.25+
PHP 5.5.9+
データベースの変更 いいえ
ライセンス GNU 一般公衆利用許諾書 2.0 以降
ダウンロード
  • $wgApiFeatureUsageQueryEngineConf
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.

依存関係

ログデーターは、何らかのストレージシステムに入れる必要があります。現在はElasticsearchはExtension:Elastica でサポートされています。

インストール

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

設定

パラメーター
  • $wgApiFeatureUsageQueryEngineConfConfiguration array for accessing the log storage backend.
    class
Backend access class to instantiate. これかfactoryのどちらかが必要となります。
  • factory
PHP callable which must return an instance of a backend access class. これかclassのどちらかが必要となります。
Elastica バックエンド(ApiFeatureUsageQueryEngineElastica

$wgApiFeatureUsageQueryEngineConfの追加設定値 :

serverList
Elasticsearchサーバーの配列 必須。
maxConnectionAttempts
接続試行回数の最大値、既定値は1です。
indexPrefix
使用するインデックスの接頭辞。 既定値は"apifeatureusage-"です。
indexFormat
Date formatting for the indexes to use, see the PHP manual. 既定値は"Y.m.d"です。
type
Elasticsearch type to query. 既定値は"api-feature-usage-sanitized"です。
featureField
Field name for the logged value of $feature. 既定値は"feature"です。
timestampField
Field name for the logged timestamp. 既定値は"@timestamp"です。
agentField
ログのユーザーエージェントのフィールド名。 既定値は"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.

関連項目