Extension:ApiFeatureUsage/ru

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.

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

Configuration

 * Parameters
 *   — Configuration array for accessing the log storage backend.
 * Backend access class to instantiate. Either this or factory is required.
 * 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.
 * PHP callable which must return an instance of a backend access class. Either this or class is required.

Additional configuration values in :
 * Elastica backend
 * Array of Elasticsearch servers. Required.
 * Array of Elasticsearch servers. Required.


 * Maximum connection attempts, default 1.
 * Maximum connection attempts, default 1.


 * Prefix for the indexes to use. Default " ".
 * Prefix for the indexes to use. Default " ".


 * Date formatting for the indexes to use, see the PHP manual. Default " ".
 * Date formatting for the indexes to use, see the PHP manual. Default " ".


 * Elasticsearch type to query. Default " ".
 * Elasticsearch type to query. Default " ".


 * Field name for the logged value of $feature . Default " ".
 * Field name for the logged value of $feature . Default " ".


 * Field name for the logged timestamp. Default " ".
 * Field name for the logged timestamp. Default " ".


 * Field name for the logged user agent. Default " ".
 * Field name for the logged user agent. Default " ".

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