From mediawiki.org
Jump to navigation Jump to search
Other languages:
English • ‎Türkçe • ‎العربية • ‎বাংলা • ‎中文 • ‎日本語
MediaWiki extensions manual
OOjs UI icon advanced.svg
Release status: stable
Implementation Special page , API
Description Access API feature usage log summaries
Author(s) Brad Jorsch (Anomietalk)
Latest version 1.0 (2016-12-07)
Compatibility policy Snapshots releases along with MediaWiki. Master is not backwards compatible.
MediaWiki 1.25+
PHP 5.5.9+
MediaWiki 1.36 Not formally tested
MediaWiki 1.34 Not formally tested
MediaWiki 1.32 Not formally tested
Database changes No
License GNU General Public License 2.0 or later
  • $wgApiFeatureUsageQueryEngineConf
Translate the ApiFeatureUsage extension

Check usage and version matrix.

Issues Open tasks · Report a bug

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 .


  • Download and place the file(s) in a directory called ApiFeatureUsage in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'ApiFeatureUsage' );
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.


  • $wgApiFeatureUsageQueryEngineConf — Configuration array for accessing the log storage backend.
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:

Array of Elasticsearch servers. Required.
Maximum connection attempts, default 1.
Prefix for the indexes to use. Default "apifeatureusage-".
Date formatting for the indexes to use, see the PHP manual. Default "Y.m.d".
Elasticsearch type to query. Default "api-feature-usage-sanitized".
Field name for the logged value of $feature. Default "feature".
Field name for the logged timestamp. Default "@timestamp".
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.

See also[edit]