امتداد:ApiFeatureUsage

This page is a translated version of the page Extension:ApiFeatureUsage and the translation is 100% complete.
الدليل المرجعي لامتدادات ميدياويكي
OOjs UI icon advanced-invert.svg
ApiFeatureUsage
حالة الإصدار مستقر
تنفيذ صفحة خاصة , واجهة برمجة التطبيقات
بيان الوصول إلى موجز سجل استخدام سمة واجهة برمجة التطبيقات
المؤلف/المؤلفون Brad Jorsch (Anomieنقاش)
آخر إصدار 1.0 (2016-12-07)
سياسة التوافق تصدر اللقطات البرمجية مع ميدياويكي. الإصدار الرئيسي لا يتوافق مع الإصدارات السابقة.
MediaWiki 1.25+
PHP 5.5.9+
تغييرات قاعدة البيانات لا
ترخيص رخصة جنو العمومية 2.0 أو ما بعدها
التنزيل
  • $wgApiFeatureUsageQueryEngineConf
تنزيلات ربع سنوية 23 (Ranked 147th)
استخدام مواقع الويكي العمومية 812 (Ranked 288th)
ترجم الامتداد ApiFeatureUsage
المسائل المهام المفتوحة · الإبلاغ عن عطل تقني

يضيف امتداد ApiFeatureUsage صفحة خاصة ووحدة واجهة برمجة تطبيقات تستخدم في استحضار موجزات للبيانات التي يسجلها ApiBase::logFeatureUsage()، الذي يشير في العادة إلى استخدام ميزات واجهة برمجية تطبيقات متقادمة.

أمور تابعة

يتعين أن تضاف بيانات السجل إلى أحد أنواع أنظمة الحفظ. يدعم Extension:Elastica في الوقت الراهن Elasticsearch.

التنصيب

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

الإعداد

المتغيرات
Name Description
$wgApiFeatureUsageQueryEngineConf سلسلة إعداد للولوج إلى تخزين السجل مباشرة.
class
فئة الولوج المباشر المطلوب تمثيلها. يتطلب الأمر هذا أو factory بديلا عنه.
factory
نداء بي إتش بي يتعين أن يرجع له حالة فئة ولوج مباشر. يتطلب الأمر هذا أو class بديلا عنه.
Elastica backend (ApiFeatureUsageQueryEngineElastica)

قيم ضبط إضافية في $wgApiFeatureUsageQueryEngineConf:

serverList
تسلسل خوادم Elasticsearch. مطلوب.
maxConnectionAttempts
العدد الأقصى لمحاولات الاتصال، القيمة الافتراضية هي 1.
indexPrefix
بادئة الفهارس المطلوب استخدامها. القيمة الافتراضية هي «apifeatureusage-».
indexFormat
صيغة التاريخ للفهارس المطلوب استخدامها، طالع دليل استخدام بي إتش بي. القيمة الافتراضية هي «Y.m.d».
type
أسلوب الطباعة والبحث مباشرة في Elasticsearch. القيمة الافتراضية هي «api-feature-usage-sanitized».
featureField
خانة الاسم للقيمة المسجلة للقيمة $feature. القيمة الافتراضية هي «feature».
timestampField
خانة الاسم للختم الزمني المسجل. القيمة الافتراضية هي «@timestamp».
agentField
خانة الاسم لعميل المستخدم المسجل. القيمة الافتراضية هي «agent».

الاستخدام

يضيف الامتداد صفحة خاصة، Special:ApiFeatureUsage، تحتوي على نموذج بسيط مخصص لطلب موجز لسجلات استخدام المزايا لعميل المستخدم مع تحديد مدة زمنية.

يضيف الامتداد أيضا وحدة برمجية فرعية لإرسال الاستفسارات عبر واجهة برمجة التطبيقات، meta=featureusage. طالع توثيق واجهة برمجة التطبيقات المولد آليا لمزيد من التفاصيل.

انظر أيضا