Mercurial > prosody-modules
view mod_http_stats_stream/README.markdown @ 4224:816c2fa1ca84
mod_invites*: Also link to mod_invites_api
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Mon, 19 Oct 2020 22:02:30 +0200 |
parents | 740870196b97 |
children | bac3dae031ee |
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