LTTNG-PERIODSTATS-MI(1)

✨ NAME ✨

lttng-periodstats-mi — LTTng analyses period statistics machine interface 🎀

🌸 DESCRIPTION 🌸

okay so bestie, this is the periods command, and it's giving machine interface energy. here's the whole vibe of how you call it:

usage: lttng-periodstats-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] [--limit LIMIT] [--top] [--log]
       [--stats] [--min-duration MIN_DURATION] [--max-duration MAX_DURATION]
       [--aggregate-by AGGREGATE_BY] [--select SELECT] [--group-by GROUP_BY]
       [--order-by ORDER_BY] <path/to/trace>

that's the whole shape of it, no cap. 💖

🫶 POSITIONAL ARGUMENTS 🫶

• <path/to/trace> — the trace path, literally just point it at your trace and let her cook 🦋

👑 OPTIONAL ARGUMENTS 👑

• -h, --help — shows this help message and dips. classic. 💅
• -r REFRESH, --refresh REFRESH — the refresh period, and you can tack a units suffix on it if you're feeling fancy (default units: s) ⏱️
• --gmt — manipulate timestamps based on GMT instead of local time 🌍
• --skip-validation — skip the trace validation. living dangerously, iconic 😭
• --begin BEGIN — start time, formatted like hh:mm:ss[.nnnnnnnnn] ⭐
• --end END — end time, same deal: 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 bestie, this one requires --period-begin) 🙈
• --period-begin-key PERIOD_BEGIN_KEY — optional! a list of event field names used to match period markers (default: cpu_id)
• --period-end-key PERIOD_END_KEY — optional, same thing but for the period end marker. If none specified, use the same --period-begin-key 💜
• --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 🔥
• --timerange TIMERANGE — time range: [begin,end]
• --progress-use-size — use trace size to approximate progress 📏
• --no-intersection — disable stream intersection mode ✂️
• -V, --version — show program's version number and exit
• --debug — enable debug mode (or set the LTTNG_ANALYSES_DEBUG environment variable) 🐛
• --no-color — disable colored output (sad, but sometimes necessary) 🚫🌈
• --no-progress — don't display the progress bar
• --min MIN — filter out durations shorter than min usec 🍓
• --max MAX — filter out durations longer than max usec 🍓
• --freq — output statistics about periods durations 📊
• --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 🧚
• --limit LIMIT — limit to top X (default = 10)
• --top — output the top sched switch durations 🔝
• --log — output the sched switches in chronological order 📜
• --stats — output sched switch statistics 📈
• --min-duration MIN_DURATION — filter out, periods shorter that duration (usec)
• --max-duration MAX_DURATION — filter out, periods longer than duration (usec)
• --aggregate-by AGGREGATE_BY — FIXME 💀 (yes bestie, that's literally what it says, i'm not making it up)
• --select SELECT — FIXME 💀 (same, we don't know either)
• --group-by GROUP_BY — present the results grouped by a list of fields, written like period.captured_field[, period.captured_field2] 🗂️
• --order-by ORDER_BY — hierarchy, time ⏳

ngl, --aggregate-by and --select are both marked FIXME in the source. that's not me being shady, that's literally the documentation. use with vibes and caution 💅

and that's the whole page bestie!! 🌈 this was LTTng Analyses v0.6.0, dated January 2017, and the manual page is LTTNG-PERIODSTATS-MI(1). go forth and analyse those periods, you absolute main character 👑💖✨