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.