view mod_debug_traceback/README.markdown @ 4748:a6b94f4fb065

mod_rest: Correct unused reference $ref isn't supported yet, and this might not be the correct syntax, but now follows the other (un-)uses.
author Kim Alvefur <zash@zash.se>
date Thu, 04 Nov 2021 20:19:31 +0100
parents 5841d54cb6c6
children 0358fcf14cd6
line wrap: on
line source

---
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.