Extension:ApiFeatureUsage

From mediawiki.org
This page is a translated version of the page Extension:ApiFeatureUsage and the translation is 100% complete.
MediaWiki manüel uzantıları
ApiFeatureUsage
Sürüm durumu: kararlı
Uygulama Özel sayfa , API
Açıklama API özelliği kullanım günlüğü özetlerine erişin
Yazar(lar) Brad Jorsch (Anomiemesaj)
En son sürüm 1.0 (2016-12-07)
Uyumluluk politikası MediaWiki ile birlikte anlık görüntüler yayımlanır. Master geriye dönük olarak uyumlu değil.
MediaWiki 1.25+
PHP 5.5.9+
Veritabanı değişiklikleri Hayır
Lisans GNU Genel Kamu Lisansı 2.0 veya üstü
İndir
  • $wgApiFeatureUsageQueryEngineConf
Quarterly downloads 16 (Ranked 131st)
Public wikis using 847 (Ranked 303rd)
ApiFeatureUsage uzantısını çevirin
Sorunlar Açık görevler · Hata bildir

ApiFeatureUsage uzantısı, tipik olarak kullanımdan kaldırılmış API özelliklerinin kullanımının bir göstergesi olan ApiBase::logFeatureUsage() ile günlüğe kaydedilen verilerin özetlerini almak için özel bir sayfa ve bir API modülü ekler.

Bağımlılıklar

Günlük verileri bir tür depolama sistemine eklenmelidir. Şu anda Elasticsearch, Extension:Elastica ile desteklenmektedir.

Kurulum

  • Dosyaları indirin ve extensions/ klasörünüzdeki ApiFeatureUsage adlı dizine yerleştirin.
    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 dosyanızın altına aşağıdaki kodu ekleyin:
    wfLoadExtension( 'ApiFeatureUsage' );
    
  • Yes Yapıldı – Uzantının başarıyla yüklendiğini doğrulamak için vikinizde Special:Version seçeneğine gidin.

Yapılandırma

Parametreler
Name Description
$wgApiFeatureUsageQueryEngineConf Günlük depolama arka ucuna erişim için yapılandırma dizisi.
class
Örneklenecek arka uç erişim sınıfı. Ya bu ya da factory gereklidir.
factory
Arka uç erişim sınıfının bir örneğini döndürmesi gereken PHP çağrılabilir. Ya bu ya da class gereklidir.
Elastica arka ucu (ApiFeatureUsageQueryEngineElastica)

$wgApiFeatureUsageQueryEngineConf içinde ek yapılandırma değerleri:

serverList
Elasticsearch sunucuları dizisi. Gerekli.
maxConnectionAttempts
Maksimum bağlantı denemesi, varsayılan 1.
indexPrefix
Kullanılacak dizinler için önek. Varsayılan "apifeatureusage-".
indexFormat
Kullanılacak dizinler için tarih biçimlendirmesi, PHP kılavuzuna bakın. Varsayılan "Y.m.d".
type
Elasticsearch sorgulanacak türü. Varsayılan "api-feature-usage-sanitized".
featureField
$feature günlüğe kaydedilen değeri için alan adı. Varsayılan "feature".
timestampField
Günlüğe kaydedilen zaman damgası için alan adı. Varsayılan "@timestamp".
agentField
Günlüğe kaydedilen kullanıcı aracısının alan adı. Varsayılan "agent".

Kullanım

Uzantı, bir kullanıcı aracısı ve tarih aralığı için özellik kullanım günlüklerinin bir özetini talep etmek için basit bir form içeren yeni bir Special:ApiFeatureUsage özel sayfası ekler.

Uzantı ayrıca bir API sorgu alt modülü olan meta=featureusage ekler. Ayrıntılar için otomatik oluşturulan API belgelerine bakın.

Ayrıca bakınız