LTTNG-IOUSAGETOP(1)

💅 LTTNG-IOUSAGETOP 💅

okay bestie, gather round, because this one is lttng-iousagetop from the LTTng analyses fam — it's the tool that does the whole "top" thing but for I/O. Yes. Like top, but for your I/O requests. She's a User Command, she's iconic, she's gonna tell you who's hogging the I/O. 🦋

✨ NAME ✨

lttng-iousagetop — LTTng analyses IO usage top

🌸 DESCRIPTION 🌸

ok so here's the vibe, the invocation goes a little something like this:

usage: lttng-iousagetop [-h] [-r REFRESH] [--gmt] [--skip-validation]

[--begin BEGIN] [--end END] [--period PERIOD]
       [--period-captures PERIOD_CAPTURES] [--period-begin PERIOD_BEGIN]
       [--period-end PERIOD_END] [--period-begin-key PERIOD_BEGIN_KEY]
       [--period-end-key PERIOD_END_KEY] [--period-key-value
       PERIOD_KEY_VALUE] [--cpu CPU] [--timerange TIMERANGE]
       [--progress-use-size] [--no-intersection] [-V] [--debug]
       [--no-color] [--no-progress] [--min MIN] [--max MAX] [--log]
       [--limit LIMIT] [--top] [--stats] [--freq] [--freq-resolution
       FREQ_RESOLUTION] [--freq-uniform] [--freq-series] [--usage]
       [--minsize MINSIZE] [--maxsize MAXSIZE] <path/to/trace>

The I/O command. 🫶 That's literally what it says. She's the I/O one.

🎀 positional arguments 🎀

• <path/to/trace> — trace path. that's it, that's the whole thing. hand her the path to your trace and she'll do her little analysis thing. 💖

💅 optional arguments 💅

• -h, --help — show this help message and exit. the classic. when in doubt, -h it out. ✨
• -r REFRESH, --refresh REFRESH — Refresh period, with optional units suffix (default units: s). so you can say like 5 and it's 5 seconds, or give it a suffix if you're feeling fancy.
• --gmt — Manipulate timestamps based on GMT instead of local time. no more "wait what timezone was this in" 😭
• --skip-validation — Skip the trace validation. living dangerously, love that for you.
• --begin BEGIN — start time: hh:mm:ss[.nnnnnnnnn]. nanoseconds optional, diva behavior optional but encouraged.
• --end END — end time: hh:mm:ss[.nnnnnnnnn]. same format, other end of the sandwich.
• --period PERIOD — Period definition. yes that's the whole description. slay.
• --period-captures PERIOD_CAPTURES — Period captures definition.
• --period-begin PERIOD_BEGIN — Analysis period start marker event name.
• --period-end PERIOD_END — Analysis period end marker event name (requires --period-begin). ⚠️ bestie she NEEDS her --period-begin, they're a package deal, don't separate them.
• --period-begin-key PERIOD_BEGIN_KEY — Optional, list of event field names used to match period markers (default: cpu_id).
• --period-end-key PERIOD_END_KEY — Optional, list of event field names used to match period marker. If none specified, use the same --period-begin-key. she shares, it's cute.
• --period-key-value PERIOD_KEY_VALUE — Optional, define a fixed key value to which a period must correspond to be considered.
• --cpu CPU — Filter the results only for this list of CPU IDs. pick your faves.
• --timerange TIMERANGE — time range: [begin,end].
• --progress-use-size — use trace size to approximate progress. progress bar but make it estimated 💀
• --no-intersection — disable stream intersection mode. turning off the default, noted.
• -V, --version — show program's version number and exit.
• --debug — Enable debug mode (or set LTTNG_ANALYSES_DEBUG environment variable). two ways to get the tea, your choice 🍓
• --no-color — Disable colored output. for when the rainbow is too much (never, but okay).
• --no-progress — Don't display the progress bar. she'll just sit there quietly, mysterious, main character energy.
• --min MIN — Filter out durations shorter than min usec. bye tiny durations 👋
• --max MAX — Filter out durations longer than max usec. bye big durations 👋
• --log — Output the I/O requests in chronological order. timeline girlies rise up.
• --limit LIMIT — Limit to top X (default = 10). ten is the default. ten little faves.
• --top — Output the top I/O latencies by category.
• --stats — Output the I/O latency statistics.
• --freq — Output the I/O latency frequency distribution.
• --freq-resolution FREQ_RESOLUTION — Frequency distribution resolution (default 20).
• --freq-uniform — Use a uniform resolution across distributions.
• --freq-series — Consolidate frequency distribution histogram as a single one.
• --usage — Output the I/O usage.
• --minsize MINSIZE — Filter out, I/O operations working with less that minsize bytes. (that's the original wording bestie, "less that", I'm just the messenger 🫶)
• --maxsize MAXSIZE — Filter out, I/O operations working with more that maxsize bytes. (again, "more that", verbatim, no cap)

💀 quick vibe check: --period-end will NOT work without --period-begin. don't do it. don't be that girl.

that's the whole page babes, every flag accounted for, nothing skipped, we ate and left no crumbs. 💖✨

LTTng Analyses v0.6.0 🌈 January 2017 — yeah she's an elder but she still serves. mwah 💅🎀🦋