Расширение:ApiFeatureUsage
 Статус релиза: стабильно |
|
|---|---|
| Реализация | Служебная страница, API |
| Описание | Access API feature usage log summaries |
| Автор(ы) | Brad Jorsch (Anomieобсуждение) |
| Последняя версия | 1.0 (2016-12-07) |
| Политика совместимости | Снэпшоты выходят вместе с MediaWiki. Мастер не имеет обратной совместимости. |
| MediaWiki | 1.25+ |
| PHP | 5.5.9+ |
| Изменения в БД | Нет |
| Лицензия | GNU General Public License 2.0 или позднее |
| Скачать | |
|
|
| Ежеквартальные загрузки | 13 (Ranked 127th) |
| Использование общедоступными вики | 847 (Ranked 302nd) |
| Переведите расширение 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 Extension:Elastica.
Установка
- Скачайте и распакуйте файл(ы) в папку с названием
ApiFeatureUsageв вашей папкеextensions/.
Вместо этого разработчикам и соавторам кода следует установить расширение из Git, используя: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.
|
- 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.
См. также
| Это расширение используется в одном или нескольких проектах Викимедиа. Вероятно, это означает, что расширение стабильно и работает достаточно хорошо, чтобы использоваться такими сайтами с высоким трафиком. Найдите название этого расширения в файлах конфигурации Викимедиа CommonSettings.php и InitialiseSettings.php, чтобы узнать, где оно установлено. Полный список расширений, установленных на конкретной вики, можно увидеть на странице Special:Version wiki. |