MediaWiki

Extension:EventLogging/pt-br

This page is a translated version of the page Extension:EventLogging and the translation is 2% complete.
Languages:
Manual de extensões do MediaWiki
EventLogging
Estado da versão: estável
Implementação Página especial , Banco de dados , ContentHandler
Descrição Provides a framework for logging analytics events
Autor(es) Ori.livnehdiscussão
Última versão continuous updates
MediaWiki 1.33+
PHP 5.5+
Modifica o banco
de dados 		Não
Licença GNU GPL (Licença Pública Geral) 2.0 ou superior
Download
Baixar extensão
Git [?]:
Parâmetros
  • $wgEventLoggingStreamNames
  • $wgEventLoggingSchemaApiUri
  • $wgEventLoggingServiceUri
  • $wgEventLoggingQueueLingerSeconds
  • $wgEventLoggingBaseUri
  • $wgEventLoggingSchemas
  • $wgEventLoggingDBname
Hooks usados
Quarterly downloads 92 (Ranked 102nd)
Public wikis using 1,078 (Ranked 220th)
Para traduzir a extensão EventLogging, verifique sua disponibilidade no translatewiki.net
Função no Vagrant eventlogging
Problemas Tarefas em aberto · Relatar um bug

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

  • Baixe e coloque o(s) arquivo(s) num diretório chamado EventLogging na sua pasta extensions/.
  • Adicione o seguinte código ao final do seu arquivo LocalSettings.php : 
    wfLoadExtension( 'EventLogging' );
$wgEventLoggingBaseUri = '/beacon/event';
$wgEventLoggingServiceUri = '/beacon/intake-analytics';
$wgEventLoggingStreamNames = false;
  •   Concluído – Navegue à página Special:Version em sua wiki para verificar se a instalação da extensão foi bem sucedida.


Vagrant installation:

  • Se estiver usando o Vagrant , instale com 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

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.

Ao adicionar o parâmetro trackdebug=true à URL, o console nos devtools do navegador mostrará o registro de eventos sendo acionado.

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 Manual:JavaScript unit testing .)

To run PHP tests, we use PHPUnit. Make sure it is installed, then: 

$ vagrant ssh
vagrant@mediawiki-vagrant:/vagrant/mediawiki/extensions/EventLogging/tests$ php /vagrant/mediawiki/tests/phpunit/phpunit.php EventLoggingExtensionFunctionsTest.php
Retrieved from "https://www.mediawiki.org/w/index.php?title=Extension:EventLogging/pt-br&oldid=5834242"