File

mod_s2s_status/README.md @ 6114:dc2cce03554d

mod_pubsub_subscription: Match stanzas with fixed prefix only This should help filter out any other unrelated iq stanzas which may be exchanged with the pubsub service. For example, a separate module was requesting the item list from a subscribed node, but this module was incorrectly attempting to handle the result.
author Matthew Wild <mwild1@gmail.com>
date Sat, 28 Dec 2024 15:23:33 +0000
parent 6003:fe081789f7b5
line wrap: on
line source

---
labels:
- 'Stage-Alpha'
summary: 'Track the status and health of s2s connections'
...

Introduction
============

Prosody already gives some insight into current s2s connections, e.g. via
the `s2s:show()` command in the console. This will tell you about all current
s2s connections.

However sometimes this is not enough. For example if an s2s connection fails
to establish, it won't show up - you have to go digging through the log file
looking for the errors instead.

This module maintains a record of recent connection attempts to a remote
domain. You can use this module to answer questions such as:

- Why did the last connection attempt to `example.com` fail?
- When did I last have a successful connection with `example.com`?
- Are my s2s connections generally stable?

**Note:** At the time of writing, this module is not yet finished, and should
be considered a proof-of-concept.

# Configuration

Just load the module as normal:

``` {.lua}
modules_enabled = {
  ...
  "s2s_status";
  ...
}
```

# Compatibility

trunk (0.12) and later, e.g. due to [60676b607b6d](https://hg.prosody.im/trunk/rev/60676b607b6d).