Mercurial > prosody-modules
annotate mod_http_stats_stream/README.markdown @ 4989:b74d592df9e2
mod_http_muc_log: Remove dead code
This might be something left over since a different variant where the
loop went like `for n = i-1, i-100, -1 do ... end` i.e. it went trough a
fixed number of items instead of all the page until the current message.
Then it would have needed something to stop going over the end, but
since the checks are simple it shouldn't be much of a problem looping
over even a very busy day.
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Tue, 16 Aug 2022 01:27:59 +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) |