prosody-modules
750d64c47ec6
mod_stats39/README.md

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Comparison

mod_stats39/README.md @ 6211:750d64c47ec6 draft default tip

Merge
author Trần H. Trung <xmpp:trần.h.trung@trung.fun>
date Tue, 18 Mar 2025 00:31:36 +0700
parent 6003:fe081789f7b5
comparison
equal deleted inserted replaced
6210:24316a399978 6211:750d64c47ec6
1 ---
2 labels:
3 - 'Statistics'
4 ...
5
6 This module provides **public** access to Prosodys
7 [internal statistics][doc:statistics] trough the
8 [XEP-0039: Statistics Gathering] protocol. This is a simple protocol
9 that returns triplets of name, unit and value for each know statistic
10 collected by Prosody. The names used are the internal names assigned by
11 modules or statsmanager, names from the registry are **not** used.
12
13 # Configuration
14
15 Enabled as usual by adding to [`modules_enabled`][doc:modules_enabled]:
16
17 ```lua
18 -- Enable Prosodys internal statistics gathering
19 statistics = "internal"
20
21 -- and enable the module
22 modules_enabled = {
23 -- other modules
24 "stats39";
25 }
26 ```
27
28 # Usage
29
30
31 ## Example
32
33 Statistics can be queried from the XML console of clients that have one:
34
35 ```xml
36 C:
37 <iq type="get" to="example.com" id="dTMERjt5">
38 <query xmlns="http://jabber.org/protocol/stats"/>
39 </iq>
40
41 S:
42 <iq type="result" to="example.com" id="dTMERjt5">
43 <query xmlns="http://jabber.org/protocol/stats">
44 <stat name="cpu.clock:amount" value="0.212131"/>
45 <stat name="cpu.percent:amount" value="0"/>
46 <stat name="memory.allocated:amount" value="8.30259e+06"/>
47 <stat name="memory.allocated_mmap:amount" value="401408"/>
48 <stat name="memory.lua:amount" value="6.21347e+06"/>
49 <stat name="memory.returnable:amount" value="13872"/>
50 <stat name="memory.rss:amount" value="2.03858e+07"/>
51 <stat name="memory.total:amount" value="6.53885e+07"/>
52 <stat name="memory.unused:amount" value="14864"/>
53 <stat name="memory.used:amount" value="8.28773e+06"/>
54 <stat name="/*/mod_c2s/connections:amount" value="0"/>
55 <stat name="/*/mod_c2s/ipv6:amount" value="0"/>
56 <stat name="/*/mod_s2s/connections:amount" value="0"/>
57 <stat name="/*/mod_s2s/ipv6:amount" value="0"/>
58 <stat name="stats.collection:duration" unit="seconds" value="0.000125647"/>
59 <stat name="stats.processing:duration" unit="seconds" value="0"/>
60 </query>
61 </iq>
62 ```
63
64 # Compatibly
65
66 Prosody version Works
67 ----------------- -------
68 0.9.x No
69 0.10.x Yes
70 0.11.x Yes
71 Trunk[^1] No
72
73 [^1]: Does not work with trunk since the [change to
74 OpenMetrics](https://hg.prosody.im/trunk/rev/5f15ab7c6ae5)