Расширение:EventLogging

Справка по расширениям MediaWiki

EventLogging Статус релиза: стабильно
Реализация	Служебная страница , База данных , ContentHandler
Описание	Предоставляет платформу для регистрации аналитических событий
Автор(ы)	Ori.livnehобсуждение
Последняя версия	постоянные обновления
MediaWiki	1.33+
PHP	5.5+
Изменения в БД	Нет
Лицензия	GNU General Public License 2.0 или позднее
Скачать	Скачать расширение Git [?]: репозиторий (Phabricator · GitHub) Обзор кода Gerrit журнал Git-коммитов Download source tarball
Параметры $wgEventLoggingStreamNames $wgEventLoggingSchemaApiUri $wgEventLoggingServiceUri $wgEventLoggingQueueLingerSeconds $wgEventLoggingBaseUri $wgEventLoggingSchemas $wgEventLoggingDBname
Используемые хуки ApiMain::moduleManager BeforePageDisplay CanonicalNamespaces CodeEditorGetPageLanguage EditFilterMergedContent GetPreferences MovePageIsValidMove
Переведите расширение EventLogging, если оно доступно на translatewiki.net
Роль Vagrant	eventlogging
Проблемы	Открытые задачи · Сообщить об ошибке

Расширение EventLogging позволяет собирать структурированные данные о том, как пользователи взаимодействуют с сайтами MediaWiki.

Возможности

• 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. If you're interested in the separate components that Wikimedia uses for these purposes, see #EventLogging at Wikimedia.

EventLogging at Wikimedia

This page is about general use of the EventLogging extension.

Wikimedia uses the EventLogging extension as part of a broader system for collecting, aggregating, storing, and analyzing user data within the limits set out by its privacy policy and data retention guidelines. For documentation on this system, see wikitech:Event Platform.

Installation

• Скачайте и распакуйте файл(ы) в папку с названием EventLogging в вашей папке extensions/.
  Вместо этого разработчикам и соавторам кода следует установить расширение из Git, используя:

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

• Добавьте следующий код в конце вашего файла LocalSettings.php :

  wfLoadExtension( 'EventLogging' );
  $wgEventLoggingBaseUri = '/beacon/event';
  $wgEventLoggingServiceUri = '/beacon/intake-analytics';
  $wgEventLoggingStreamNames = false;
  

• Готово – Перейдите на страницу Special:Version на своей вики, чтобы удостовериться в том, что расширение успешно установлено.

Установка Vagrant:

• Если вы используете Vagrant , установите с помощью 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 Manual:JavaScript unit testing .)

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