mod_audit_status/README.md
author Matthew Wild <mwild1@gmail.com>
Wed, 17 Apr 2024 16:48:22 +0100
changeset 5893 2597e2113561
parent 5324 c450dbf6c0fa
permissions -rw-r--r--
mod_sasl2: Log when tls-exporter is NOT supported, as well as when it is

---
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.