Mercurial > prosody-modules
view mod_statistics_statsman/README.markdown @ 5668:ecfd7aece33b
mod_measure_modules: Report module statuses via OpenMetrics
Someone in the chat asked about a health check endpoint, which reminded
me of mod_http_status, which provides access to module statuses with
full details. After that, this idea came about, which seems natural.
As noted in the README, it could be used to monitor that critical
modules are in fact loaded correctly.
As more modules use the status API, the more useful this module and
mod_http_status becomes.
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Fri, 06 Oct 2023 18:34:39 +0200 |
| 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)