Mercurial > prosody-modules
view mod_service_outage_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 | 03044a6f5f4c |
| children |
line wrap: on
line source
This module allows advertising a machine-readable document were outages, planned or otherwise, may be reported. See [XEP-0455: Service Outage Status] for further details, including the format of the outage status document. ```lua modules_enabled = { -- other modules "service_outage_status", } outage_status_urls = { "https://uptime.example.net/status.json", } ``` The outage status document should be hosted on a separate server to ensure availability even if the XMPP server is unreachable.