Mercurial > prosody-modules
annotate mod_stats39/README.markdown @ 4406:d86592775a20
mod_groups_internal: Fix unintended global variable (thanks luacheck)
| author | Matthew Wild <mwild1@gmail.com> |
|---|---|
| date | Wed, 27 Jan 2021 15:13:18 +0000 |
| parents | 117f0fb8cb15 |
| children | f1a63271dcfc |
| rev | line source |
|---|---|
| 3844 | 1 This module provides **public** access to Prosodys |
| 2 [internal statistics][doc:statistics] trough the | |
| 3 [XEP-0039: Statistics Gathering] protocol. This is a simple protocol | |
| 4 that returns triplets of name, unit and value for each know statistic | |
| 5 collected by Prosody. The names used are the internal names assigned by | |
| 6 modules or statsmanager, names from the registry are **not** used. | |
| 7 | |
| 8 # Configuration | |
| 9 | |
| 10 Enabled as usual by adding to [`modules_enabled`][doc:modules_enabled]: | |
| 11 | |
| 12 ```lua | |
| 13 -- Enable Prosodys internal statistics gathering | |
| 14 statistics = "internal" | |
| 15 | |
| 16 -- and enable the module | |
| 17 modules_enabled = { | |
| 18 -- other modules | |
| 19 "stats39"; | |
| 20 } | |
| 21 ``` | |
| 22 | |
| 23 # Usage | |
| 24 | |
| 25 | |
| 26 ## Example | |
| 27 | |
| 28 Statistics can be queried from the XML console of clients that have one: | |
| 29 | |
| 30 ```xml | |
| 31 C: | |
| 32 <iq type="get" to="example.com" id="dTMERjt5"> | |
| 33 <query xmlns="http://jabber.org/protocol/stats"/> | |
| 34 </iq> | |
| 35 | |
| 36 S: | |
| 37 <iq type="result" to="example.com" id="dTMERjt5"> | |
| 38 <query xmlns="http://jabber.org/protocol/stats"> | |
|
3845
117f0fb8cb15
mod_stats39: Add actual example stats
Kim Alvefur <zash@zash.se>
parents:
3844
diff
changeset
|
39 <stat name="cpu.clock:amount" value="0.212131"/> |
|
117f0fb8cb15
mod_stats39: Add actual example stats
Kim Alvefur <zash@zash.se>
parents:
3844
diff
changeset
|
40 <stat name="cpu.percent:amount" value="0"/> |
|
117f0fb8cb15
mod_stats39: Add actual example stats
Kim Alvefur <zash@zash.se>
parents:
3844
diff
changeset
|
41 <stat name="memory.allocated:amount" value="8.30259e+06"/> |
|
117f0fb8cb15
mod_stats39: Add actual example stats
Kim Alvefur <zash@zash.se>
parents:
3844
diff
changeset
|
42 <stat name="memory.allocated_mmap:amount" value="401408"/> |
|
117f0fb8cb15
mod_stats39: Add actual example stats
Kim Alvefur <zash@zash.se>
parents:
3844
diff
changeset
|
43 <stat name="memory.lua:amount" value="6.21347e+06"/> |
|
117f0fb8cb15
mod_stats39: Add actual example stats
Kim Alvefur <zash@zash.se>
parents:
3844
diff
changeset
|
44 <stat name="memory.returnable:amount" value="13872"/> |
|
117f0fb8cb15
mod_stats39: Add actual example stats
Kim Alvefur <zash@zash.se>
parents:
3844
diff
changeset
|
45 <stat name="memory.rss:amount" value="2.03858e+07"/> |
|
117f0fb8cb15
mod_stats39: Add actual example stats
Kim Alvefur <zash@zash.se>
parents:
3844
diff
changeset
|
46 <stat name="memory.total:amount" value="6.53885e+07"/> |
|
117f0fb8cb15
mod_stats39: Add actual example stats
Kim Alvefur <zash@zash.se>
parents:
3844
diff
changeset
|
47 <stat name="memory.unused:amount" value="14864"/> |
|
117f0fb8cb15
mod_stats39: Add actual example stats
Kim Alvefur <zash@zash.se>
parents:
3844
diff
changeset
|
48 <stat name="memory.used:amount" value="8.28773e+06"/> |
|
117f0fb8cb15
mod_stats39: Add actual example stats
Kim Alvefur <zash@zash.se>
parents:
3844
diff
changeset
|
49 <stat name="/*/mod_c2s/connections:amount" value="0"/> |
|
117f0fb8cb15
mod_stats39: Add actual example stats
Kim Alvefur <zash@zash.se>
parents:
3844
diff
changeset
|
50 <stat name="/*/mod_c2s/ipv6:amount" value="0"/> |
|
117f0fb8cb15
mod_stats39: Add actual example stats
Kim Alvefur <zash@zash.se>
parents:
3844
diff
changeset
|
51 <stat name="/*/mod_s2s/connections:amount" value="0"/> |
|
117f0fb8cb15
mod_stats39: Add actual example stats
Kim Alvefur <zash@zash.se>
parents:
3844
diff
changeset
|
52 <stat name="/*/mod_s2s/ipv6:amount" value="0"/> |
|
117f0fb8cb15
mod_stats39: Add actual example stats
Kim Alvefur <zash@zash.se>
parents:
3844
diff
changeset
|
53 <stat name="stats.collection:duration" unit="seconds" value="0.000125647"/> |
|
117f0fb8cb15
mod_stats39: Add actual example stats
Kim Alvefur <zash@zash.se>
parents:
3844
diff
changeset
|
54 <stat name="stats.processing:duration" unit="seconds" value="0"/> |
| 3844 | 55 </query> |
| 56 </iq> | |
| 57 ``` | |
| 58 |