LTTNG-SCHEDTOP(1)

🌸 NAME 🌸

lttng-schedtop — hey bestie 💖 it's the LTTng analyses Scheduler top, and yeah, it hangs out in the User Commands part of your manual (section 1, the classics 💅). It's literally here to look at your scheduler and give you the ✨top✨ tea.

✨ DESCRIPTION ✨

So here's the whole vibe, the usage, the whole entire thing, no cap:

usage: lttng-schedtop [-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] [--procname
       PROCNAME] [--tid TID] [--freq] [--freq-resolution
       FREQ_RESOLUTION] [--freq-uniform] [--freq-series] [--limit LIMIT]
       [--top] [--log] [--stats] [--total] [--per-tid] [--per-prio]
       <path/to/trace>

It's the sched command, periodt. 🫶

🌈 positional arguments 🌈

• <path/to/trace> — the trace path, bestie. That's the trace you're feeding it. Feed it. 🍓

🎀 optional arguments 🎀

• -h, --help — shows this help message and then dips, exits. Classic.
• -r REFRESH, --refresh REFRESH — the refresh period, and you can slap an optional units suffix on it (the default units are s). 👑
• --gmt — manipulates timestamps based on GMT instead of local time. Timezone-shifting era. 🌍
• --skip-validation — skips the trace validation. It's giving trust issues but okay, we move. 🙈
• --begin BEGIN — the start time, formatted hh:mm:ss[.nnnnnnnnn]. Not a drill, nanoseconds optional.
• --end END — the end time, also hh:mm:ss[.nnnnnnnnn]. Matching energy, slay.
• --period PERIOD — period definition. That's the whole thing, girl. ✨
• --period-captures PERIOD_CAPTURES — period captures definition.
• --period-begin PERIOD_BEGIN — the analysis period start marker event name.
• --period-end PERIOD_END — the analysis period end marker event name, and heads up, it requires --period-begin. They're a package deal, fr fr. 🫂
• --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, a list of event field names used to match period marker. And if none is specified, it uses the same --period-begin-key. Copying its bestie's notes, iconic. 💅
• --period-key-value PERIOD_KEY_VALUE — optional, defines a fixed key value that a period must correspond to before it's even considered. Gatekeeping, but make it ✨analysis✨.
• --cpu CPU — filters the results for only this list of CPU IDs. Pick your faves. 🎯
• --timerange TIMERANGE — the time range, written as [begin,end].
• --progress-use-size — uses trace size to approximate the progress. Vibes-based progress bar, but sanctioned. 🦋
• --no-intersection — disables stream intersection mode.
• -V, --version — shows the program's version number and exits. Bye bestie 👋
• --debug — enables debug mode (or you can set the LTTNG_ANALYSES_DEBUG environment variable, same difference 💜).
• --no-color — disables colored output. A no-color zone, devastating but valid. 💀
• --no-progress — doesn't display the progress bar. Just raw silence while it cooks. 🧚
• --min MIN — filters out durations shorter than min usec. Sorry short kings. 📏
• --max MAX — filters out durations longer than max usec. And sorry long ones too, balanced as all things should be. ⭐
• --procname PROCNAME — filters the results for only this list of process names.
• --tid TID — filters the results for only this list of TIDs.
• --freq — outputs the frequency distribution of sched switch latencies. 📊
• --freq-resolution FREQ_RESOLUTION — the frequency distribution resolution (default 20).
• --freq-uniform — uses a uniform resolution across distributions. Consistency queen. 👑
• --freq-series — consolidates the frequency distribution histogram as a single one. One histogram to rule them all.
• --limit LIMIT — limits to the top X (default = 10).
• --top — outputs the top sched switch latencies. The main character output, honestly. 🔥
• --log — outputs the sched switches in chronological order. Timeline mode, no skipping ahead. 🌈
• --stats — outputs sched switch statistics. Numbers girlies rise.
• --total — groups all results together (applies to stats and freq). ✨Everyone in one pile✨
• --per-tid — groups results per-TID (applies to stats and freq) — and this one is the default, so it's already doing the most without you asking. 🫶
• --per-prio — groups results per-prio (applies to stats and freq).

LTTng Analyses v0.6.0, January 2017 — that's the source, the version and the date, straight from the footer, and that's the whole page bestie. Go run it on a trace and tell me everything. 💖✨🎀