annotate mod_debug_traceback/README.markdown @ 4942:e7b9bc629ecc

mod_rest: Add special handling to catch MAM results from remote hosts Makes MAM queries to remote hosts works. As the comment says, MAM results from users' local archives or local MUCs are returned via origin.send() which is provided in the event and thus already worked. Results from remote hosts go via normal stanza routing and events, which need this extra handling to catch. This pattern of iq-set, message+, iq-result is generally limited to MAM. Closest similar thing might be MUC join, but to really handle that you would need the webhook callback mechanism.
author Kim Alvefur <zash@zash.se>
date Mon, 16 May 2022 19:47:09 +0200
parents 5841d54cb6c6
children 0358fcf14cd6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4214
5841d54cb6c6 mod_debug_traceback: Descendent of mod_traceback with some additional features
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
1 ---
5841d54cb6c6 mod_debug_traceback: Descendent of mod_traceback with some additional features
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
2 labels:
5841d54cb6c6 mod_debug_traceback: Descendent of mod_traceback with some additional features
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
3 - 'Stage-Alpha'
5841d54cb6c6 mod_debug_traceback: Descendent of mod_traceback with some additional features
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
4 summary: Generate tracebacks on-demand
5841d54cb6c6 mod_debug_traceback: Descendent of mod_traceback with some additional features
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
5 ---
5841d54cb6c6 mod_debug_traceback: Descendent of mod_traceback with some additional features
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
6
5841d54cb6c6 mod_debug_traceback: Descendent of mod_traceback with some additional features
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
7 # Introduction
5841d54cb6c6 mod_debug_traceback: Descendent of mod_traceback with some additional features
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
8
5841d54cb6c6 mod_debug_traceback: Descendent of mod_traceback with some additional features
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
9 This module writes out a traceback to a file when a chosen signal (by default
5841d54cb6c6 mod_debug_traceback: Descendent of mod_traceback with some additional features
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
10 `SIGUSR1`) is received. It can be useful to diagnose cases where Prosody is
5841d54cb6c6 mod_debug_traceback: Descendent of mod_traceback with some additional features
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
11 unresponsive.
5841d54cb6c6 mod_debug_traceback: Descendent of mod_traceback with some additional features
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
12
5841d54cb6c6 mod_debug_traceback: Descendent of mod_traceback with some additional features
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
13 # Configuration
5841d54cb6c6 mod_debug_traceback: Descendent of mod_traceback with some additional features
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
14
5841d54cb6c6 mod_debug_traceback: Descendent of mod_traceback with some additional features
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
15 `debug_traceback_filename`
5841d54cb6c6 mod_debug_traceback: Descendent of mod_traceback with some additional features
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
16 : The name of the file to write the traceback to. Some variables
5841d54cb6c6 mod_debug_traceback: Descendent of mod_traceback with some additional features
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
17 are supported, see [mod_log_ringbuffer] docs for more info. Defaults
5841d54cb6c6 mod_debug_traceback: Descendent of mod_traceback with some additional features
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
18 to `{paths.data}/traceback-{pid}-{count}.log`.
5841d54cb6c6 mod_debug_traceback: Descendent of mod_traceback with some additional features
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
19
5841d54cb6c6 mod_debug_traceback: Descendent of mod_traceback with some additional features
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
20 `debug_traceback_signal`
5841d54cb6c6 mod_debug_traceback: Descendent of mod_traceback with some additional features
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
21 : The name of the signal to listen for. Defaults to `SIGUSR1`.
5841d54cb6c6 mod_debug_traceback: Descendent of mod_traceback with some additional features
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
22
5841d54cb6c6 mod_debug_traceback: Descendent of mod_traceback with some additional features
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
23 # Compatibility
5841d54cb6c6 mod_debug_traceback: Descendent of mod_traceback with some additional features
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
24
5841d54cb6c6 mod_debug_traceback: Descendent of mod_traceback with some additional features
Matthew Wild <mwild1@gmail.com>
parents:
diff changeset
25 Prosody 0.11 or later.