LTTNG-SCHEDSTATS(1)

💅 NAME 💅

lttng-schedstats — bestie, it's the LTTng tool that analyses Scheduler statistics. That's it. That's the whole job. And it eats. 👑

Oh also? This is the page from the User Commands manual, section 1. Now you know. 🫶

✨ DESCRIPTION ✨

okay so first things first, here's how you actually call this thing. look at her go:

usage: lttng-schedstats [-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>

and the short version of what it does? The sched command. 💀 iconic, truly.

🎀 POSITIONAL ARGUMENTS 🎀

• <path/to/trace> — the trace path, babes. point her at your trace and let her cook. 📍

🦋 OPTIONAL ARGUMENTS 🦋

• -h, --help — show this help message and exit. the classic. when in doubt, ask for help bestie, no shame. 🙈
• -r REFRESH, --refresh REFRESH — refresh period, and you can tack on 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 queen behavior. 🌍
• --skip-validation — skip the trace validation. living dangerously, love that for you. ⚠️
• --begin BEGIN — start time, formatted like hh:mm:ss[.nnnnnnnnn]. 🕐
• --end END — end time, same deal: hh:mm:ss[.nnnnnnnnn]. 🕐
• --period PERIOD — period definition. 📅
• --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, this one 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. if none is specified, it uses the same --period-begin-key. 🔑
• --period-key-value PERIOD_KEY_VALUE — optional, define a fixed key value that a period must correspond to in order to be considered. 🎯
• --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. 📏
• --no-intersection — disable stream intersection mode. 🚫
• -V, --version — show program's version number and exit. 👋
• --debug — enable debug mode (or set the LTTNG_ANALYSES_DEBUG environment variable, whichever vibe you prefer). 🐛
• --no-color — disable colored output. (sad, honestly, but valid.) 🎨
• --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. 📈
• --procname PROCNAME — filter the results only for this list of process names. 🏷️
• --tid TID — filter the results only for this list of TIDs. 🆔
• --freq — output the frequency distribution of sched switch latencies. 📊
• --freq-resolution FREQ_RESOLUTION — frequency distribution resolution (default 20). 🔍
• --freq-uniform — use a uniform resolution across distributions. 📐
• --freq-series — consolidate the frequency distribution histogram as a single one. 🧬
• --limit LIMIT — limit to top X (default = 10). ✂️
• --top — output the top sched switch latencies. 🏆
• --log — output the sched switches in chronological order. 📜
• --stats — output sched switch statistics. 📈
• --total — group all results (applies to stats and freq). 🧺
• --per-tid — group results per-TID (applies to stats and freq) — and yes, this is the default. 👑
• --per-prio — group results per-prio (applies to stats and freq). 🎚️

bestie reminder: --period-end will not work without --period-begin, and --period-end-key falls back to --period-begin-key if you don't give it one. read the fine print, it's giving considerate. 💖

and that's the whole page, you ate that. now go stare at some sched switches and slay. 🧚✨

LTTng Analyses v0.6.0 — dating all the way back to January 2017, and still the moment. mwah. 💋 🎀