Extension:ApiFeatureUsage

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 (<tvar|1> </>)
 * 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 "<tvar|1> </>".
 * Prefix for the indexes to use. Default "<tvar|1> </>".


 * Date formatting for the indexes to use, see [<tvar|url>https://php.net/date</> the PHP manual]. Default "<tvar|1> </>".
 * Date formatting for the indexes to use, see [<tvar|url>https://php.net/date</> the PHP manual]. Default "<tvar|1> </>".


 * Elasticsearch type to query. Default "<tvar|1> </>".
 * Elasticsearch type to query. Default "<tvar|1> </>".


 * Field name for the logged value of <tvar|1> $feature </>. Default "<tvar|1> </>".
 * Field name for the logged value of <tvar|1> $feature </>. Default "<tvar|1> </>".


 * Field name for the logged timestamp. Default "<tvar|1> </>".
 * Field name for the logged timestamp. Default "<tvar|1> </>".


 * Field name for the logged user agent. Default "<tvar|1> </>".
 * Field name for the logged user agent. Default "<tvar|1> </>".

Usage
The extension adds a new special page, <tvar|1>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, <tvar|1> </>. See the 1>Special:ApiHelp/query+featureusage</>|auto-generated API documentation for details.