Software / code / prosody-modules
File
mod_http_stats_stream/README.md @ 6244:c71d8bc77c95
mod_rest: Skip unpacking error object when missing (thanks Martin)
Not every "http-error" event includes a .error field, so it may attempt
to unpack `nil`.
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Tue, 22 Apr 2025 09:40:20 +0200 |
| parent | 6003:fe081789f7b5 |
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)