Mercurial > prosody-modules
view mod_s2s_keepalive/README.markdown @ 5668:ecfd7aece33b
mod_measure_modules: Report module statuses via OpenMetrics
Someone in the chat asked about a health check endpoint, which reminded
me of mod_http_status, which provides access to module statuses with
full details. After that, this idea came about, which seems natural.
As noted in the README, it could be used to monitor that critical
modules are in fact loaded correctly.
As more modules use the status API, the more useful this module and
mod_http_status becomes.
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Fri, 06 Oct 2023 18:34:39 +0200 |
parents | bfc4d495bf2c |
children |
line wrap: on
line source
--- summary: Keepalive s2s connections ... Introduction ============ This module periodically sends [XEP-0199] ping requests to remote servers to keep your connection alive. Configuration ============= Simply add the module to the `modules_enabled` list like any other module. By default, all current s2s connections will be pinged periodically. To ping only a subset of servers, list these in `keepalive_servers`. The ping interval can be set using `keepalive_interval`. If no response to the ping has been received in about 10 minutes (or `keepalive_timeout` seconds) the s2s connections are closed. ``` lua modules_enabled = { ... "s2s_keepalive" } keepalive_servers = { "conference.prosody.im"; "rooms.swift.im" } keepalive_interval = 90 -- (in seconds, default is 60 ) keepalive_timeout = 300 -- (in seconds, default is 593 ) ``` Compatibility ============= ------- ----------------------- 0.11 Works 0.10 Works 0.9 Works ------- -----------------------