CARBON-CACHE(1)

💖 CARBON-CACHE(1) 💖

okay bestie, buckle up, we're doing the carbon-cache page from the General Commands Manual and it's genuinely so good. this is section 1, the real one, the command-line one. let's go 🦋

---

✨ NAME ✨

carbon-cache — accepts metrics over various protocols and writes them to disk

like. that's the whole job. it takes your metrics from wherever and it puts them on disk. iconic behavior honestly.

---

🌸 SYNOPSIS 🌸

carbon-cache [options] start

yeah, the start at the end is not optional-vibes, it's part of the command. don't forget it 💅

---

🎀 DESCRIPTION 🎀

so carbon-cache accepts metrics over various protocols and writes them to disk as efficiently as possible. and the way it does that?? okay so it requires caching metric values in RAM as they are received, and then flushing them to disk on an interval using the underlying whisper library. that's the whole trick. RAM first, disk later, on a timer. main character energy fr fr ✨

the options are described below. yes all of them. we're not skipping any, i would never do that to you 🫶

---

👑 OPTIONS 👑

• -h, --help — shows you the embedded help. the built-in one. the little cheat sheet that lives inside the program itself 💖
• --debug — runs in the foreground and logs to stdout. so it's right there in your face instead of hiding in a file. perfect for when you're like "what is happening" 😭
• --profile=PROFILE — records performance profile data and writes it to the given file. give it a PROFILE and it'll drop the profile data there 📊
• --pidfile=PIDFILE — writes the pid to the given file. that's PIDFILE, your choice of path, and the process id goes in it 🎀
• --config=CONFIG — uses the given config file. you point at CONFIG and that's the one it reads 💅
• --logdir=LOGDIR — writes logs into the given directory. LOGDIR is where all the logging lands 🗂️
• --instance=INSTANCE — manages a specific carbon instance. name your INSTANCE and that's the one getting managed ⭐

---

🌈 AUTHOR 🌈

carbon-cache was created by Chris Davis. king behavior 👑

and this manual page was written by Jonas Genannt <jonas.genannt@capi2name.de>, for the Debian project (but may be used by others). so if you're using it somewhere else, you're absolutely welcome, no gatekeeping here 🫶

---

not me getting emotional over a metrics daemon. anyway. go write your metrics to disk bestie, you got this 💜

that's the whole page!! footer says CARBON-CACHE(1), it's the General Commands Manual, section 1, and yes this is the entire thing, start to finish ✨