Mercurial > prosody-modules

comparison mod_s2s_status/README.markdown @ 4791:b86282953663

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_s2s_status: Module to track status of s2s connections by domain
author Matthew Wild <mwild1@gmail.com>
date Fri, 26 Nov 2021 10:10:02 +0000
parents
children
comparison
equal deleted inserted replaced
4790:bb66e87a3604 4791:b86282953663
1 ---
2 labels:
3 - 'Stage-Alpha'
4 summary: 'Track the status and health of s2s connections'
5 ...
6
7 Introduction
8 ============
9
10 Prosody already gives some insight into current s2s connections, e.g. via
11 the `s2s:show()` command in the console. This will tell you about all current
12 s2s connections.
13
14 However sometimes this is not enough. For example if an s2s connection fails
15 to establish, it won't show up - you have to go digging through the log file
16 looking for the errors instead.
17
18 This module maintains a record of recent connection attempts to a remote
19 domain. You can use this module to answer questions such as:
20
21 - Why did the last connection attempt to `example.com` fail?
22 - When did I last have a successful connection with `example.com`?
23 - Are my s2s connections generally stable?
24
25 **Note:** At the time of writing, this module is not yet finished, and should
26 be considered a proof-of-concept.
27
28 # Configuration
29
30 Just load the module as normal:
31
32 ``` {.lua}
33 modules_enabled = {
34 ...
35 "s2s_status";
36 ...
37 }
38 ```
39
40 # Compatibility
41
42 trunk (0.12) and later, e.g. due to [60676b607b6d](https://hg.prosody.im/trunk/rev/60676b607b6d).