Mercurial > prosody-modules
diff mod_debug_traceback/README.markdown @ 4214:5841d54cb6c6
mod_debug_traceback: Descendent of mod_traceback with some additional features
author | Matthew Wild <mwild1@gmail.com> |
---|---|
date | Fri, 16 Oct 2020 14:23:10 +0100 |
parents | |
children | 0358fcf14cd6 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mod_debug_traceback/README.markdown Fri Oct 16 14:23:10 2020 +0100 @@ -0,0 +1,25 @@ +--- +labels: +- 'Stage-Alpha' +summary: Generate tracebacks on-demand +--- + +# Introduction + +This module writes out a traceback to a file when a chosen signal (by default +`SIGUSR1`) is received. It can be useful to diagnose cases where Prosody is +unresponsive. + +# Configuration + +`debug_traceback_filename` +: The name of the file to write the traceback to. Some variables + are supported, see [mod_log_ringbuffer] docs for more info. Defaults + to `{paths.data}/traceback-{pid}-{count}.log`. + +`debug_traceback_signal` +: The name of the signal to listen for. Defaults to `SIGUSR1`. + +# Compatibility + +Prosody 0.11 or later.