view mod_debug_traceback/README.markdown @ 5667:9bcd257dea4e

mod_http_health: Provide a health check HTTP endpoint Someone in the chat asked about a health check endpoint, which reminded me of mod_http_status, which was simplified to produce this module.
author Kim Alvefur <zash@zash.se>
date Fri, 06 Oct 2023 16:49:57 +0200
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.