view mod_s2s_status/README.markdown @ 5951:d6a695abb33c

mod_ping_muc: Delay ping a configurable amount of time If a server is restarting, checking immediately before it has a chance to complete its restart and get ready would often fail, preventing the possibility of transparent restarts as supported by Prosody's mod_muc. Reconnecting immediately when a connection is closed for being idle, or because the remote server is trying to reclaim some resources, is also counter-productive as the connection may fail. Also, if there is some Internet routing problem affecting s2s, it may help to wait a bit before checking, in case the problem resolved itself in the mean time.
author Kim Alvefur <zash@zash.se>
date Sun, 11 Aug 2024 16:10:24 +0200
parents b86282953663
children
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).