Extension:ApiFeatureUsage

मीडियाविकि एक्सटेंशन नियमपुस्तक

ApiFeatureUsage प्रकाशन की स्थिति: स्थिर
कार्यान्वयन	विशेष पृष्ठ , API
विवरण	API सुविधा के प्रयोगों के लॉग का सारांश देखें
लेखक	Brad Jorsch (Anomieवार्ता)
नवीनतम संस्करण	1.0 (2016-12-07)
संगतता नीति	मीडियाविकि के साथ प्रकाशित स्नैपशॉट्स। Master में पश्च संगतता नहीं है।
MediaWiki	1.25+
PHP	5.5.9+
डेटाबेस बदलता है	नहीं
लाइसेंस	GNU साधारण सार्वजनिक लाइसेंस 2.0 या अधिक
डाउनलोड करें	एक्सटेंशन डाउनलोड करें गिट [?]: रिपॉज़िटरी देखें (GitHub) कोड निरीक्षण कमिट्स का इतिहास Download source tarball
पैरामीटर्स $wgApiFeatureUsageQueryEngineConf
उपयोग किए गए हुक्स ApiDeprecationHelp ApiLogFeatureUsage LoadExtensionSchemaUpdates
ApiFeatureUsage एक्सटेंशन को अनुवादित करें
मुद्दे	अधूरे टास्क्स · बग रिपोर्ट करें

ApiFeatureUsage एक्सटेंशन एक विशेष पृष्ठ और एक API मॉड्यूल जोड़ता है जिससे ApiBase::logFeatureUsage() द्वारा लॉग किए गए डेटा के सारांश को प्राप्त किया जा सकात है, जो आम तौर पर कालग्रस्त API सुविधाओं का एक चिह्न होता है।

निर्भरताएँ

लॉग के डेटा को किसी तरह के संग्रहण प्रणाली पर जोड़ा जाना चाहिए। वर्तमान में Elasticsearch को एक्सटेंशन:Elastica के ज़रिए समर्थित किया जाता है।

स्थापना

• फ़ाइलों को डाउनलोड करें और अपने extensions/ फ़ोल्डर के ApiFeatureUsage नामक डिरेक्ट्री में डालें।
  Developers and code contributors should install the extension from Git instead, using:

  cd extensions/
  git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/ApiFeatureUsage
  

• अपने LocalSettings.php फ़ाइल के अंत में निम्न कोड जोड़ें:

  wfLoadExtension( 'ApiFeatureUsage' );
  

• पूर्ण – अपने विकि पर Special:Version पर जाकर देखें कि एक्सटेंशन को सफलतापूर्वक स्थापित किया गया है कि नहीं।

कॉन्फ़िगरेशन

पैरामीटर

Name	Description
$wgApiFeatureUsageQueryEngineConf	लॉग संग्रह बैक-एंड तक पहुँचने के लिए कॉन्फ़िगरेशन ऐरे। class इंस्तांत करने के लिए बैक-एंड तक पहुँच। या तो यह या फिर factory आवश्यक है। factory PHP का callable जिसे बैक-एंड पहुँच वर्ग का एक उदाहरण लौटाना होगा। या तो यह या फिर class आवश्यक है।

Elastica बैक-एंड (ApiFeatureUsageQueryEngineElastica)

$wgApiFeatureUsageQueryEngineConf पर अतिरिक्त कॉन्फ़िगरेशन वैल्यू:

serverList

Elasticsearch सर्वरों का ऐरे। आवश्यक।

maxConnectionAttempts

जुड़ने के अधिकतम प्रयास, डिफ़ॉल्ट है 1।

indexPrefix

इनडेक्सों द्वारा प्रयुक्त उपसर्ग। डिफ़ॉल्ट है "apifeatureusage-"।

indexFormat

इनडेक्सों द्वारा प्रयुक्त दिनांक प्रारूप, PHP मैन्युअल देखें। डिफ़ॉल्ट है "Y.m.d"।

type

क्वेरी करने के लिए Elasticsearch का प्रकार। डिफ़ॉल्ट है "api-feature-usage-sanitized"।

featureField

$feature के लॉग किए गए वैल्यू के फ़ील्ड का नाम। डिफ़ॉल्ट है "feature"।

timestampField

लॉग किए गए टाइमस्टैम्प के फ़ील्ड का नाम। डिफ़ॉल्ट है "@timestamp"।

agentField

लॉग किए गए सदस्य एजेंट के फ़ील्ड का नाम। डिफ़ॉल्ट है "agent"।

प्रयोग

यह एक्सटेंशन एक नया विशेष पृष्ठ, Special:ApiFeatureUsage, जोड़ता है जहाँ पर एक फ़ॉर्म है, जिसकी मदद से किसी सदस्य एजेंट और दिनांक के रेंज के लिए सुविधा के प्रोयोगों के लॉग के सारांश का अनुरोध किया जा सकता है।

यह एक्सटेंशन एक API क्वेरी सबमॉड्यूल meta=featureusage भी जोड़ता है। विस्तार के लिए अपने आप जनरेट किया हुआ API प्रलेख देखें।

ये भी देखें

• एक्सटेंशन:Elastica