Mercurial > prosody-modules

comparison mod_http_stats_stream/README.markdown @ 2480:c98b37d6d86c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_http_stats_stream: Add a README
author Kim Alvefur <zash@zash.se>
date Tue, 31 Jan 2017 17:26:04 +0100
parents
children 740870196b97
comparison
equal deleted inserted replaced
2479:a440f0514c2a 2480:c98b37d6d86c
1 ---
2 depends:
3 - 'mod\_http'
4 provides:
5 - http
6 ---
7
8 # Introduction
9
10 This module provides a streaming interface to [Prosodys internal statistics][doc:statistics] via
11 [Server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events).
12
13 ## Example
14
15 ```js
16 var evtSource = new EventSource("/stats_stream");
17
18 /*
19 * An event with all current statistics in the form of a JSON object.
20 * Normally sent only once, when first connected to the stream.
21 */
22 evtSource.addEventListener("stats-full", function(e) {
23 var initial_stats = JSON.parse(e.data);
24 console.log(initial_stats);
25 }, false);
26
27 /*
28 * An event containing only statistics that have changed since the last
29 * 'stats-full' or 'stats-updated' event.
30 */
31 evtSource.addEventListener("stats-updated", function(e) {
32 var updated_stats = JSON.parse(e.data);
33 console.log(updated_stats);
34 }, false);
35 ```
36
37