LTTNG-PERIODLOG(1)

📦 version 0.6.1, in debian bookworm, ubuntu jammy

💖 lttng-periodlog — the manual page, but make it a group chat 💖

okay so bestie, welcome to lttng-periodlog, straight out of the LTTng Analyses manual (section 1, user commands, obviously). this little icon analyses your period log and it is lowkey doing the most for you. let's get into it 🫶

✨ NAME ✨

lttng-periodlog — LTTng analyses period log

like. the name says it all. it analyses the period log. periodt. 💅

🌸 DESCRIPTION 🌸

here's the whole vibe, exactly as it comes:

usage: lttng-periodlog [-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 it. that's the description. no notes. 🎀

🦋 positional arguments 🦋

  • <path/to/trace> — trace path. literally just hand it the path to your trace and let it cook. ✨

💅 optional arguments 💅

bestie there are SO many options, buckle up, we're going through every single one:

  • -h, --help — show this help message and exit. the classic. the moment you're lost, you ask, it answers. 😌
  • -r REFRESH, --refresh REFRESH — Refresh period, with optional units suffix (default units: s). so if you don't say a unit, it's seconds, no cap.
  • --gmt — Manipulate timestamps based on GMT instead of local time. your timezone doesn't get a say here. 🌍
  • --skip-validation — Skip the trace validation. living dangerously, we love that for you, but you're on your own if it's cursed. 💀
  • --begin BEGIN — start time: hh:mm:ss[.nnnnnnnnn]. the where-does-it-start energy. ⭐
  • --end END — end time: hh:mm:ss[.nnnnnnnnn]. the where-does-it-stop energy. ⭐
  • --period PERIOD — Period definition. you define the period. it's giving main character. 👑
  • --period-captures PERIOD_CAPTURES — Period captures definition. now define the captures too. 🎀
  • --period-begin PERIOD_BEGIN — Analysis period start marker event name. the lil flag that says "the period starts HERE". 🌸
  • --period-end PERIOD_END — Analysis period end marker event name (requires --period-begin). you cannot end a period you never began, bestie. it's a package deal. 🙈
  • --period-begin-key PERIOD_BEGIN_KEY — Optional, list of event field names used to match period markers (default: cpu_id). if you don't specify, it just assumes 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. so it'll just copy your beginning energy. matching sets, adorable. 💖
  • --period-key-value PERIOD_KEY_VALUE — Optional, define a fixed key value to which a period must correspond to be considered. like a little bouncer at the door of your analysis. 🚪
  • --cpu CPU — Filter the results only for this list of CPU IDs. pick your faves. 🔥
  • --timerange TIMERANGE — time range: [begin,end]. brackets included, we're being precise. 🎯
  • --progress-use-size — use trace size to approximate progress. because vibes alone aren't a measurement. 📏
  • --no-intersection — disable stream intersection mode. turning it OFF, on purpose, as a choice. 💅
  • -V, --version — show program's version number and exit. the "who even am i" button. 🌈
  • --debug — Enable debug mode (or set LTTNG_ANALYSES_DEBUG environment variable). env var girlies, this one's for you. 🐛
  • --no-color — Disable colored output. for when you want your terminal to be sad and beige. 😭
  • --no-progress — Don't display the progress bar. some of us can't handle the suspense. 🙈
  • --min MIN — Filter out durations shorter than min usec. bye bye tiny durations. 👋
  • --max MAX — Filter out durations longer than max usec. bye bye huge durations. 👋
  • --freq — Output statistics about periods durations. the numbers, the data, the tea. 📊
  • --freq-resolution FREQ_RESOLUTION — Frequency distribution resolution (default 20). twenty is the default, don't come for me. ⭐
  • --freq-uniform — Use a uniform resolution across distributions. consistent. symmetrical. iconic. ✨
  • --freq-series — Consolidate frequency distribution histogram as a single one. all the little histograms holding hands and becoming one. 🫶
  • --limit LIMIT — Limit to top X (default = 10). only the top ten get to shine. 👑
  • --top — Output the top sched switch durations. ranking the sched switches, leaderboard style. 🔥
  • --log — Output the sched switches in chronological order. one after another, in order, like a story. 📖
  • --stats — Output sched switch statistics. the stats. the whole stats. 😌
  • --min-duration MIN_DURATION — Filter out, periods shorter that duration (usec). [sic] — yes that's the original wording, I'm not touching it, I'm just a girl. 💀
  • --max-duration MAX_DURATION — Filter out, periods longer than duration (usec). the long ones get evicted. 🚪
  • --aggregate-by AGGREGATE_BY — FIXME. yeah bestie the docs literally just say FIXME, I cannot make this up, I'm reporting what I see. 😭
  • --select SELECT — FIXME. same situation. FIXME. we're all FIXME here. 🙈
  • --group-by GROUP_BY — Present the results grouped by a list of fields(period.captured_field[, period.captured_field2]). cute lil grouping, comma-separated, go wild. 🎀
  • --order-by ORDER_BY — hierarchy, time. two options, pick your order, that's the whole menu. ⭐
💜 reminder bestie: --period-end will NOT work without --period-begin. the code is strict about this one. also --aggregate-by and --select are documented as FIXME, so don't @ me, @ the source.

and that's the whole page, no skips, every flag accounted for. LTTng Analyses v0.6.0, dated January 2017 — shoutout to the version and the date, they were doing their thing back then and they're still doing it now. go analyse some periods, you've got this. bye bestie 💖✨🎀

📦 where this page comes from