Mercurial > prosody-modules

comparison mod_log_ringbuffer/README.markdown @ 4219:b3dd77f2d0d7

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_log_ringbuffer: Switch `filename` to not be interpolated, add filename_template which is
author Matthew Wild <mwild1@gmail.com>
date Fri, 16 Oct 2020 18:41:15 +0100
parents 86f8ece24029
children 0b1b7d671448
comparison
equal deleted inserted replaced
4218:f917bb78ab67 4219:b3dd77f2d0d7
49 `size` 49 `size`
50 : The size, in bytes, of the buffer. When the buffer fills, 50 : The size, in bytes, of the buffer. When the buffer fills,
51 old data will be overwritten by new data. 51 old data will be overwritten by new data.
52 52
53 `filename` 53 `filename`
54 : The name of the file to dump logs to when triggered. The filename may 54 : The name of the file to dump logs to when triggered.
55 contain a number of variables, described below. Defaults to 55
56 `filename_template`
57 : This parameter may optionally be specified instead of `filename. It
58 may contain a number of variables, described below. Defaults to
56 `"{paths.data}/ringbuffer-logs-{pid}-{count}.log"`. 59 `"{paths.data}/ringbuffer-logs-{pid}-{count}.log"`.
57 60
58 Only one of the following triggers may be specified: 61 Only one of the following triggers may be specified:
59 62
60 `signal` 63 `signal`
65 `event` 68 `event`
66 : Alternatively, the name of a Prosody global event that will trigger 69 : Alternatively, the name of a Prosody global event that will trigger
67 the logs to be dumped, e.g. `"config-reloaded"`. 70 the logs to be dumped, e.g. `"config-reloaded"`.
68 71
69 ## Filename variables 72 ## Filename variables
73
74 If `filename_template` is specified instead of `filename`, it may contain
75 any of the following variables in curly braces, e.g. `{pid}`.
70 76
71 `pid` 77 `pid`
72 : The PID of the current process 78 : The PID of the current process
73 79
74 `count` 80 `count`