mod_stats39/README.markdown
author Kim Alvefur <zash@zash.se>
Sun, 19 Jan 2020 14:55:36 +0100
changeset 3848 c240934703bc
child 3849 117f0fb8cb15
permissions -rw-r--r--
mod_stats39: Add a README
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
3848
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     1
This module provides **public** access to Prosodys
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     2
[internal statistics][doc:statistics] trough the
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     3
[XEP-0039: Statistics Gathering] protocol. This is a simple protocol
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     4
that returns triplets of name, unit and value for each know statistic
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     5
collected by Prosody. The names used are the internal names assigned by
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     6
modules or statsmanager, names from the registry are **not** used.
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     7
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     8
# Configuration
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     9
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    10
Enabled as usual by adding to [`modules_enabled`][doc:modules_enabled]:
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    11
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    12
```lua
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    13
-- Enable Prosodys internal statistics gathering
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    14
statistics = "internal"
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    15
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    16
-- and enable the module
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    17
modules_enabled = {
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    18
    -- other modules
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    19
    "stats39";
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    20
}
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    21
```
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    22
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    23
# Usage
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    24
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    25
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    26
## Example
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    27
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    28
Statistics can be queried from the XML console of clients that have one:
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    29
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    30
```xml
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    31
C:
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    32
<iq type="get" to="example.com" id="dTMERjt5">
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    33
  <query xmlns="http://jabber.org/protocol/stats"/>
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    34
</iq>
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    35
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    36
S:
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    37
<iq type="result" to="example.com" id="dTMERjt5">
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    38
  <query xmlns="http://jabber.org/protocol/stats">
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    39
  </query>
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    40
</iq>
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    41
```
c240934703bc mod_stats39: Add a README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    42