Skip to content

Latest commit

 

History

History
113 lines (85 loc) · 5.18 KB

README.md

File metadata and controls

113 lines (85 loc) · 5.18 KB

try-tracing-flame

在选中的日志点捕获真实调用栈,按时间顺序生成 flame chart,或按调用栈聚合生成 flame graph。

  • 不用 #[instrument],也不用 info_span!;
  • 祖先来自运行时 backtrace,而不是手写 span 链;
  • 每个日志点生成一条 folded 记录:真实调用栈; 日志点名 宽度;
  • 宽度 = 当前日志点到下一条日志点的耗时。

思路:用 backtrace 硬造 span

span 在火焰图里无非是「一条路径 + 一段时间」,所以不需要真的创建 info_span!:

  1. 日志点触发时,先记时间戳,再 Backtrace::new_unresolved() 抓当前栈;
  2. 下一条日志点触发时,上一条的宽度就确定了(next - current);
  3. 程序结束时统一 resolve() 符号,把每条记录写成 folded:
try_tracing_flame::main; ...::handle_request; ...::query_db; db_query_start 15264101
  1. inferno-flamegraph 把这些行画成火焰图。

这样每个日志点就"硬造"了一个覆盖 [当前日志点, 下一个日志点) 的 span,栈帧来自 真实调用栈;到下一个日志点重新抓一次,路径自然切换。

为什么不用 tracing-flame:它只实现 span 的 enter/exit,on_event 不做事, 收不到 event。这里用一个自定义 Layer 直接写 folded。

运行

cargo run                    # 1. 生成 tracing.folded
cargo install inferno        # 2. 首次使用时安装转换工具
./flamegraph.sh              # 3. 时间顺序的 flame chart -> flamechart.svg
MODE=graph ./flamegraph.sh   # 4. 按调用栈聚合的 flame graph -> flamegraph.svg
xdg-open flamechart.svg
视图 命令 特点
flame chart ./flamegraph.sh x 轴是时间;只有相邻且路径完全相同的样本会连成一块,不做全局聚合
flame graph MODE=graph ./flamegraph.sh 相同调用栈全局聚合,宽度 = 该路径消耗的总时间

SVG 自带交互:悬停看详情、搜索、点击放大、Unzoom 复原。

输出示例

try_tracing_flame::main; ...::handle_request; request_start 74200
try_tracing_flame::main; ...::handle_request; ...::parse_request; parse_start 2030200
try_tracing_flame::main; ...::handle_request; ...::parse_request; parse_done 34100
try_tracing_flame::main; ...::handle_request; ...::load_user; ...::lookup_cache; cache_probe 1042900
try_tracing_flame::main; ...::handle_request; ...::load_user; cache_hit 42000
...

每条日志点后面的宽度是「到下一条日志点」的纳秒数,不是日志自身的耗时 (event 是瞬时的)。

栈帧过滤

src/main.rs 里的 CRATE_PREFIX:

const CRATE_PREFIX: &str = "try_tracing_flame";

Layer 只保留以它开头的栈帧,把 std / tracing / backtrace 等噪声滤掉。 真实项目里换成自己的 crate 名即可;要保留多个 crate,把 stack_of 里的 starts_with 改成前缀列表。

另外还会清理:

  • demangle 结果里的 crate hash(foo[fd3cd...]::bar -> foo::bar);
  • event! 宏展开产生的 func::{closure#N} 层;
  • 相邻重复帧(内联/递归)。

代码导览

位置 作用
log_point! 发一个 target = "flame" 的日志点 event
EventFlameLayer::on_event 记时间戳、抓未解析 backtrace、取日志点名
FlushGuard::drop 解析符号,按时间顺序写 folded
stack_of backtrace -> 由外到内的应用栈帧 + 日志点叶子
flamegraph.sh chart 模式先 tac 再 --flamechart;graph 模式直接聚合

关键点与限制

  1. 日志点名要稳定:用 event!(name: "...");变量值放到字段里,不要拼进名字。
  2. inferno 的 --flamechart 会反转输入行,所以脚本先用 tac 倒序, 时间才会从左到右。
  3. 时间宽度是到下一条日志点:相邻且路径完全相同的日志点会合并成一块, 这是 flame chart 的语义。
  4. 只能看到日志点当时的栈:如果两个日志点之间调用了更深层的函数又返回, 这段耗时仍记在「前一个日志点的栈」上。要看到更深的路径,就在那里再加日志点 (示例里的 cache_probe / db_query_start 就是为此加的)。
  5. 抓栈有成本:new_unresolved() 只走栈,开销小;符号解析延迟到程序结束, 但日志点很多时仍会明显拖慢。生产环境建议采样、限制帧数,或按需开启。
  6. 符号可见性:示例用 debug 构建,函数不会被内联,栈帧完整。release 构建 可能内联掉函数;需要保留调试符号(例如 [profile.release] debug = true), 并接受内联合并。
  7. 多线程:Instant 是进程级单调时钟,事件按时间戳排序;每个事件的栈来自 它所在线程。
  8. 如果你要的是离散的零宽度标记而不是时间片,应该用 Chrome Trace / Perfetto,而不是 flame chart。

为什么不是 #[instrument]

#[instrument] 只是在函数体外包一个 span(一次 enter + 一次 exit),记录的是 你声明过的函数,不是运行时真实调用栈;手写 info_span! 同理。要拿到调用栈, 必须在日志点做 backtrace。