Software / code / prosody-modules
Annotate
mod_debug_traceback/README.markdown @ 5931:d194d1012fd3
Updating dox for mod_rest. Ideas expressed / clarified:
1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component.
2) Understanding some of the implications of this choice:
A) Changes to user authentication
B) How it affects subdomains
3) More consistent use of domain names for clarity.
4) Using different heading sizes to show scope of section.
Essentially, I added all the tidbits I had to clarify in getting this to work in my
own example.
| author | Ben Smith <bens@effortlessis.com> |
|---|---|
| date | Mon, 13 May 2024 13:25:13 -0700 |
| parent | 5874:0358fcf14cd6 |
| 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 |
|
5874
0358fcf14cd6
mod_debug_traceback: Remove direct POSIX signal handling, require Prosody 0.12+
Kim Alvefur <zash@zash.se>
parents:
4214
diff
changeset
|
25 Prosody 0.12 or later. |
