Mercurial > prosody-modules
view mod_server_status/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: Server status plugin ... Introduction ============ This module fetches the current status of configured hosts and/or stanza statistics from [mod\_stanza\_counter](http://code.google.com/p/prosody-modules/wiki/mod_stanza_counter#). And outputs it in either XML or JSON format. Usage ===== Copy the file into prosody's module directory and place it into your global's enabled modules. Configuration example: server_status_basepath = "/server-info/" server_status_show_hosts = { "iwanttoshowifthishostisonline.com", "iwanttoshowifthishostisonline2.com" } server_status_show_comps = { "muc.iwanttoshowifthishostisonline.com", "transport.iwanttoshowifthishostisonline.com" } server_status_json = true By default the plugin's output is in XML, setting server\_status\_json to "true" will turn it into JSON instead. if mod\_stanza\_counter isn't loaded the plugin will require at least either server\_status\_show\_hosts or server\_status\_show\_comps to be set. Info ==== - This is only compatible with 0.9 for older versions please look at the 0.8-diverge branch.