Mercurial > prosody-modules
view mod_stanza_counter/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 | 4d73a1a6ba68 |
| children |
line wrap: on
line source
--- labels: - 'Stage-Stable' summary: Simple incoming and outgoing stanza counter ... Introduction ============ This module counts incoming and outgoing stanzas from when the instance started, and makes the data available to other modules by creating a global prosody. object Details ======= The counter module is "stanza\_counter", the example output module is stanza\_counter\_http. Usage ===== Copy both files into prosody's module directory and place 'em into your enabled modules (stanza\_counter\_http requires to be loaded into the global section!) Config for stanza\_counter\_http: ``` {.lua} stanza_counter_basepath = "/counter-path-custom/" ``` Info ==== - As of now to count components stanzas, it needs to be manually loaded (inserted into modules\_enabled of the components' sections) on these. - This version isn't compatible with previous versions of prosody (looks at 0.8-diverge branch for olders).