Extension:EventStreamConfig

From mediawiki.org
Other languages:
MediaWiki extensions manual
OOjs UI icon advanced-invert.svg
EventStreamConfig
Release status: stable
Implementation API
Description Exposes event stream config in an API endpoint. Can also be used to expose configs via ResourceLoader
Author(s) Andrew Otto (Ottomatatalk)
Compatibility policy Master maintains backward compatibility.
MediaWiki >= 1.35.0
Composer mediawiki/event-stream-config
License GNU General Public License 2.0 or later
Download
README
Help Help:Extension:EventStreamConfig

  • wgEventStreams
Translate the EventStreamConfig extension if it is available at translatewiki.net

Check usage and version matrix.

Issues Open tasks · Report a bug

The EventStreamConfig extension is a utility extension that provides library functions and an API endpoint for exporting event stream configuration, using the variable $wgEventStreams. It does not directly provide any user functionality; rather, it provides code used by other extensions and services. Other software that uses this extension includes:

  • The EventLogging extension - used to load configs for streams used on certain pages to dynamically configure client stream settings, like sampling rate.
  • The EventBus extension - used to figure out which event intake service a given stream should be produced to.
  • The EventGate service - used to ensure that only events of a specific schema title are allowed into a stream.
  • Mobile apps - API endpoint is used to dynamically configure client stream settings like sample rate.

For more information on EventStreamConfig and how to use it, see Help:Extension:EventStreamConfig.