mod_audit_status/README.md
author Kim Alvefur <zash@zash.se>
Sat, 09 Mar 2024 21:05:00 +0100
changeset 5865 c20a0c8a54ea
parent 5324 c450dbf6c0fa
permissions -rw-r--r--
mod_auth_oauth_external: Fix typo

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