Jump to content

Extension:ApiFeatureUsage/bn

From mediawiki.org
This page is a translated version of the page Extension:ApiFeatureUsage and the translation is 0% complete.
মিডিয়াউইকি এক্সটেনশন ম্যানুয়াল
ApiFeatureUsage
মুক্তির অবস্থা: স্থিতিশীল
বাস্তবায়ন বিশেষ পৃষ্ঠা , এপিআই
বিবরণ Access API feature usage log summaries
লেখক(গণ) Brad Jorsch (Anomieআলোচনা)
সর্বশেষ সংস্করণ 1.0 (2016-12-07)
সামঞ্জস্য নীতি Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki 1.25+
PHP 5.5.9+
ডাটাবেজ পরিবর্তন না
Virtual domain virtual-apifeatureusage
  • $wgApiFeatureUsageQueryEngineConf
Licence গ্নু জেনারেল পাবলিক লাইসেন্স ২.০ অথবা পরবর্তী
ডাউনলোড
ApiFeatureUsage বর্ধনাংশটি অনুবাদ করুন
Issues উন্মুক্ত কাজ · বাগ প্রতিবেদন

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 .

Installation

  • ডাউনলোড করুন এবং আপনার 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' );
    
  • Yes করা হয়েছে – এক্সটেনশনটি সফলভাবে ইনস্টল করা হয়েছে কিনা তা যাচাই করতে আপনার উইকির Special:Version-এ যান।

Configuration

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

Usage

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.

See also