view mod_statistics_statsman/README.markdown @ 4983:7c77058a1ac5

mod_compat_roles: New module providing compat shim for trunk's new role API The new role API is translated to is_admin() calls on older versions. On newer versions (which have the role API) this module does nothing. It allows modules to drop their use of is_admin() (which is not available in trunk) and switch to the new role API, while remaining compatible with previous Prosody versions.
author Matthew Wild <mwild1@gmail.com>
date Thu, 11 Aug 2022 17:49:33 +0100
parents bac3dae031ee
children
line wrap: on
line source

A module providing a streaming statistics interface like
[mod_statistics] but based on the new [statistics API][doc:statistics]
introduced in Prosody 0.10.

# Usage

To use, enable the built-in statistics like so:

```lua
statistics = "internal"
```

Then, in `modules_enabled`, replace `"statistics"` with
`"statistics_statsman"` and the various `"statistics_<something>"`
with equivalent `"measure_<something>"`.


# Compatibility

  ------- --------------------
  trunk   Does not work [^1]
  0.11    Should work
  0.10    Should work
  ------- --------------------

[^1]: not after
    [5f15ab7c6ae5](https://hg.prosody.im/trunk/rev/5f15ab7c6ae5)