Mercurial > prosody-modules
annotate mod_http_stats_stream/README.markdown @ 5416:2393dbae51ed
mod_http_oauth2: Add option for specifying TTL of registered clients
Meant to simplify configuration, since TTL vs ignoring expiration is
expected to be the main thing one would want to configure.
Unsure what the implications of having unlimited lifetime of clients
are, given no way to revoke them currently, short of rotating the
signing secret.
On one hand, it would be annoying to have the client expire.
On the other hand, it is trivial to re-register it.
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Thu, 04 May 2023 18:41:33 +0200 |
| 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) |