ส่วนขยาย:ApiFeatureUsage

MediaWiki extensions manual

ApiFeatureUsage Release status: stable
Implementation	Special page , API
Description	สรุปบันทึกการใช้งานฟีเจอร์ Access API
Author(s)	Brad Jorsch (Anomieคุย)
Latest version	1.0 (2016-12-07)
Compatibility policy	Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki	1.25+
PHP	5.5.9+
Database changes	No
License	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Download Git master browse repository (GitHub) commit history repository contributors (GitHub) code review
Parameters $wgApiFeatureUsageQueryEngineConf
Hooks used ApiDeprecationHelp ApiLogFeatureUsage LoadExtensionSchemaUpdates
Quarterly downloads	16 (Ranked 116th)
Public wikis using	847 (Ranked 303rd)
Translate the ApiFeatureUsage extension
Issues	Open tasks · Report a bug

ส่วนขยาย ApiFeatureUsage เพิ่มหน้าพิเศษและโมดูล API เพื่อดึงข้อมูลสรุปที่บันทึกโดย ApiBase::logFeatureUsage() ซึ่งโดยทั่วไปจะเป็นข้อบ่งชี้ถึงการใช้คุณลักษณะ API ที่เลิกใช้แล้ว

Dependencies

Log data must be added to some sort of storage system. Currently Elasticsearch is supported via Extension:Elastica .

การติดตั้ง

• ดาวน์โหลดและวางไฟล์ลงในไดเร็กทอรีที่ชื่อ ApiFeatureUsage ในโฟลเดอร์ 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
• เพิ่มโค้ดต่อไปนี้ไว้ที่ด้านล่างของ LocalSettings.php ของคุณ:

  wfLoadExtension( 'ApiFeatureUsage' );
  

•  สำเร็จ – ตรวจสอบที่ Special:Version บนวิกิของคุณเพื่อตรวจการติดตั้งส่วนขยาย

การกำหนดค่า

พารามิเตอร์

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. ค่าเริ่มต้น "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

Field name for the logged user agent. ค่าเริ่มต้น "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.

ดูเพิ่ม

• Extension:Elastica