LTTNG-PERIODFREQ-MI(1)

💅 LTTNG-PERIODFREQ-MI(1) 💅

okay bestie, sit down, hydrate, and let me tell you about lttng-periodfreq-mi — the LTTng analyses period frequency machine interface 🎀. this is the section-1 user command situation and she is ready to read your trace files. ✨

🌸 NAME 🌸

lttng-periodfreq-mi — LTTng analyses period frequency machine interface. that's it, that's the whole identity. iconic behavior only. 💖

🦋 DESCRIPTION 🦋

here's the whole vibe, literally the usage line, no cap:

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

the periods command. 🫶 that's the whole personality of this program tbh.

🎀 positional arguments: 🎀

• <path/to/trace> — the trace path. it's giving "point me at the receipts" energy. 📁

💅 optional arguments: 💅

• -h, --help — show this help message and exit. the classic "help me help you" moment, she ate. 🙈
• -r REFRESH, --refresh REFRESH — refresh period, with an optional units suffix (default units: s). so like, seconds unless you say otherwise. ⏱️
• --gmt — manipulate timestamps based on GMT instead of local time. timezone check, passed. 🌍
• --skip-validation — skip the trace validation. just trust me bro energy, use with care. 💀
• --begin BEGIN — start time: hh:mm:ss[.nnnnnnnnn]. yes, nanosecond precision, she's that detailed. ✨
• --end END — end time: hh:mm:ss[.nnnnnnnnn]. same format, opposite end of the timeline. 🌈
• --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). ⚠️ no cap: if you don't give her a --period-begin, this one's just standing there alone.
• --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 reuses, she's sustainable. ♻️
• --period-key-value PERIOD_KEY_VALUE — optional, define a fixed key value to which a period must correspond to be considered. picky in a good way. 👑
• --cpu CPU — filter the results only for this list of CPU IDs. per-core girly. 🧚
• --timerange TIMERANGE — time range: [begin,end].
• --progress-use-size — use trace size to approximate progress. math but make it approximate. 🔥
• --no-intersection — disable stream intersection mode. 🚫
• -V, --version — show program's version number and exit. the "who even am I" flag. 💫
• --debug — enable debug mode (or set LTTNG_ANALYSES_DEBUG environment variable). yesss, spill the tea, environment variable edition. 🍓
• --no-color — disable colored output. sad beige output for sad beige terminals, respect. 🥲
• --no-progress — don't display the progress bar. no little moving thing, just vibes. ✨
• --min MIN — filter out durations shorter than min usec. tiny durations, begone. 🙅
• --max MAX — filter out durations longer than max usec. long durations, also begone. 🙅
• --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 frequency distribution histogram as a single one. one histogram to rule them all. 👑
• --limit LIMIT — limit to top X (default = 10). only the main characters make the cut. 💅
• --top — output the top sched switch durations. leaderboard time. 🏆
• --log — output the sched switches in chronological order. storyline, in order, no flashbacks. 📖
• --stats — output sched switch statistics. numbers, but make them cute. 🔢✨
• --min-duration MIN_DURATION — filter out, periods shorter that duration (usec). (yes bestie, the original really does say "shorter that" — we keep it exactly, no editing the queen's grammar 💜)
• --max-duration MAX_DURATION — filter out, periods longer than duration (usec).
• --aggregate-by AGGREGATE_BY — FIXME. yeah. she said FIXME. not me documenting the documentation 😭
• --select SELECT — FIXME. same energy. 💀
• --group-by GROUP_BY — present the results grouped by a list of fields (period.captured_field[, period.captured_field2]). group chat but for fields. 🫶
• --order-by ORDER_BY — hierarchy, time. pick your sort, pick your destiny. ⭐

🫧 quick reminder bestie: the usage block above is literally the program's own text, so copy-paste it, don't retype it. typos in flags = tears. 😭

and that's the whole page, fr fr. this was LTTng Analyses v0.6.0, dated January 2017, and yeah — the header says LTTNG-PERIODFREQ-MI(1) up top and the footer says LTTNG-PERIODFREQ-MI(1) down bottom, like a little matching set. 🎀 stay hydrated, validate your traces (or don't, --skip-validation exists), and slay. 💖✨