annotate mod_debug_traceback/README.markdown @ 4298:020dd0a59f1f

mod_muc_markers: Add option for @id rewriting, default off (may break some clients) XEP-0333 was updated to clarify that stanza-id should be used instead of the 'id' attribute when in a MUC. Some clients still use the id attribute, which is why we were rewriting it. Rewriting is bad because mod_muc advertises stable_id, indicating that Prosody does *not* rewrite ids. Recent versions of Conversations actually depend on this being true. All clients should migrate to using stanza-id for markers. See XEP-0333.
author Matthew Wild <mwild1@gmail.com>
date Mon, 14 Dec 2020 12:09:25 +0000
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.