Extension: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.42 |
| Composer | mediawiki/event-stream-config |
| License | GNU General Public License 2.0 or later |
| Download | README |
| Help | Help:Extension:EventStreamConfig |
|
|
|
| Quarterly downloads | 2 (Ranked 142nd) |
| Public wikis using | 993 (Ranked 271st) |
| Translate the EventStreamConfig extension if it is available at translatewiki.net | |
| 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.
| This extension is being used on one or more Wikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia's CommonSettings.php and InitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki's Special:Version page. |
| This extension is included in the following wiki farms/hosts and/or packages: This is not an authoritative list. Some wiki farms/hosts and/or packages may contain this extension even if they are not listed here. Always check with your wiki farms/hosts or bundle to confirm. |