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||release branches|
|License||GNU General Public License 2.0 or later|
|Translate the ApiFeatureUsage extension|
|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
- Add the following code at the bottom of your LocalSettings.php:
wfLoadExtension( 'ApiFeatureUsage' );
- 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.
- PHP callable which must return an instance of a backend access class. Either this or class is required.
- Elastica backend (
Additional configuration values in
- Array of Elasticsearch servers. Required.
- Maximum connection attempts, default 1.
- Prefix for the indexes to use. Default "
- Date formatting for the indexes to use, see the PHP manual. Default "
- Elasticsearch type to query. Default "
- Field name for the logged value of $feature. Default "
- Field name for the logged timestamp. Default "
- Field name for the logged user agent. Default "
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,
See the auto-generated API documentation for details.
|This extension is being used on one or more Wikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia's CommonSettings.php and InitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki's Special:Version page.|