mod_statistics_statsman/README.markdown
author Kim Alvefur <zash@zash.se>
Tue, 15 Sep 2020 19:18:31 +0200
changeset 4139 ed0c7044b00f
parent 3612 2c25594f9e71
child 4599 bac3dae031ee
permissions -rw-r--r--
mod_invites_register_web: Include html resources in rock
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
3162
2558ece20e58 mod_statistics_statsman: Streaming access to statsmanager
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     1
A module providing a streaming statistics interface like
3163
e995cd0f228e mod_statistics_statsman/README: Fix typo in link
Kim Alvefur <zash@zash.se>
parents: 3162
diff changeset
     2
[mod_statistics] but based on the new [statistics API][doc:statistics]
3162
2558ece20e58 mod_statistics_statsman: Streaming access to statsmanager
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     3
introduced in Prosody 0.10.
3612
2c25594f9e71 mod_statistics_statsman/README: Describe how to switch from mod_statistics
Kim Alvefur <zash@zash.se>
parents: 3163
diff changeset
     4
2c25594f9e71 mod_statistics_statsman/README: Describe how to switch from mod_statistics
Kim Alvefur <zash@zash.se>
parents: 3163
diff changeset
     5
# Usage
2c25594f9e71 mod_statistics_statsman/README: Describe how to switch from mod_statistics
Kim Alvefur <zash@zash.se>
parents: 3163
diff changeset
     6
2c25594f9e71 mod_statistics_statsman/README: Describe how to switch from mod_statistics
Kim Alvefur <zash@zash.se>
parents: 3163
diff changeset
     7
To use, enable the built-in statistics like so:
2c25594f9e71 mod_statistics_statsman/README: Describe how to switch from mod_statistics
Kim Alvefur <zash@zash.se>
parents: 3163
diff changeset
     8
2c25594f9e71 mod_statistics_statsman/README: Describe how to switch from mod_statistics
Kim Alvefur <zash@zash.se>
parents: 3163
diff changeset
     9
```lua
2c25594f9e71 mod_statistics_statsman/README: Describe how to switch from mod_statistics
Kim Alvefur <zash@zash.se>
parents: 3163
diff changeset
    10
statistics = "internal"
2c25594f9e71 mod_statistics_statsman/README: Describe how to switch from mod_statistics
Kim Alvefur <zash@zash.se>
parents: 3163
diff changeset
    11
```
2c25594f9e71 mod_statistics_statsman/README: Describe how to switch from mod_statistics
Kim Alvefur <zash@zash.se>
parents: 3163
diff changeset
    12
2c25594f9e71 mod_statistics_statsman/README: Describe how to switch from mod_statistics
Kim Alvefur <zash@zash.se>
parents: 3163
diff changeset
    13
Then, in `modules_enabled`, replace `"statistics"` with
2c25594f9e71 mod_statistics_statsman/README: Describe how to switch from mod_statistics
Kim Alvefur <zash@zash.se>
parents: 3163
diff changeset
    14
`"statistics_statsman"` and the various `"statistics_<something>"`
2c25594f9e71 mod_statistics_statsman/README: Describe how to switch from mod_statistics
Kim Alvefur <zash@zash.se>
parents: 3163
diff changeset
    15
with equivalent `"measure_<something>"`.