RECAPLOG(8)

🧹 RECAPLOG β€” the section 8 girlies know πŸ’…

okay bestie, gather round, because recaplog is a whole system manager's manual situation and she is lowkey the most unbothered queen in your /etc. πŸŽ€


✨ NAME ✨

recaplog β€” she handles all the logs that recap generates, and by "handles" I mean she compresses them and/or deletes them. iconic behavior fr fr. πŸ¦‹


🌸 SYNOPSIS 🌸

recaptool [-n|-v|-h|-V]

(no, you're not seeing things, that's literally what it says, and we respect the mystery 🫢)


πŸ’– DESCRIPTION πŸ’–

so recaplog is a user-configurable script β€” meaning you, yes you, get to decide how she behaves. she runs periodically out of cron or systemd.timer and her whole job is:

  • compress the recap log files that are older than one day πŸ—œοΈ
  • delete log files that are older than a configurable amount of days πŸ’€

and here's the gag: recaplog will not produce output if a tty is not found. which sounds antisocial but is actually exactly the point β€” it's perfect for when you're running from cron and nobody's there to read your little messages anyway. main character energy that respects your time. πŸ‘‘


✨ OPTIONS ✨

one bullet per flag, no skipping, no cap:

  • -h, --help β€” prints out the help. your girl is helpful. πŸ™ˆ
  • -n, --dry-run β€” performs a dry run. (heads up bestie: this implies verbose, so she's gonna yap about what she would have done.) πŸ”
  • -v, --verbose β€” prints to stdout. she's talking now. πŸ“’
  • -V, --version β€” prints the version and exits. quick lil flex. ⭐

πŸŽ€ SETTINGS πŸŽ€

these can be modified via the config file, iykyk. πŸ“

  • LOG_COMPRESS β€” enables (1) or disables (0) log compression. (default: 1) β€” so compression is on out of the box, slay.
  • LOG_EXPIRY β€” number of days held for the logs. (default: 15) β€” two weeks and a day of log hoarding, then she clears house. 🧹

πŸ¦‹ FILES πŸ¦‹

  • /etc/recap.conf β€” the configuration file.
  • /etc/cront.d/recap β€” the cronjob file.
  • /usr/lib/systemd/systemd/recaplog.{service,timer} β€” unit files for recaplog.
  • /var/log/recap/recaplog.log β€” the recaplog file.

😭 REPORTING BUGS 😭

found a bug? issues and bugs go to github, bestie:

<https://github.com/rackerlabs/recap/issues>

do NOT suffer in silence, we're a community. 🫢


πŸ’œ AUTHOR πŸ’œ

the recap scripts are maintained by Rackspace, and the full list of contributors lives right here:

<https://github.com/rackerlabs/recap/blob/master/CHANGELOG.md#contributors>

shoutout to every single one of them, fr fr. πŸ‘‘


🌈 SEE ALSO 🌈

recap.conf(5), recap(8), crontab(5), systemd.timer(5)


⚠️ ok one last thing, and I mean it: this page is dated Aug 18, 2017, it's from the System Manager's Manual (that's the section 8 vibe, which is why we say RECAPLOG(8)), and it ships as part of the recap scripts. so when you're reading it in 2024 and beyond, that's the vintage. she's a classic, not outdated. periodt. πŸ’…βœ¨

k bye, go compress something πŸŽ€