LTTNG-PERIODLOG-MI(1)

✨ NAME ✨

okay so bestie, welcome to lttng-periodlog-mi — it's the LTTng analyses period log machine interface 💅 this is the User Commands page, so buckle up, we're doing CLI things.

🌸 DESCRIPTION 🌸

the whole vibe in one line, fr fr:

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

and like, what is it? it's The periods command. 🦋 that's the energy. period.

🎀 positional arguments 🎀

• <path/to/trace> — literally just the trace path, bestie. hand it over. 📁

💖 optional arguments 💖

• -h, --help — show this help message and exit. the classic "help me" button, she never misses 🙈
• -r REFRESH, --refresh REFRESH — Refresh period, with optional units suffix (default units: s) ⏱️
• --gmt — Manipulate timestamps based on GMT instead of local time 🌍 no more timezone drama
• --skip-validation — Skip the trace validation. living dangerously, love that for you 💀
• --begin BEGIN — start time: hh:mm:ss[.nnnnnnnnn] ⏰
• --end END — end time: 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 (requires --period-begin) ⚠️ like, it genuinely needs the begin one, they're a package deal
• --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 🫶
• --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 LTTNG_ANALYSES_DEBUG environment variable) 🔍
• --no-color — Disable colored output. tragic, but okay 😭
• --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 the docs really just say that
• --select SELECT — FIXME 💀 it's giving unfinished homework
• --group-by GROUP_BY — Present the results grouped by a list of fields(period.captured_field[, period.captured_field2]) 🗂️
• --order-by ORDER_BY — hierarchy, time ⏳ pick your fighter

🫶 reminder bestie: the two FIXME entries are literally in the original manual, i'm not being lazy, i'm being accurate. no cap.

🌈 the cute sign-off 🌈

and that's the whole page, periodt 💜 this one came from LTTng Analyses v0.6.0, dated January 2017, and the page itself is LTTNG-PERIODLOG-MI(1) — go forth and analyse those periods, main character 🎀✨👑