Mercurial > prosody-modules
diff mod_log_ringbuffer/README.markdown @ 4220:0b1b7d671448
mod_log_ringbuffer: Document how to integrate with mod_debug_traceback
author | Matthew Wild <mwild1@gmail.com> |
---|---|
date | Fri, 16 Oct 2020 18:48:08 +0100 |
parents | b3dd77f2d0d7 |
children | df2ccb42a241 |
line wrap: on
line diff
--- a/mod_log_ringbuffer/README.markdown Fri Oct 16 18:41:15 2020 +0100 +++ b/mod_log_ringbuffer/README.markdown Fri Oct 16 18:48:08 2020 +0100 @@ -92,6 +92,29 @@ The filename does not have to be unique for every dump - if a file with the same name already exists, it will be appended to. +## Integration with mod_debug_traceback + +This module can be used in combination with [mod_debug_traceback] so that debug +logs are dumped at the same time as the traceback. Use the following configuration: + +``` {.lua} +log = { + --- + -- other optional logging config here -- + --- + + { + to = "ringbuffer"; + level = "debug"; + filename_template = "{paths.data}/traceback-{pid}-{count}.log"; + event = "debug_traceback/triggered"; + }; +} +``` + +If the filename template matches the traceback path, both logs and traceback will +be combined into the same file. Of course separate files can be specified if preferred. + # Compatibility 0.11 and later.