annotate mod_s2s_smacks_timeout/README.md @ 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 f0fe95f9e21c
children 78368d2865dd
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4981
f0fe95f9e21c mod_s2s_smacks_timeout: Use mod_smacks to close stale s2s connections
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 # Introduction
f0fe95f9e21c mod_s2s_smacks_timeout: Use mod_smacks to close stale s2s connections
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2
f0fe95f9e21c mod_s2s_smacks_timeout: Use mod_smacks to close stale s2s connections
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3 This module closes s2s connections when
f0fe95f9e21c mod_s2s_smacks_timeout: Use mod_smacks to close stale s2s connections
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4 [mod_smacks][doc:modules:mod_smacks] reports that a connection has not
f0fe95f9e21c mod_s2s_smacks_timeout: Use mod_smacks to close stale s2s connections
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5 received a timely acknowledgement as requested, indicating that the
f0fe95f9e21c mod_s2s_smacks_timeout: Use mod_smacks to close stale s2s connections
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6 connection is broken or the remote server is not responding.
f0fe95f9e21c mod_s2s_smacks_timeout: Use mod_smacks to close stale s2s connections
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7
f0fe95f9e21c mod_s2s_smacks_timeout: Use mod_smacks to close stale s2s connections
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8 With the connection closed, the next stanza to be directed to that
f0fe95f9e21c mod_s2s_smacks_timeout: Use mod_smacks to close stale s2s connections
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9 server will trigger Prosody to establish a new connection, instead of
f0fe95f9e21c mod_s2s_smacks_timeout: Use mod_smacks to close stale s2s connections
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10 queueing it on the potentially broken connection.
f0fe95f9e21c mod_s2s_smacks_timeout: Use mod_smacks to close stale s2s connections
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11
f0fe95f9e21c mod_s2s_smacks_timeout: Use mod_smacks to close stale s2s connections
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12 This should prevent messages from being stuck in a queue for a
f0fe95f9e21c mod_s2s_smacks_timeout: Use mod_smacks to close stale s2s connections
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13 potentially long time before being bounced back to the sender as
f0fe95f9e21c mod_s2s_smacks_timeout: Use mod_smacks to close stale s2s connections
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14 delivery failure reports.
f0fe95f9e21c mod_s2s_smacks_timeout: Use mod_smacks to close stale s2s connections
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15
f0fe95f9e21c mod_s2s_smacks_timeout: Use mod_smacks to close stale s2s connections
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16 Normally the amount of time it takes for a broken connection to time out
f0fe95f9e21c mod_s2s_smacks_timeout: Use mod_smacks to close stale s2s connections
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17 is determined by TCP.
f0fe95f9e21c mod_s2s_smacks_timeout: Use mod_smacks to close stale s2s connections
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18
f0fe95f9e21c mod_s2s_smacks_timeout: Use mod_smacks to close stale s2s connections
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19 If this is deemed sensible behavior then it will likely be merged into
f0fe95f9e21c mod_s2s_smacks_timeout: Use mod_smacks to close stale s2s connections
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20 Prosody itself somewhere.