File

mod_audit_status/README.md @ 5993:a0d77b427d50

mod_rest: Wrap mod_tokenauth errors In some cases of expired or invalid tokens the error from mod_tokenauth.get_token_session() was returned bare with status 200 instead of via the error formatting handler.
author Kim Alvefur <zash@zash.se>
date Sat, 21 Sep 2024 21:10:45 +0200
parent 5320:c450dbf6c0fa
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.