امتداد:ApiFeatureUsage

From mediawiki.org
Jump to navigation Jump to search
This page is a translated version of the page Extension:ApiFeatureUsage and the translation is 100% complete.
Other languages:
English • ‎Türkçe • ‎العربية • ‎中文 • ‎日本語
الدليل المرجعي لامتدادات ميدياويكي
OOjs UI icon advanced.svg
ApiFeatureUsage
حالة الإصدار مستقر
تنفيذ صفحة خاصة , واجهة برمجة التطبيقات
بيان الوصول إلى موجز سجل استخدام سمة واجهة برمجة التطبيقات
المؤلف/المؤلفون Brad Jorsch (Anomieنقاش)
آخر إصدار 1.0 (2016-12-07)
سياسة التوافق أفرع التدشين
MediaWiki 1.25+
PHP 5.5.9+
تغييرات قاعدة البيانات لا
ترخيص رخصة جنو العمومية 2.0 أو ما بعدها
التنزيل
  • $wgApiFeatureUsageQueryEngineConf
ترجمة ApiFeatureUsage الامتداد لو كان متوفرا على translatewiki.net
طالع مصفوفة الاستخدام والإصدارات.
المسائل المهام المفتوحة · الإبلاغ عن عطل تقني

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.

التنصيب

  • نزل وضع الملف/الملفات في دليل يحمل اسم ApiFeatureUsage في مجلد extensions/ لديك.
  • أضف الكود التالي في الجزء الأسفل من LocalSettings.php:
    wfLoadExtension( 'ApiFeatureUsage' );
    
  • Yes تم التنفيذ – اذهب إلى Special:Version على موقع الويكي لديك كي تتحقق من أن الامتداد قد ثبت بنجاح.

الإعداد

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

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

انظر أيضا