Software / code / prosody-modules
Changeset
3844:c240934703bc
mod_stats39: Add a README
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Sun, 19 Jan 2020 14:55:36 +0100 |
| parents | 3843:c065b7670c89 |
| children | 3845:117f0fb8cb15 |
| files | mod_stats39/README.markdown |
| diffstat | 1 files changed, 42 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mod_stats39/README.markdown Sun Jan 19 14:55:36 2020 +0100 @@ -0,0 +1,42 @@ +This module provides **public** access to Prosodys +[internal statistics][doc:statistics] trough the +[XEP-0039: Statistics Gathering] protocol. This is a simple protocol +that returns triplets of name, unit and value for each know statistic +collected by Prosody. The names used are the internal names assigned by +modules or statsmanager, names from the registry are **not** used. + +# Configuration + +Enabled as usual by adding to [`modules_enabled`][doc:modules_enabled]: + +```lua +-- Enable Prosodys internal statistics gathering +statistics = "internal" + +-- and enable the module +modules_enabled = { + -- other modules + "stats39"; +} +``` + +# Usage + + +## Example + +Statistics can be queried from the XML console of clients that have one: + +```xml +C: +<iq type="get" to="example.com" id="dTMERjt5"> + <query xmlns="http://jabber.org/protocol/stats"/> +</iq> + +S: +<iq type="result" to="example.com" id="dTMERjt5"> + <query xmlns="http://jabber.org/protocol/stats"> + </query> +</iq> +``` +
