view mod_statistics_statsman/README.markdown @ 4776:13e913471b75

mod_http_admin_api: Ensure freshness of metrics when in manual mode When in manual collection mode, as recommended for Prometheus, collection needs to be triggered manually, or they would be stale, possibly dating from the start of the server. This might vary per metric depending on how and when the metrics are gathered.
author Kim Alvefur <zash@zash.se>
date Thu, 18 Nov 2021 19:26:07 +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)