view mod_debug_traceback/README.markdown @ 4983:7c77058a1ac5

mod_compat_roles: New module providing compat shim for trunk's new role API The new role API is translated to is_admin() calls on older versions. On newer versions (which have the role API) this module does nothing. It allows modules to drop their use of is_admin() (which is not available in trunk) and switch to the new role API, while remaining compatible with previous Prosody versions.
author Matthew Wild <mwild1@gmail.com>
date Thu, 11 Aug 2022 17:49:33 +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.