tlog-play.conf(5)

✨ NAME ✨

okay so bestie, welcome to tlog-play.conf(5) — this is the manual for the tlog-play.conf configuration file, aka the lil glow-up doc that tells tlog-play how to behave. it's giving "File Formats Manual" energy and honestly? iconic. 💅

🌸 DESCRIPTION 🌸

tlog-play.conf is a JSON-format configuration file for the tlog-play program. now, plot twist: even though strict JSON says "no comments, bestie," this file is not like other files — both C and C++ style comments are allowed in it. so go ahead and annotate your config, you've earned it. ✨

the file has to contain a single JSON object with the objects and fields described below. some of them are optional and just assume a default value if you don't show up for them. and the ones that do require a value? you can still totally omit them and pass them to tlog-play via command-line options instead. flexible queen behavior. 👑

💖 OBJECTS AND FIELDS 💖

🫶 Root object

• reader (string) — the type of "log reader" to use for retrieving log messages. the reader you pick needs to be configured using its own dedicated parameters, so don't leave it hanging. one of: "file", "journal", "es". default: "file".
• file (object) — the File reader object, see below. 📁
• es (object) — the Elasticsearch reader object, see below. 🔍
• journal (object) — the Systemd journal reader object, see below. 📓
• persist (boolean) — if true, ignore any keyboard-generated signals and the quit key. yes, really. it just won't quit on you. default: false.
• lax (boolean) — if true, ignore missing (dropped, or lost) log messages. otherwise it reports an error and aborts when a message is missing. default: false.

ngl, lax: true is the "we don't talk about the dropped messages" setting. choose wisely, bestie. 💀

📁 file - File reader object

• path (string) — the path to the file the "file" reader should read logs from. no default. 🚫
• match (string) — the recording id of the recording the "file" reader should seek to for playback. no default. 🚫

🔍 es - Elasticsearch reader object

• baseurl (string) — the base URL to request Elasticsearch through. should not contain query (?...) or fragment (#...) parts. no default. 🚫
• query (string) — the query string to send to Elasticsearch. no default. 🚫
• verbose (boolean) — if true, enable verbose output on the Elasticsearch HTTP client. default: false.

🌈 EXAMPLES 🌈

a configuration specifying only the reader — minimal, lowkey, does the job:

{
    "reader": "file"
}

a configuration specifying the Elasticsearch reader, along with the base URL:

{
    "reader": "es"
    "es" : {
        "baseurl": "http://localhost:9200/tlog/tlog/_search"
    }
}

🎀 SEE ALSO 🎀

tlog-play(8), http://json.org/ — go read these too, fr fr. 📚

👑 AUTHOR 👑

Nikolai Kondrashov <spbnick@gmail.com> — the main character who wrote this. we stan. 🫶

and that's a wrap on the tlog-play.conf(5) manual page, bestie!! this was Tlog, dated March 2016 — yeah, she's a vintage icon and she still ate. go configure something cute. periodt. 💅✨🎀