Mercurial > prosody-modules
annotate mod_http_stats_stream/README.markdown @ 5255:001c8fdc91a4
mod_http_oauth2: Add support for the "openid" scope
This "openid" scope is there to signal access to the userinfo endpoint,
which is needed for OIDC support.
We don't actually check this later because the userinfo endpoint only
returns info embedded in the token itself, but in the future we may want
to check this more carefully.
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Thu, 16 Mar 2023 17:06:35 +0100 |
parents | bac3dae031ee |
children |
rev | line source |
---|---|
2480 | 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 | |
3643
740870196b97
mod_http_stats_stream: Make global to simplify
Kim Alvefur <zash@zash.se>
parents:
2480
diff
changeset
|
37 # Compatibility |
2480 | 38 |
4595
bac3dae031ee
Add note of incompatibility with trunk since 5f15ab7c6ae5
Kim Alvefur <zash@zash.se>
parents:
3643
diff
changeset
|
39 * Prosody \>= 0.11.0 |
bac3dae031ee
Add note of incompatibility with trunk since 5f15ab7c6ae5
Kim Alvefur <zash@zash.se>
parents:
3643
diff
changeset
|
40 * Trunk < [5f15ab7c6ae5](https://hg.prosody.im/trunk/rev/5f15ab7c6ae5) |