Mercurial > prosody-modules
view mod_http_stats_stream/README.markdown @ 5305:9b9f35aaeb91
mod_client_management: Add support for revocation of clients (when possible)
We decided to keep the unified listing of "clients", which includes both SASL2
clients and OAuth grants, etc. To a user, or someone wanting to manage what
can access their account, they are largely equivalent.
To accomplish this technically, we add a prefix to the id to state what type
it really is.
author | Matthew Wild <mwild1@gmail.com> |
---|---|
date | Wed, 05 Apr 2023 19:42:16 +0100 |
parents | bac3dae031ee |
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)