Mercurial > prosody-modules
annotate mod_s2s_status/README.markdown @ 4974:807007913f67
mod_log_json: Prefer native Lua table.pack over Prosody util.table one
Prosody is removing support for Lua 5.1, which was the reason for
util.table.pack to exist in the first place, since Lua 5.2+ provides
table.pack. In prosody rev 5eaf77114fdb everything was switched over to
use table.pack, opening the door for removing util.table.pack at some
point. This change here is to prepare for that future eventuality.
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Mon, 11 Jul 2022 20:08:41 +0200 |
parents | b86282953663 |
children |
rev | line source |
---|---|
4791
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
1 --- |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
2 labels: |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
3 - 'Stage-Alpha' |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
4 summary: 'Track the status and health of s2s connections' |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
5 ... |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
6 |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
7 Introduction |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
8 ============ |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
9 |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
10 Prosody already gives some insight into current s2s connections, e.g. via |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
11 the `s2s:show()` command in the console. This will tell you about all current |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
12 s2s connections. |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
13 |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
14 However sometimes this is not enough. For example if an s2s connection fails |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
15 to establish, it won't show up - you have to go digging through the log file |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
16 looking for the errors instead. |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
17 |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
18 This module maintains a record of recent connection attempts to a remote |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
19 domain. You can use this module to answer questions such as: |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
20 |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
21 - Why did the last connection attempt to `example.com` fail? |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
22 - When did I last have a successful connection with `example.com`? |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
23 - Are my s2s connections generally stable? |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
24 |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
25 **Note:** At the time of writing, this module is not yet finished, and should |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
26 be considered a proof-of-concept. |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
27 |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
28 # Configuration |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
29 |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
30 Just load the module as normal: |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
31 |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
32 ``` {.lua} |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
33 modules_enabled = { |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
34 ... |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
35 "s2s_status"; |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
36 ... |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
37 } |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
38 ``` |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
39 |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
40 # Compatibility |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
41 |
b86282953663
mod_s2s_status: Module to track status of s2s connections by domain
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
42 trunk (0.12) and later, e.g. due to [60676b607b6d](https://hg.prosody.im/trunk/rev/60676b607b6d). |