LTTNG-PERIODTOP-MI(1)

💖 lttng-periodtop-mi — LTTng analyses period top machine interface 💖

okay bestie, sit down, hydrate, because we're talking about lttng-periodtop-mi, a whole User Command from the LTTng Analyses crew (v0.6.0 era, January 2017, vintage ✨). it's the machine interface version of the period top situation, and she is thriving. 🎀

🌈 NAME 🌈

lttng-periodtop-mi — LTTng analyses period top machine interface 🦋

✨ DESCRIPTION ✨

so like. the vibe here? it's the periods command. that's the whole thing, that's the energy. here's exactly how you invoke her:

usage: lttng-periodtop-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>

lowkey a lot of flags. highkey worth it. 💅

🫶 positional arguments (the required main character)

• <path/to/trace> — literally the trace path. that's it, that's the whole job. 🍓

💜 optional arguments (the glow-up section)

• -h, --help — shows this help message and dips out. iconic behavior. ✨
• -r REFRESH, --refresh REFRESH — refresh period, and you may tack on a units suffix (default units: s). ⏰
• --gmt — do all the timestamp math based on GMT instead of local time. timezone queen 🌍
• --skip-validation — skip the trace validation. just rawdogging it, no cap. 😭
• --begin BEGIN — start time, formatted like hh:mm:ss[.nnnnnnnnn]. 🕐
• --end END — end time, also 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 (heads up bestie, this one requires --period-begin). 🏁
• --period-begin-key PERIOD_BEGIN_KEY — optional! it's a 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 you don't specify any, it just uses the same --period-begin-key. matching sets 🫶
• --period-key-value PERIOD_KEY_VALUE — optional! define a fixed key value that a period must correspond to in order to be considered. picky but in a cute way 💅
• --cpu CPU — filter the results only for this list of CPU IDs. 💻
• --timerange TIMERANGE — time range, written as [begin,end]. 📅
• --progress-use-size — use trace size to approximate progress. big brain move 🧠
• --no-intersection — disable stream intersection mode. crossing streams? not today 🌊
• -V, --version — show the program's version number and exit. ✌️
• --debug — enable debug mode (or, alternatively, set the LTTNG_ANALYSES_DEBUG environment variable). 🐛
• --no-color — disable colored output. monochrome moment 🖤
• --no-progress — don't display the progress bar. we're going in blind, bestie 🙈
• --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. matchy matchy 🎀
• --freq-series — consolidate the frequency distribution histogram as a single one. one histogram to rule them all 👑
• --limit LIMIT — limit to top X (default = 10). top ten, we love a countdown 🏆
• --top — output the top sched switch durations. 🥇
• --log — output the sched switches in chronological order. timeline slay 📜
• --stats — output sched switch statistics. numbers numbers numbers 🔢
• --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. yeah. FIXME. the devs left a little note for themselves and honestly? relatable. 💀
• --select SELECT — FIXME. also a mystery box. 📦
• --group-by GROUP_BY — present the results grouped by a list of fields, written as period.captured_field[, period.captured_field2]. grouping is self care 🌸
• --order-by ORDER_BY — hierarchy, time. that's the ordering options, periodt. 📚

⚠️ real talk: --period-end genuinely requires --period-begin. and if you skip --period-end-key, it silently borrows --period-begin-key. not me warning you twice 💖

and that's the whole page, bestie!! this gorgeous thing is brought to you by LTTng Analyses v0.6.0, dated January 2017 — yeah she's an elder but she ATE. go trace something and stan. 💜✨🦋🎀