LTTNG-IRQSTATS-MI(1)

✨ NAME ✨

lttng-irqstats-mi — LTTng analyses IRQ statistics machine interface 🦋

okay so real talk, this is the machine interface (MI) version of the IRQ stats tool — it's the one your scripts and your other programs talk to, and it's lowkey iconic for it. periodt.

🌸 DESCRIPTION 🌸

the way this thing works is you hand it a trace and it gives you the IRQ tea back. here's the usage, exactly as the tool spits it out, no cap:

usage: lttng-irqstats-mi [-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] [--freq]
       [--freq-resolution FREQ_RESOLUTION] [--freq-uniform]
       [--freq-series] [--log] [--stats] [--irq IRQ] [--softirq SOFTIRQ]
       <path/to/trace>

The irq command. that's the vibe. that's what it is. 🫶

🎀 positional arguments 🎀

• <path/to/trace> — the trace path, bestie. that's where your trace lives and this tool is literally obsessed with it. 💅

💜 optional arguments 💜

• -h, --help — shows this help message and then dips out. classic. ✨
• -r REFRESH, --refresh REFRESH — the refresh period, and yes you can slap a units suffix on it if you want (default units: s). so like, seconds unless you say otherwise. 🕐
• --gmt — manipulates timestamps based on GMT instead of local time. timezone queen behavior. 🌍
• --skip-validation — skips the trace validation. bold move, but ok. 🙈
• --begin BEGIN — start time, in the format hh:mm:ss[.nnnnnnnnn]. those nanoseconds are optional, not me being extra for no reason.
• --end END — end time, same format: hh:mm:ss[.nnnnnnnnn]. 🎀
• --period PERIOD — Period definition.
• --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, and heads up: this one requires --period-begin. they're a package deal, fr fr. 🫶
• --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, it uses the same --period-begin-key. matching outfits, cute. 👑
• --period-key-value PERIOD_KEY_VALUE — Optional, define a fixed key value to which a period must correspond to be considered. picky in a very valid way.
• --cpu CPU — Filter the results only for this list of CPU IDs. only the CPUs you care about get to be in the group chat. 💅
• --timerange TIMERANGE — time range, and it's written like [begin,end]. square brackets, bestie, don't forget them.
• --progress-use-size — use trace size to approximate progress. big trace energy. 📏
• --no-intersection — disable stream intersection mode. turning it off, respectfully. 🚫
• -V, --version — shows the program's version number and exits. slay, now you know. ⭐
• --debug — Enable debug mode (or set the LTTNG_ANALYSES_DEBUG environment variable). two ways to get the same lore.
• --no-color — disable colored output. for when you want it plain, no sparkle. 🎀
• --no-progress — don't display the progress bar. it's not doing a little dance for you today. 🚫
• --min MIN — filters out durations shorter than min usec. short king erasure, honestly. 📉
• --max MAX — filters out durations longer than max usec. bye to the long ones too. 📈
• --freq — Output the frequency distribution of handler durations. charts, but make it IRQ. 📊
• --freq-resolution FREQ_RESOLUTION — Frequency distribution resolution (default 20). you can tune the zoom level. 🔍
• --freq-uniform — Use a uniform resolution across distributions. consistency is the moment. ✨
• --freq-series — Consolidate frequency distribution histogram as a single one. all the histograms holding hands. 🫶
• --log — Output the IRQs in chronological order. timeline behavior, very main character. 🕰️
• --stats — Output IRQ statistics. the numbers, the data, the whole vibe. 🔥
• --irq IRQ — Output results only for the list of IRQ. only the ones you asked for, no extras. 💅
• --softirq SOFTIRQ — Output results only for the list of SoftIRQ. soft but make it specific. 🌸

and that's the whole page, bestie — every flag, every default, every environment variable, nothing skipped, nothing invented, no cap 💖

this gorgeous little manual is from LTTng Analyses v0.6.0, dated January 2017 — shoutout to the legends who wrote it, and shoutout to you for reading all the way to the bottom. you ate. 🍓👑✨