Mercurial > prosody-modules
view mod_incidents_handling/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 | 8de50be756e5 |
children |
line wrap: on
line source
--- labels: - 'Stage-Beta' summary: Incidents Handling plugin ... Introduction ============ This module implements [XEP-268](http://xmpp.org/extensions/xep-0268.html). Details ======= It will let you manage reports, inquiries, requests and responses through an Adhoc interface. The following new adhoc admin commands will be available: - List Incidents -- List all available incidents and let's you reply requests. - Send Incident Inquiry -- Inquiry a remote server about an incident. - Send Incident Report -- Send an incident report to a remote server. - Send Incident Request -- Send an incident request to a remote server. Each Adhoc form provides syntax instructions through `<desc/>` elements (they may currently be stripped by Prosody), although it's encouraged to read the [IODEF specifications](https://tools.ietf.org/html/rfc5070). Usage ===== Copy the module folder into your prosody modules directory. Place the module between your enabled modules either into the global or a vhost section. Optional configuration directives: ``` {.lua} incidents_expire_time = 86400 -- Expiral of "closed" incidents in seconds. ``` Info ==== - to be 0.9, works.