Mercurial > prosody-modules
view mod_http_stats_stream/README.md @ 6317:7b693a5539ad
mod_auth_http_async: Update documentation
The required async APIs were included in 0.10.0, but at the time of this
writing we only consider 0.12.x and later supported.
The fallback sync API would have made it work with even earlier
versions, but I don't remember specifically and it doesn't matter.
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Tue, 02 Sep 2025 21:32:01 +0200 |
| parents | fe081789f7b5 |
| children |
line wrap: on
line source
--- depends: - 'mod\_http' provides: - http --- # Introduction This module provides a streaming interface to [Prosodys internal statistics][doc:statistics] via [Server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events). ## Example ```js var evtSource = new EventSource("/stats_stream"); /* * An event with all current statistics in the form of a JSON object. * Normally sent only once, when first connected to the stream. */ evtSource.addEventListener("stats-full", function(e) { var initial_stats = JSON.parse(e.data); console.log(initial_stats); }, false); /* * An event containing only statistics that have changed since the last * 'stats-full' or 'stats-updated' event. */ evtSource.addEventListener("stats-updated", function(e) { var updated_stats = JSON.parse(e.data); console.log(updated_stats); }, false); ``` # Compatibility * Prosody \>= 0.11.0 * Trunk < [5f15ab7c6ae5](https://hg.prosody.im/trunk/rev/5f15ab7c6ae5)
