view mod_debug_traceback/README.markdown @ 5668:ecfd7aece33b

mod_measure_modules: Report module statuses via OpenMetrics Someone in the chat asked about a health check endpoint, which reminded me of mod_http_status, which provides access to module statuses with full details. After that, this idea came about, which seems natural. As noted in the README, it could be used to monitor that critical modules are in fact loaded correctly. As more modules use the status API, the more useful this module and mod_http_status becomes.
author Kim Alvefur <zash@zash.se>
date Fri, 06 Oct 2023 18:34:39 +0200
parents 5841d54cb6c6
children
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.