Mercurial > prosody-modules
view mod_log_json/README.markdown @ 3842:501c7edc8c37
mod_rest: Encode errors as JSON
This applies to *all* errors in the entire HTTP server, which might be a
bit awkward.
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Wed, 15 Jan 2020 21:38:03 +0100 |
parents | bc865568ff02 |
children | 4356088ad675 |
line wrap: on
line source
--- summary: JSON Log Sink --- Conifiguration ============== Here we log to `/var/log/prosody/prosody.json`: ``` {.lua} log = { -- your other log sinks info = "/var/log/prosody/prosody.log" -- add this: { to = "json", filename = "/var/log/prosody/prosody.json" }; } ``` ## UDP Alternatively, it can send logs via UDP: ```lua log = { { to = "json", udp_host = "10.1.2.3", udp_port = "9999" }; } ``` Format ====== JSON log files consist of a series of `\n`-separated JSON objects, suitable for mangling with tools like [`jq`](https://stedolan.github.io/jq/). Example (with whitespace and indentation for readability): ``` {.json} { "args" : [], "datetime" : "2019-11-03T13:38:28Z", "level" : "info", "message" : "Client connected", "source" : "c2s55f267f5b9d0" } { "args" : [ "user@example.net" ], "datetime" : "2019-11-03T13:38:28Z", "level" : "debug", "message" : "load_roster: asked for: %s", "source" : "rostermanager" } ``` `datetime` : [XEP-0082]-formatted timestamp. `source` : Log source, usually a module or a connected session. `level` : `debug`, `info`, `warn` or `error` `message` : The log message in `printf` format. Combine with `args` to get the final message. `args` : Array of extra arguments, corresponding to `printf`-style `%s` formatting in the `message`.