tlog-rec.conf(5)

💖 tlog-rec.conf — bestie's guide to the config file 💖

okay so welcome to tlog-rec.conf(5) from the File Formats Manual, and no cap this is the file that tells tlog-rec how to behave. we're gonna go through everything, so grab a strawberry 🍓 and let's go.

---

✨ NAME ✨

tlog-rec.conf — the configuration file for the tlog-rec program, periodt.

---

🦋 DESCRIPTION 🦋

tlog-rec.conf is a JSON-format config file for the tlog-rec program. and here's the slay part: contrary to the strict JSON specification, both C and C++ style comments are allowed in the file. yes bestie, you can leave lil notes for yourself. iconic. 💅

the file must contain a single JSON object with the objects and fields described down below. almost all of them are optional and just assume a default value. but the ones that do require a value? they can still be omitted, and you can hand them to tlog-rec in other ways instead: through environment variables or the command line. flexible queen behavior. 👑

---

🌈 OBJECTS AND FIELDS 🌈

🌸 Root object

• latency (integer) — the number of seconds to cache captured data for before logging. the encoded data which does not reach payload size stays in memory and is not logged until this number of seconds elapses. lowkey it's just vibing in RAM until the timer runs out.
  • Minimum: 1
  • Default: 10
• payload (integer) — the maximum encoded data (payload) size per message, in bytes. as soon as payload exceeds this number of bytes, it is formatted into a message and logged. she simply cannot hold it in anymore. 😭
  • Minimum: 32
  • Default: 2048
• log (object) — the logged data set object, see below bestie ⬇️
• limit (object) — the logging limit object, see below ⬇️
• file (object) — the file writer object, see below ⬇️
• syslog (object) — the syslog writer object, see below ⬇️
• journal (object) — the journal writer object, see below ⬇️
• writer (string) — the type of "log writer" to use for logging. the writer needs to be configured using its dedicated parameters, so don't just pick a fave and ghost it. 🙈
  • One of: "journal", "syslog", "file"
  • Default: "file"

---

🎀 log — Logged data set object

• input (boolean) — if true, user input is logged.
  • Default: false
• output (boolean) — if true, terminal output is logged.
  • Default: true
• window (boolean) — if true, terminal window size changes are logged. every resize is main character energy apparently. ✨
  • Default: true

---

💜 limit — Logging limit object

• rate (integer) — the maximum rate messages could be logged at, in bytes/sec.
  • Minimum: 0
  • Default: 16384
• burst (integer) — the number of bytes by which logged messages are allowed to exceed the rate limit momentarily, i.e. "burstiness". she's allowed a lil moment. 💅
  • Minimum: 0
  • Default: 32768
• action (string) — the logging limit action. if set to "pass" no logging limits will be applied. if set to "delay", logging will be throttled. if set to "drop", messages exceeding limits will be dropped. choose your fighter.
  • One of: "pass", "delay", "drop"
  • Default: "pass"

---

🫶 file — File writer object

• path (string) — the "file" writer log file path.
  • No default. yeah bestie, you gotta supply this one yourself, no auto-pilot here. 🚨

---

🌟 syslog — Syslog writer object

• facility (string) — the syslog facility the "syslog" writer should use for messages.
  • One of: "auth", "authpriv", "cron", "daemon", "ftp", "kern", "local0", "local1", "local2", "local3", "local4", "local5", "local6", "local7", "lpr", "mail", "news", "syslog", "user", "uucp"
  • Default: "authpriv"
• priority (string) — the syslog priority the "syslog" writer should use for messages.
  • One of: "emerg", "alert", "crit", "err", "warning", "notice", "info", "debug"
  • Default: "info"

---

🧚 journal — Journal writer object

• priority (string) — the syslog-style priority the "journal" writer should use for messages.
  • One of: "emerg", "alert", "crit", "err", "warning", "notice", "info", "debug"
  • Default: "info"
• augment (boolean) — if true, the "journal" writer copies the following JSON fields to Journal fields: user -> TLOG_USER, session -> TLOG_SESSION, rec -> TLOG_REC, and id -> TLOG_ID. it's giving ✨mapping✨.
  • Default: true

---

🔥 EXAMPLES 🔥

a configuration specifying only a reduced latency:

{
    "latency": 3
}

a configuration enabling logging user input:

{
    "log": {
        "input": true
    }
}

a configuration specifying logging to a file:

{
    "writer": "file"
    "file" : {
        "path": "/var/log/tlog-rec.log"
    }
}

---

⭐ SEE ALSO ⭐

tlog-rec(8), http://json.org/

---

👑 AUTHOR 👑

Nikolai Kondrashov <spbnick@gmail.com> — the legend who made all of this happen. we stan. 🫶

---

and that's the whole page bestie, you ate it. this was Tlog, dated May 2017, and the manual page we just devoured was tlog-rec.conf(5) 💖 stay slaying, and remember: no default for path, so don't come crying to me when your file writer has nowhere to write. mwah. 💅✨