Mercurial > prosody-modules
changeset 2480:c98b37d6d86c
mod_http_stats_stream: Add a README
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Tue, 31 Jan 2017 17:26:04 +0100 (2017-01-31) |
parents | a440f0514c2a |
children | 854aaa1f01b2 |
files | mod_http_stats_stream/README.markdown |
diffstat | 1 files changed, 37 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mod_http_stats_stream/README.markdown Tue Jan 31 17:26:04 2017 +0100 @@ -0,0 +1,37 @@ +--- +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); +``` + +