Mercurial > prosody-modules
view mod_audit_status/README.md @ 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 | c450dbf6c0fa |
children |
line wrap: on
line source
--- summary: Log server status changes to audit log rockspec: {} ... This module records server status (start, stop, crash) to the audit log maintained by [mod_audit]. ## Configuration There is a single option, `audit_status_heartbeat_interval` which specifies the interval at which the "server is running" heartbeat should be updated (it is stored in Prosody's configured storage backend). To detect crashes, Prosody periodically updates this value at the specified interval. A low value will update more frequently, which causes additional I/O for Prosody. A high value will give less accurate timestamps for "server crashed" events in the audit log. The default value is 60 (seconds). ```lua audit_status_heartbeat_interval = 60 ``` ## Compatibility This module requires Prosody trunk (as of April 2023). It is not compatible with 0.12.