Mercurial > prosody-modules
comparison mod_audit_status/README.md @ 5320:c450dbf6c0fa
mod_audit_status: New module to log server status to audit log
| author | Matthew Wild <mwild1@gmail.com> |
|---|---|
| date | Fri, 07 Apr 2023 12:09:21 +0100 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| 5319:5043108b14f4 | 5320:c450dbf6c0fa |
|---|---|
| 1 --- | |
| 2 summary: Log server status changes to audit log | |
| 3 rockspec: {} | |
| 4 ... | |
| 5 | |
| 6 This module records server status (start, stop, crash) to the audit log | |
| 7 maintained by [mod_audit]. | |
| 8 | |
| 9 ## Configuration | |
| 10 | |
| 11 There is a single option, `audit_status_heartbeat_interval` which specifies | |
| 12 the interval at which the "server is running" heartbeat should be updated (it | |
| 13 is stored in Prosody's configured storage backend). | |
| 14 | |
| 15 To detect crashes, Prosody periodically updates this value at the specified | |
| 16 interval. A low value will update more frequently, which causes additional I/O | |
| 17 for Prosody. A high value will give less accurate timestamps for "server | |
| 18 crashed" events in the audit log. | |
| 19 | |
| 20 The default value is 60 (seconds). | |
| 21 | |
| 22 ```lua | |
| 23 audit_status_heartbeat_interval = 60 | |
| 24 ``` | |
| 25 | |
| 26 ## Compatibility | |
| 27 | |
| 28 This module requires Prosody trunk (as of April 2023). It is not compatible | |
| 29 with 0.12. |