拡張機能:ApiFeatureUsage

MediaWiki 拡張機能マニュアル

ApiFeatureUsage リリースの状態: 安定
実装	特別ページ , API
説明	API 機能の使用記録の要約にアクセスする
作者	Brad Jorsch (Anomieトーク)
最新バージョン	1.0 (2016-12-07)
互換性の方針	MediaWiki とともにリリースされるスナップショット。 master には後方互換性がありません。
MediaWiki	1.25+
PHP	5.5.9+
データベースの変更	いいえ
ライセンス	GNU 一般公衆利用許諾書 2.0 以降
ダウンロード	拡張機能をダウンロード Git [?]: リポジトリを参照 (GitHub) Gerrit コード レビュー Git コミット ログ Download source tarball
パラメーター $wgApiFeatureUsageQueryEngineConf
使用するフック ApiDeprecationHelp ApiLogFeatureUsage LoadExtensionSchemaUpdates
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という名前のディレクトリ内に配置します。
  開発者とコード寄稿者は、上記の代わりに以下を使用してGitからインストールします:

  cd extensions/
  git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/ApiFeatureUsage
  

• 以下のコードを LocalSettings.php ファイルの末尾に追加します:

  wfLoadExtension( 'ApiFeatureUsage' );
  

• 完了 – ウィキの「Special:Version」に移動して、拡張機能が正しくインストールされたことを確認します。

設定

パラメーター

Name	Description
$wgApiFeatureUsageQueryEngineConf	ログストレージのバックエンドにアクセスするための設定配列。 class インスタンス化するバックエンドのアクセスクラス。 これかfactoryのどちらかが必要となります。 factory バックエンドアクセスクラスのインスタンスを返さなければならない PHP の callable。 これかclassのどちらかが必要となります。

Elastica バックエンド（ApiFeatureUsageQueryEngineElastica）

$wgApiFeatureUsageQueryEngineConfの追加設定値 :

serverList

Elasticsearchサーバーの配列 必須。

maxConnectionAttempts

接続試行回数の最大値、既定値は1です。

indexPrefix

使用するインデックスの接頭辞。 既定値は"apifeatureusage-"です。

indexFormat

使用するインデックスの日付フォーマット。the PHP manualを参照してください。 既定値は"Y.m.d"です。

type

クエリの対象となるElasticsearchのタイプ。 既定値は"api-feature-usage-sanitized"です。

featureField

ログに記録された値「$feature」のフィールド名。 既定値は"feature"です。

timestampField

ログアウトしたタイムスタンプのフィールド名。 既定値は"@timestamp"です。

agentField

ログのユーザーエージェントのフィールド名。 既定値は"agent"です。

使用法

この拡張機能では、新しい特別ページ「Special:ApiFeatureUsage」が追加され、ユーザーエージェントと日付範囲の機能使用ログの要約を要求する簡単なフォームが用意されています。

この拡張機能では、APIクエリサブモジュール「meta=featureusage」も追加されています。 詳細は自動生成されたAPIドキュメントを参照してください。

関連項目

• Extension:Elastica