Event*

From Wikitech
Jump to navigation Jump to search

EventBlabla what?! So Many Event* services. This page disambiguates, and links to their more extensive documentation.

In all of the following, an 'event' is defined as a structured and schema-ed data object. The data object is usually serialized as JSON with the schema specified in and validated with JSONSchema.

EventLogging

EventLogging is the original event framework used by WMF. It consists of 3 main parts.

EventLogging Services

The EventLogging python codebase consists of various services that can be mixed and matched to consume, validate, transform, and produce streams of JSON events between different endpoints. EventLogging was originally created for Mediawiki analytics purposes, but was also used to support production streams of events via an HTTP eventlogging-service used for the EventBus service.

EventLogging Schemas

For the original analytics EventLogging use case, all schemas are maintained and stored on meta wiki. The default EventLogging validation logic looks for matching schemas in this online http/wiki repository.

EventLogging Extension

The EventLogging Mediawiki extension is used by Mediawiki to send JSON data to EventLogging by sending a GET request with query parameter encoded JSON data to a special Varnish endpoint. Requests to this Varnish endpoint are logged (via varnishkafka), and make their way into downstream EventLogging services.

EventBus

Like EventLogging, 'EventBus' refers to a few different pieces of infrastructure. More detail can be found on the EventBus documentation page.

EventBus Mediawiki extension

This is the Mediawiki extension responsible for sending events from WMF Mediawiki installations to backend event produce service (EventGate).

eventlogging-service-eventbus

This is a particular deployment of eventlogging-service that is used to accept internally produced events over HTTP. It is configured to use JSONSchemas from the mediawiki/event-schemas repository to validate incoming events.

Event Schemas (repository)

This repository is the main source of truth for WMF Mediawiki production event schemas. All new production events should be schemaed, and should exist in this repository. eventlogging-service-eventbus or EventGate validates incoming events against schemas in this repository.

EventGate (repository)

EventGate is the event service replacement for eventlogging-service-eventbus, a component of the Modern Event Platform program. This service has the same API as eventlogging-service-eventbus, with a few updated expectations for the event schemas is can process. Over 2019-2020, we will be replacing all eventlogging-service-eventbus endpoints with EventGate service endpoints.

EventStreams (repository)

EventStreams is a public facing service. It exposes streams of events via HTTP SSE/EventSource. This service replaced the Mediawiki RecentChange specific service RCStream, and perhaps eventually will also deprecate irc.wikimedia.org.

Modern Event Platform

The Modern Event Platform Program is about unifying the our analytics and production event systems into a generic event intake and validation service.