扩展:ApiFeatureUsage

This page is a translated version of the page Extension:ApiFeatureUsage and the translation is 34% complete.
MediaWiki的扩展的手冊
OOjs UI icon advanced-invert.svg
ApiFeatureUsage
發佈狀態: 穩定版本
实现 特殊页面 , API
描述 Access API功能使用日志摘要
作者 Brad Jorsch (Anomie讨论)
最新版本 1.0 (2016-12-07)
兼容性政策 快照跟随MediaWiki发布。 master分支不向後兼容。
MediaWiki 1.25+
PHP 5.5.9+
数据库更改
许可协议 GNU通用公眾授權條款2.0或更新版本
下載
  • $wgApiFeatureUsageQueryEngineConf
季度下載量 23 (Ranked 147th)
公開的wiki使用 812 (Ranked 288th)
翻譯ApiFeatureUsage的扩展
問題 尚未完成的工作 · 报告錯誤

ApiFeatureUsage 扩展添加了一个特殊页面和一个 API 模块来获取 ApiBase::logFeatureUsage() 记录的数据摘要,这通常表明使用了已弃用的 API 功能。

依赖性

日志数据必须添加到某种存储系统中。目前 Elasticsearch 通过 扩展:Elastica 获得支持。

安裝

  • 下载文件,并将其放置在您extensions/文件夹中的ApiFeatureUsage目录内。
  • 将下列代码放置在您的LocalSettings.php 的底部:
    wfLoadExtension( 'ApiFeatureUsage' );
    
  •   完成 – 在您的wiki上导航至Special:Version,以验证已成功安装扩展。

配置

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

用法

该扩展添加了一个新的特殊页面 Special:ApiFeatureUsage,其中包含一个简单的表单来请求用户代理和日期范围内的功能使用日志摘要。

该扩展还添加了一个 API 查询子模块,meta=featureusage。 有关详细信息,请参阅自动生成的 API 文档

参见