امتداد:ApiFeatureUsage

**الدليل المرجعي لامتدادات ميدياويكي**
ApiFeatureUsage; حالة الإصدار مستقر
تنفيذ	صفحة خاصة, واجهة برمجة التطبيقات
بيان	الوصول إلى موجز سجل استخدام سمة واجهة برمجة التطبيقات
المؤلف/المؤلفون	Brad Jorsch (Anomieنقاش)
آخر إصدار	1.0 (2016-12-07)
سياسة التوافق	تصدر اللقطات البرمجية مع ميدياويكي. الإصدار الرئيسي لا يتوافق مع الإصدارات السابقة.
MediaWiki	1.25+
PHP	5.5.9+
تغييرات قاعدة البيانات	لا
نطاق افتراضي	virtual-apifeatureusage
	المتغيرات $wgApiFeatureUsageQueryEngineConf;
	الروابط المستخدمة ApiDeprecationHelp; ApiLogFeatureUsage; LoadExtensionSchemaUpdates;
Licence	رخصة جنو العمومية 2.0 أو ما بعدها
التنزيل	تنزيل الامتداد ; غت [?]: تصفح المستودع (GitHub); مراجعة الكود البرمجي على غيريت; تاريخ الالتزام على غت; تنزيل المصدر في صيغة تاربول;
	ترجم الامتداد ApiFeatureUsage
المسائل	المهام المفتوحة · الإبلاغ عن عطل تقني

This page is a translated version of the page Extension:ApiFeatureUsage and the translation is 100% complete.

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

أمور تابعة

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

التنصيب

نزّل الملف/الملفات وضعها في دليل يحمل اسم ‎ApiFeatureUsage داخل مجلد ‎extensions/‎ لديك.
يجب على مطوري البرمجيات والمساهمين بالكود البرمجي تثبيت الامتداد من غت بدلا من ذلك، مستخدمين:
```
cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/ApiFeatureUsage
```
أضف الكود التالي في الجزء الأسفل من ملف LocalSettings.php :
```
wfLoadExtension( 'ApiFeatureUsage' );
```
تم التنفيذ – اذهب إلى Special:Version على موقع الويكي لديك كي تتحقق من أن الامتداد قد ثبت بنجاح.

الإعداد

المتغيرات

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

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

الاستخدام

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

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

انظر أيضا

Extension:Elastica

هذا الامتداد يستخدم على واحد من مشاريع ويكيميديا أو أكثر من واحد. يعني هذا الأمر أن الامتداد مستقر ويعمل/تعمل جيدا بما فيه الكفاية ليستخدم/لتستخدم في مواقع تتمتع بمستوى زيارات مرتفع مثل هذه. ابحث عن اسم هذا الامتداد في ملفات الضبط CommonSettings.php وكذلك InitialiseSettings.php كي ترى أين تنصب. توجد قائمة كاملة بالامتدادات المنصبة على موقع ويكي بعينه على صفحة Special:Version الخاصة بموقع الويكي.