Rozšíření:EventLogging
EventLogging Stav rozšíření: stabilní |
|
---|---|
Implementace | Speciální stránka , Databáze , ContentHandler |
Popis | Poskytuje rámec pro protokolování analytických událostí |
Autoři | Ori.livnehdiskuse |
Nejnovější verze | průběžné aktualizace |
MediaWiki | 1.33+ |
PHP | 5.5+ |
Změny v databázi | Ne |
Licence | GNU General Public License 2.0 nebo novější |
Stáhnout | |
|
|
Čtvrtletní stahování | 44 (Ranked 90th) |
Veřejné wiki používající rozšíření | 1,078 (Ranked 221st) |
Přeložte rozšíření EventLogging, používá-li lokalizaci z translatewiki.net | |
Vagrant role | eventlogging |
Problémy | Otevřené úkoly · Nahlásit chybu |
The EventLogging extension makes it possible to collect structured data on how users interact with MediaWiki sites.
Features
- EventLogging supports client-side logging from JavaScript and server-side logging from PHP.
- Logging behavior can be dynamically configured using Extension:EventStreamConfig .
- The events are JSON objects defined by versioned JSONSchemas stored in a schema git repository.
- The extension does not include any back-end code for transporting, parsing, or loading these events. A separate service, EventGate, implements this functionality and deals with inserting events into Kafka. Events are then persisted in downstream datastores (e.g. Hive) via various ingestion pipelines. The details of these components are specific to Wikimedia Foundation's configuration.
EventLogging at Wikimedia
The Wikimedia Foundation uses the EventLogging extension as part of a broader system for collecting, aggregating, storing, and analyzing user data within the limits set out by our privacy policy and data retention guidelines.
This page is about general use of the EventLogging extension. The Wikimedia Foundation uses EventLogging with WMF specific backend components and schema repositories. For Wikimedia specific and maintained documentation, see wikitech:Analytics/Systems/EventLogging and wikitech:Event Platform.
Installation
- Stáhněte soubor/y a vložte je do adresáře pojmenovaného
EventLogging
ve vaší složceextensions/
.
Vývojáři a přispěvatelé kódu by si místo toho měli nainstalovat rozšíření from Git pomocí:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/EventLogging - Na konec vašeho souboru LocalSettings.php přidejte následující kód:
wfLoadExtension( 'EventLogging' ); $wgEventLoggingBaseUri = '/beacon/event'; $wgEventLoggingServiceUri = '/beacon/intake-analytics'; $wgEventLoggingStreamNames = false;
- Dokončeno – Přejděte na stránku Special:Version vaší wiki a zkontrolujte, zda bylo rozšíření úspěšně nainstalováno.
Instalace Vagrant:
- Pokud používáte Vagrant , instalujte s těmito parametry
vagrant roles enable eventlogging --provision
Configuring the schema location
By default, the extension will look for schemas on Meta-Wiki.
The relevant default settings are:
# (default) $wgEventLoggingSchemaApiUri = 'https://meta.wikimedia.org/w/api.php';
# (default) $wgEventLoggingDBname = 'metawiki';
To use local schemas, or schemas from the central wiki of your own wikifarm, you need to override these. E.g. to use the Schema
namespace of the local wiki, set
$wgEventLoggingSchemaApiUri = $wgServer . '/w/api.php';
$wgEventLoggingDBname = $wgDBname;
(and ensure the user account that will create the schemas is autoconfirmed).
Logging events using EventLogging
- Extension:EventLogging/Guide - to developing and deploying EventLogging schemas, and more
- Extension:EventLogging/Programming - tips and suggestions for developers writing code to log events
Developing the EventLogging extension
Developer setup
As a developer, you will want to set up and use EventLogging on your development wiki to simulate its use in production.
Using Docker
See MediaWiki-Docker/Configuration recipes/EventLogging
Using mediawiki-vagrant
If you develop using mediawiki-vagrant, everything you need is encapsulated in the eventlogging
role.
To enable it, run:
$ vagrant roles enable eventlogging
$ vagrant provision
For JavaScript development
If working on the JavaScript client, you'll need to install dependencies with npm install
from the folder you're developing in.
Then you can use npm test
to run ESLint for example.
The "How to run tests" section below points out how to see JavaScript test results.
When adding the parameter trackdebug=true
to the URL, the console in the browser's devtools will show the event logging being triggered.
How to run tests
There are PHP tests, Python tests, and JavaScript tests.
To run JavaScript tests, visit Special:JavaScriptTest/qunit on your development wiki. (See Příručka:Testování jednotek JavaScriptu .)
To run PHP tests, we use PHPUnit. Make sure it is installed, then:
$ vagrant ssh
vagrant@mediawiki-vagrant:/vagrant/mediawiki$ composer phpunit:entrypoint -- extensions/EventLogging/testsEventLoggingExtensionFunctionsTest.php
Toto rozšíření se používá na jednom nebo více projektech Wikimedia. Pravděpodobně to znamená, že rozšíření je stabilní a funguje dostatečně dobře, aby jej mohly používat weby s tak vysokou návštěvností. Vyhledejte tento název rozšíření v konfiguračních souborech CommonSettings.php a InitialiseSettings.php Wikimedie, abyste viděli, kde je nainstalováno. Úplný seznam rozšíření nainstalovaných na konkrétní wiki lze vidět na stránce wiki Special:Version. |
Toto rozšíření je zahrnuto v následujících wiki farmách/hostitelích a/nebo balíčcích: Toto není autoritativní seznam. Některé wiki farmy/hostitelé a/nebo balíčky mohou toto rozšíření obsahovat, i když zde nejsou uvedeny. Pro potvrzení se vždy obraťte na své wiki farmy/hostitele nebo balíček. |