author | Matthew Wild <mwild1@gmail.com> |
Thu, 08 Jun 2023 11:28:06 +0100 | |
changeset 5534 | 8226ac08484e |
parent 4599 | bac3dae031ee |
permissions | -rw-r--r-- |
4455
f1a63271dcfc
Add tag 'Statistics' to some modules to ease discoverability
Kim Alvefur <zash@zash.se>
parents:
3849
diff
changeset
|
1 |
--- |
f1a63271dcfc
Add tag 'Statistics' to some modules to ease discoverability
Kim Alvefur <zash@zash.se>
parents:
3849
diff
changeset
|
2 |
labels: |
f1a63271dcfc
Add tag 'Statistics' to some modules to ease discoverability
Kim Alvefur <zash@zash.se>
parents:
3849
diff
changeset
|
3 |
- 'Statistics' |
f1a63271dcfc
Add tag 'Statistics' to some modules to ease discoverability
Kim Alvefur <zash@zash.se>
parents:
3849
diff
changeset
|
4 |
... |
f1a63271dcfc
Add tag 'Statistics' to some modules to ease discoverability
Kim Alvefur <zash@zash.se>
parents:
3849
diff
changeset
|
5 |
|
3848 | 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"> |
|
3849
117f0fb8cb15
mod_stats39: Add actual example stats
Kim Alvefur <zash@zash.se>
parents:
3848
diff
changeset
|
44 |
<stat name="cpu.clock:amount" value="0.212131"/> |
117f0fb8cb15
mod_stats39: Add actual example stats
Kim Alvefur <zash@zash.se>
parents:
3848
diff
changeset
|
45 |
<stat name="cpu.percent:amount" value="0"/> |
117f0fb8cb15
mod_stats39: Add actual example stats
Kim Alvefur <zash@zash.se>
parents:
3848
diff
changeset
|
46 |
<stat name="memory.allocated:amount" value="8.30259e+06"/> |
117f0fb8cb15
mod_stats39: Add actual example stats
Kim Alvefur <zash@zash.se>
parents:
3848
diff
changeset
|
47 |
<stat name="memory.allocated_mmap:amount" value="401408"/> |
117f0fb8cb15
mod_stats39: Add actual example stats
Kim Alvefur <zash@zash.se>
parents:
3848
diff
changeset
|
48 |
<stat name="memory.lua:amount" value="6.21347e+06"/> |
117f0fb8cb15
mod_stats39: Add actual example stats
Kim Alvefur <zash@zash.se>
parents:
3848
diff
changeset
|
49 |
<stat name="memory.returnable:amount" value="13872"/> |
117f0fb8cb15
mod_stats39: Add actual example stats
Kim Alvefur <zash@zash.se>
parents:
3848
diff
changeset
|
50 |
<stat name="memory.rss:amount" value="2.03858e+07"/> |
117f0fb8cb15
mod_stats39: Add actual example stats
Kim Alvefur <zash@zash.se>
parents:
3848
diff
changeset
|
51 |
<stat name="memory.total:amount" value="6.53885e+07"/> |
117f0fb8cb15
mod_stats39: Add actual example stats
Kim Alvefur <zash@zash.se>
parents:
3848
diff
changeset
|
52 |
<stat name="memory.unused:amount" value="14864"/> |
117f0fb8cb15
mod_stats39: Add actual example stats
Kim Alvefur <zash@zash.se>
parents:
3848
diff
changeset
|
53 |
<stat name="memory.used:amount" value="8.28773e+06"/> |
117f0fb8cb15
mod_stats39: Add actual example stats
Kim Alvefur <zash@zash.se>
parents:
3848
diff
changeset
|
54 |
<stat name="/*/mod_c2s/connections:amount" value="0"/> |
117f0fb8cb15
mod_stats39: Add actual example stats
Kim Alvefur <zash@zash.se>
parents:
3848
diff
changeset
|
55 |
<stat name="/*/mod_c2s/ipv6:amount" value="0"/> |
117f0fb8cb15
mod_stats39: Add actual example stats
Kim Alvefur <zash@zash.se>
parents:
3848
diff
changeset
|
56 |
<stat name="/*/mod_s2s/connections:amount" value="0"/> |
117f0fb8cb15
mod_stats39: Add actual example stats
Kim Alvefur <zash@zash.se>
parents:
3848
diff
changeset
|
57 |
<stat name="/*/mod_s2s/ipv6:amount" value="0"/> |
117f0fb8cb15
mod_stats39: Add actual example stats
Kim Alvefur <zash@zash.se>
parents:
3848
diff
changeset
|
58 |
<stat name="stats.collection:duration" unit="seconds" value="0.000125647"/> |
117f0fb8cb15
mod_stats39: Add actual example stats
Kim Alvefur <zash@zash.se>
parents:
3848
diff
changeset
|
59 |
<stat name="stats.processing:duration" unit="seconds" value="0"/> |
3848 | 60 |
</query> |
61 |
</iq> |
|
62 |
``` |
|
63 |
||
4599
bac3dae031ee
Add note of incompatibility with trunk since 5f15ab7c6ae5
Kim Alvefur <zash@zash.se>
parents:
4455
diff
changeset
|
64 |
# Compatibly |
bac3dae031ee
Add note of incompatibility with trunk since 5f15ab7c6ae5
Kim Alvefur <zash@zash.se>
parents:
4455
diff
changeset
|
65 |
|
bac3dae031ee
Add note of incompatibility with trunk since 5f15ab7c6ae5
Kim Alvefur <zash@zash.se>
parents:
4455
diff
changeset
|
66 |
Prosody version Works |
bac3dae031ee
Add note of incompatibility with trunk since 5f15ab7c6ae5
Kim Alvefur <zash@zash.se>
parents:
4455
diff
changeset
|
67 |
----------------- ------- |
bac3dae031ee
Add note of incompatibility with trunk since 5f15ab7c6ae5
Kim Alvefur <zash@zash.se>
parents:
4455
diff
changeset
|
68 |
0.9.x No |
bac3dae031ee
Add note of incompatibility with trunk since 5f15ab7c6ae5
Kim Alvefur <zash@zash.se>
parents:
4455
diff
changeset
|
69 |
0.10.x Yes |
bac3dae031ee
Add note of incompatibility with trunk since 5f15ab7c6ae5
Kim Alvefur <zash@zash.se>
parents:
4455
diff
changeset
|
70 |
0.11.x Yes |
bac3dae031ee
Add note of incompatibility with trunk since 5f15ab7c6ae5
Kim Alvefur <zash@zash.se>
parents:
4455
diff
changeset
|
71 |
Trunk[^1] No |
bac3dae031ee
Add note of incompatibility with trunk since 5f15ab7c6ae5
Kim Alvefur <zash@zash.se>
parents:
4455
diff
changeset
|
72 |
|
bac3dae031ee
Add note of incompatibility with trunk since 5f15ab7c6ae5
Kim Alvefur <zash@zash.se>
parents:
4455
diff
changeset
|
73 |
[^1]: Does not work with trunk since the [change to |
bac3dae031ee
Add note of incompatibility with trunk since 5f15ab7c6ae5
Kim Alvefur <zash@zash.se>
parents:
4455
diff
changeset
|
74 |
OpenMetrics](https://hg.prosody.im/trunk/rev/5f15ab7c6ae5) |