Mercurial > prosody-modules
view mod_audit_status/README.md @ 5734:cef8bce2d71b
luacheck: Add new module API methods from trunk
See
* trunk rev 4d4f9e42bcf8
* trunk rev 65fb0d7a2312
* trunk rev c9ef35fab0b1
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Mon, 27 Nov 2023 07:10:06 +0100 |
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.