AlinsRan commented on code in PR #2115: URL: https://github.com/apache/apisix-website/pull/2115#discussion_r3879714196
########## blog/zh/blog/2026/08/28/debugging-apisix-throughput-regression.md: ########## @@ -0,0 +1,234 @@ +--- +title: "火焰图没撒谎，但没直接告诉我们瓶颈：一次 APISIX 吞吐回退定位" +authors: + - name: "Xin Rong" + title: "Author" + url: "https://github.com/AlinsRan"; + image_url: "https://github.com/AlinsRan.png"; + - name: "Yilia Lin" + title: "Technical Writer" + url: "https://github.com/Yilialinn"; + image_url: "https://github.com/Yilialinn.png"; +keywords: + - Apache APISIX + - 火焰图 + - LuaJIT + - 性能优化 + - 吞吐回退 +description: "火焰图没有撒谎，却也没有直接指出 APISIX 吞吐回退的瓶颈。本文沿 CPU、调用栈和 LuaJIT 证据链逐步排查，并通过每请求调用次数和配对 A/B 实验，解释为什么最宽的热点未必最值得优化。" +tags: [Ecosystem] +--- + +火焰图没有撒谎，却也没有直接指出 APISIX 吞吐回退的瓶颈。本文沿 CPU、调用栈和 LuaJIT 证据链逐步排查，并通过每请求调用次数和配对 A/B 实验，解释为什么最宽的热点未必最值得优化。 + +<!--truncate--> + +一次吞吐回退中，火焰图最宽的路径并不是最终瓶颈。真正值得追查的两个位置，在 Lua 采样里只有 3.0% 和 3.9%。如果按热点排序，它们根本进不了第一轮优化名单。 + +这次排查最有价值的不是某个补丁，而是一条证据链：先确认 CPU 确实是瓶颈；再横向看火焰图宽度，建立候选；然后沿调用栈纵向追，看重复调用和公共路径如何放大成本；当火焰图解释不了端到端差距时，继续查 LuaJIT 编译与中断事件；最后用每请求调用次数和配对 A/B 实验定量。 + +> 数据范围：下文数据来自同一受控环境中的一个 APISIX 内部定制构建，其中加载了 100 余个插件。吞吐统一归一化，只用于说明定位方法与因果链，不代表 Apache APISIX OSS 在其他硬件、配置或负载下的通用表现。 + +## 1. 先确认 CPU 瓶颈，而不是上来就看火焰图 + +火焰图显示的是采样期间 CPU 在执行什么。只有目标 worker 的 CPU 接近饱和、吞吐受这个核限制时，火焰图的宽度才有资格解释性能回退。 + +我们在采样前固定了这些条件： + +- APISIX 单 worker 并绑定独占物理核； +- 上游服务和压测端使用其他核，避免 CPU 争抢； +- 请求模型、配置、响应内容保持一致； +- 吞吐回退可稳定复现，错误率和响应结果没有偏移； +- 目标 worker 持续接近饱和，上游、网络、压测端仍有余量。 + +如果不满足这些前提，首先应该查连接、网络、上游或压测端，而不是在 on-CPU 火焰图里找答案。 + +## 2. 横向看宽度，而不是排名 + +我们使用 eBPF 以 500 Hz 同时采集 C 和 Lua 调用栈。下面是排查中的真实 Lua on-CPU 火焰图。 + + + +*搜索 `run_global_rules` 后命中 3 处，但这些位置在整张图里并不醒目。原始采样共 2,446 个样本；截图已移除进程 PID。* + +横向看火焰图，看的是宽度，不是 x 轴顺序。宽度越大，采样落在该路径上的次数越多。初步候选位置按 Lua self time 排序： + +| 候选位置 | Lua self time | 初判 | +|---|---:|---| +| Prometheus exporter | 25.9% | 最值得先看 | +| `ctx.var` 元方法 | 15.1% | 第二候选 | +| 自定义日志旁路 | 3.9% | 很容易被忽略 | +| `run_global_rules` | 3.0% | 很容易被忽略 | + +这里的 self time 指：在带 Lua 上下文的样本中，直接落在这个位置上的比例，不是总 CPU 占比。本次采样约 19.6% 的样本缺失 Lua 上下文，所以这些百分比只用于选候选，不能直接预测吞吐收益。 + +这个排名有四个盲区： + +1. LuaJIT 解释执行时，不同的 Lua 代码可能折叠到共享的 `lj_BC_*`、`lj_vm_*` 符号里。 +2. 已编译的 JIT trace 不一定能被常规栈回溯完整展开，因此可观察到的 JIT 样本只是下界。 +3. 表查找、内存分配、GC 等成本会记在 C 符号上，而不是触发的 Lua 行上。 +4. 一个调用可能改变调用方的 JIT 状态，使成本看起来落在调用方函数的头上。 + +`run_global_rules` 还有一个特征：它没有形成一根大柱子，而是散在多个请求阶段的调用栈里。单处不宽，不等于合起来不贵。 + +## 3. 纵向沿栈看，3% 如何被公共路径放大 + +选中某个 `run_global_rules` 方块后，纵向看调用栈：底部是请求阶段入口，向上经过 `common_phase`、Global Rule 插件筛选、调度，再到具体插件执行。 + + + +*所选栈会被重新铺满画布，因此图中的宽度已经归一化，不能再当作它占总 CPU 的比例。* + +纵向高度本身不代表耗时。它的作用是看清成本从哪里进入、被谁调用、为什么反复出现。 + +修复前，`run_global_rules()` 会在请求的多个阶段调用 `_M.filter()`。`_M.filter()` 遍历所有已加载插件，再逐个判断该插件是否被 Global Rule 配置： + +```lua +-- 简化示意，非 APISIX 完整实现 +for _, plugin_obj in ipairs(local_plugins) do + local name = plugin_obj.name + local plugin_conf = user_plugin_conf[name] + if type(plugin_conf) ~= "table" then + goto continue + end + -- 处理已配置插件 + ::continue:: +end +``` + +两个放大器都在这里： + +1. 单次过滤成本随已加载插件数量的增长。 +2. 相同过滤结果跨请求阶段重复生成；`body_filter` 与 `delayed_body_filter` 还可能按响应块多次进入。 + +本次测试配置中，一个请求实际触发了 **9 次过滤**。也就是说，“从 100+ 插件中找出已配置的少量插件”这件事，被同一个请求重复了 9 次。 + +这解释了为什么 Lua 层 3.0% 会低估整条路径成本： + +| 实际工作 | 火焰图常见归属 | +|---|---| +| 循环本身 | `plugin.lua` 对应位置 | +| 大量表查找 | `lj_BC_TGETS` | +| 临时表分配 | `lj_alloc_malloc` | +| 临时对象回收 | `gc_sweep` | +| 未编译解释器派发 | `lj_vm_*` / `lj_BC_*` | + +横向看，它只是 3% 的候选；纵向看，才会发现它位于一条被反复进入的公共路径。优化方向也很直接：同一请求内，如果 Global Rule 和匹配路由没有变化，就复用已筛选的插件集合，而不是每个阶段重新生成。 + +## 4. 火焰图解释不了差距时，查 LuaJIT 编译事件 + +第二条路径来自自定义观测组件。它和日志旁路不属于 APISIX OSS，但揭示的问题对 APISIX 插件和 OpenResty 扩展有参考价值：一次看似很轻的调用，既可能产生直接成本，也可能改变调用方之后以解释器还是机器码运行。 + +### 4.1 解释器派发异常活跃 + +把 C 层样本按运行时类型重新分类，最值得注意的不是某行 Lua，而是解释器与 JIT 的关系： + +| 运行类别 | 每请求 CPU 时间 | 占本次样本 | +|---|---:|---:| +| 解释器派发：`lj_BC_*` / `lj_vm_*` | 5.86 μs | 29.6% | +| 可观察到的 JIT trace 执行 | 2.55 μs | 12.9% | + +JIT trace 难以完整 unwind，12.9% 只能看作下界。但在同一环境中，解释器派发如此活跃，已经构成强信号：某些高频路径可能没有稳定地跑在机器码里。 + +这不等于 trace 越多越好。初始化代码不需要追求编译，不同 trace 的成本差异也很大。只有在 CPU 饱和、路径高频、解释器派发异常时，编译结果才值得深挖。 + +### 4.2 `jit.v` 发出警报，也制造了第一次误判 + +开启 `jit.v` 后，一次短时压测输出中看到 417 次 trace 编译成功、493 次 abort。按位置聚合后，一批路径的 abort 次数整齐停在 11。 + +但这是编译事件数，不是唯一函数数、覆盖率或 CPU 时间。`jit.v` 有几个边界： + +- abort 行显示的是 trace 中断位置，而惩罚记在 trace 起点，两者可能不是同一行。 +- 某函数从未成为 trace 起点，不代表它没有被编译，函数体可能已被内联进父 trace。 +- 文本日志很难对功能开启/关闭两组结果做稳定的集合差。 + +我们一开始也把“起点出现次数为 0”误读成“整个函数都在解释执行”。后来用 `jit.dump` 字节码模式复核，才发现多个函数入口没有成为 root trace，但函数体已多次进入其他 trace。真正反复失败的是阶段入口和编排函数。 + +> 看不到 trace 起点，只能证明这里没有成为 root trace 锚点；不能证明整个函数没有进入机器码。 + +### 4.3 把 `start`、`stop`、`abort` 归回同一起点 + +要回答“哪段代码没有编译、为什么”，需要让 LuaJIT 自己交事件流。核心做法是按 trace id 保存 `start` 的位置，再把后续 `stop` 或 `abort` 归回同一个起点： + +```lua +-- 简化示意，实际回调参数和解析逻辑更复杂 +local trace_start = {} + +jit.attach(function(what, trace_id, func, pc, err_code) + if what == "start" then + trace_start[trace_id] = locate(func, pc) + elseif what == "stop" then + record_compiled(trace_start[trace_id]) + trace_start[trace_id] = nil + elseif what == "abort" then + record_abort(trace_start[trace_id], err_code) + trace_start[trace_id] = nil + end +end, "trace") +``` + +实际探针还要用 `jit.util.funcinfo` 解析源位置，用 `jit.vmdef.traceerr` 还原 abort 原因。这样就能比较开启/关闭自定义组件时：哪些起点进入 compiled 集合，哪些反复 abort，以及是否发生 trace flush。 + +在本次 LuaJIT 构建中，失败惩罚从 72 开始逐次翻倍：第 10 次是 36,864，第 11 次达到 73,728，超过 60,000 上限。多个起点恰好 abort ×11 后不再增长；它们没有进入 compiled 集合，采集期间也没有 trace flush。两组存活 trace 数均低于缓存上限，因此排除了 trace 缓存被挤爆的可能。这些证据共同说明：对应的 trace 起点已被放弃继续编译。 + +仍然不能扩大结论：被放弃的是 trace 起点，不一定是整个函数体；其他部分仍可能被内联进别的 trace。 + +按调用来源聚合后，受影响的阶段入口和编排函数都经过同一条自定义日志旁路：日志级别不足时虽不输出，但仍会检查请求阶段、调用栈和请求上下文。新增调用本身没有形成大柱子，却改变了调用方的 JIT 结果，使部分成本看起来落在正常请求函数头上。 Review Comment: Long clause chains joined by semicolons read as translated spec text. Split into sentences; no data or conclusion changed. ````suggestion 真正的探针还要用 `jit.util.funcinfo` 解析源码位置，用 `jit.vmdef.traceerr` 还原 abort 的原因。有了这份数据，才能把组件开和关两种状态摆在一起比：哪些起点进了 compiled 集合，哪些在反复 abort，中间有没有发生 trace flush。 我们用的这个 LuaJIT 构建里，失败惩罚从 72 开始，每失败一次翻一倍：第 10 次是 36,864，第 11 次到 73,728，越过了 60,000 的上限。那批起点恰好都停在 abort ×11，之后再没进过 compiled 集合，采集期间也没有 trace flush，两组的存活 trace 数都在缓存上限以下，trace 缓存被挤爆这个可能性也排除了。几条凑在一起，结论就比较清楚：LuaJIT 放弃了这些 trace 起点。 但结论到此为止：被放弃的是 trace 起点，不一定是整个函数体，函数的其他部分照样可能被内联进别的 trace。 按调用来源再聚合一次，受影响的阶段入口和编排函数全都经过同一条自定义日志旁路。这条路径在日志级别不够、根本不会输出的时候，依然要去检查请求阶段、调用栈和请求上下文。它自己没在图上留下一根像样的柱子，却把调用方的 JIT 结果改掉了，于是一部分开销看起来落在了正常请求函数的头上。 ```` ########## blog/zh/blog/2026/08/28/debugging-apisix-throughput-regression.md: ########## @@ -0,0 +1,234 @@ +--- +title: "火焰图没撒谎，但没直接告诉我们瓶颈：一次 APISIX 吞吐回退定位" +authors: + - name: "Xin Rong" + title: "Author" + url: "https://github.com/AlinsRan"; + image_url: "https://github.com/AlinsRan.png"; + - name: "Yilia Lin" + title: "Technical Writer" + url: "https://github.com/Yilialinn"; + image_url: "https://github.com/Yilialinn.png"; +keywords: + - Apache APISIX + - 火焰图 + - LuaJIT + - 性能优化 + - 吞吐回退 +description: "火焰图没有撒谎，却也没有直接指出 APISIX 吞吐回退的瓶颈。本文沿 CPU、调用栈和 LuaJIT 证据链逐步排查，并通过每请求调用次数和配对 A/B 实验，解释为什么最宽的热点未必最值得优化。" +tags: [Ecosystem] +--- + +火焰图没有撒谎，却也没有直接指出 APISIX 吞吐回退的瓶颈。本文沿 CPU、调用栈和 LuaJIT 证据链逐步排查，并通过每请求调用次数和配对 A/B 实验，解释为什么最宽的热点未必最值得优化。 + +<!--truncate--> + +一次吞吐回退中，火焰图最宽的路径并不是最终瓶颈。真正值得追查的两个位置，在 Lua 采样里只有 3.0% 和 3.9%。如果按热点排序，它们根本进不了第一轮优化名单。 + +这次排查最有价值的不是某个补丁，而是一条证据链：先确认 CPU 确实是瓶颈；再横向看火焰图宽度，建立候选；然后沿调用栈纵向追，看重复调用和公共路径如何放大成本；当火焰图解释不了端到端差距时，继续查 LuaJIT 编译与中断事件；最后用每请求调用次数和配对 A/B 实验定量。 + +> 数据范围：下文数据来自同一受控环境中的一个 APISIX 内部定制构建，其中加载了 100 余个插件。吞吐统一归一化，只用于说明定位方法与因果链，不代表 Apache APISIX OSS 在其他硬件、配置或负载下的通用表现。 + +## 1. 先确认 CPU 瓶颈，而不是上来就看火焰图 + +火焰图显示的是采样期间 CPU 在执行什么。只有目标 worker 的 CPU 接近饱和、吞吐受这个核限制时，火焰图的宽度才有资格解释性能回退。 + +我们在采样前固定了这些条件： + +- APISIX 单 worker 并绑定独占物理核； +- 上游服务和压测端使用其他核，避免 CPU 争抢； +- 请求模型、配置、响应内容保持一致； +- 吞吐回退可稳定复现，错误率和响应结果没有偏移； +- 目标 worker 持续接近饱和，上游、网络、压测端仍有余量。 + +如果不满足这些前提，首先应该查连接、网络、上游或压测端，而不是在 on-CPU 火焰图里找答案。 + +## 2. 横向看宽度，而不是排名 + +我们使用 eBPF 以 500 Hz 同时采集 C 和 Lua 调用栈。下面是排查中的真实 Lua on-CPU 火焰图。 + + + +*搜索 `run_global_rules` 后命中 3 处，但这些位置在整张图里并不醒目。原始采样共 2,446 个样本；截图已移除进程 PID。* + +横向看火焰图，看的是宽度，不是 x 轴顺序。宽度越大，采样落在该路径上的次数越多。初步候选位置按 Lua self time 排序： + +| 候选位置 | Lua self time | 初判 | +|---|---:|---| +| Prometheus exporter | 25.9% | 最值得先看 | +| `ctx.var` 元方法 | 15.1% | 第二候选 | +| 自定义日志旁路 | 3.9% | 很容易被忽略 | +| `run_global_rules` | 3.0% | 很容易被忽略 | + +这里的 self time 指：在带 Lua 上下文的样本中，直接落在这个位置上的比例，不是总 CPU 占比。本次采样约 19.6% 的样本缺失 Lua 上下文，所以这些百分比只用于选候选，不能直接预测吞吐收益。 + +这个排名有四个盲区： + +1. LuaJIT 解释执行时，不同的 Lua 代码可能折叠到共享的 `lj_BC_*`、`lj_vm_*` 符号里。 +2. 已编译的 JIT trace 不一定能被常规栈回溯完整展开，因此可观察到的 JIT 样本只是下界。 +3. 表查找、内存分配、GC 等成本会记在 C 符号上，而不是触发的 Lua 行上。 +4. 一个调用可能改变调用方的 JIT 状态，使成本看起来落在调用方函数的头上。 + +`run_global_rules` 还有一个特征：它没有形成一根大柱子，而是散在多个请求阶段的调用栈里。单处不宽，不等于合起来不贵。 + +## 3. 纵向沿栈看，3% 如何被公共路径放大 + +选中某个 `run_global_rules` 方块后，纵向看调用栈：底部是请求阶段入口，向上经过 `common_phase`、Global Rule 插件筛选、调度，再到具体插件执行。 + + + +*所选栈会被重新铺满画布，因此图中的宽度已经归一化，不能再当作它占总 CPU 的比例。* + +纵向高度本身不代表耗时。它的作用是看清成本从哪里进入、被谁调用、为什么反复出现。 + +修复前，`run_global_rules()` 会在请求的多个阶段调用 `_M.filter()`。`_M.filter()` 遍历所有已加载插件，再逐个判断该插件是否被 Global Rule 配置： + +```lua +-- 简化示意，非 APISIX 完整实现 +for _, plugin_obj in ipairs(local_plugins) do + local name = plugin_obj.name + local plugin_conf = user_plugin_conf[name] + if type(plugin_conf) ~= "table" then + goto continue + end + -- 处理已配置插件 + ::continue:: +end +``` + +两个放大器都在这里： + +1. 单次过滤成本随已加载插件数量的增长。 +2. 相同过滤结果跨请求阶段重复生成；`body_filter` 与 `delayed_body_filter` 还可能按响应块多次进入。 + +本次测试配置中，一个请求实际触发了 **9 次过滤**。也就是说，“从 100+ 插件中找出已配置的少量插件”这件事，被同一个请求重复了 9 次。 + +这解释了为什么 Lua 层 3.0% 会低估整条路径成本： + +| 实际工作 | 火焰图常见归属 | +|---|---| +| 循环本身 | `plugin.lua` 对应位置 | +| 大量表查找 | `lj_BC_TGETS` | +| 临时表分配 | `lj_alloc_malloc` | +| 临时对象回收 | `gc_sweep` | +| 未编译解释器派发 | `lj_vm_*` / `lj_BC_*` | + +横向看，它只是 3% 的候选；纵向看，才会发现它位于一条被反复进入的公共路径。优化方向也很直接：同一请求内，如果 Global Rule 和匹配路由没有变化，就复用已筛选的插件集合，而不是每个阶段重新生成。 + +## 4. 火焰图解释不了差距时，查 LuaJIT 编译事件 + +第二条路径来自自定义观测组件。它和日志旁路不属于 APISIX OSS，但揭示的问题对 APISIX 插件和 OpenResty 扩展有参考价值：一次看似很轻的调用，既可能产生直接成本，也可能改变调用方之后以解释器还是机器码运行。 + +### 4.1 解释器派发异常活跃 + +把 C 层样本按运行时类型重新分类，最值得注意的不是某行 Lua，而是解释器与 JIT 的关系： + +| 运行类别 | 每请求 CPU 时间 | 占本次样本 | +|---|---:|---:| +| 解释器派发：`lj_BC_*` / `lj_vm_*` | 5.86 μs | 29.6% | +| 可观察到的 JIT trace 执行 | 2.55 μs | 12.9% | + +JIT trace 难以完整 unwind，12.9% 只能看作下界。但在同一环境中，解释器派发如此活跃，已经构成强信号：某些高频路径可能没有稳定地跑在机器码里。 + +这不等于 trace 越多越好。初始化代码不需要追求编译，不同 trace 的成本差异也很大。只有在 CPU 饱和、路径高频、解释器派发异常时，编译结果才值得深挖。 + +### 4.2 `jit.v` 发出警报，也制造了第一次误判 + +开启 `jit.v` 后，一次短时压测输出中看到 417 次 trace 编译成功、493 次 abort。按位置聚合后，一批路径的 abort 次数整齐停在 11。 + +但这是编译事件数，不是唯一函数数、覆盖率或 CPU 时间。`jit.v` 有几个边界： + +- abort 行显示的是 trace 中断位置，而惩罚记在 trace 起点，两者可能不是同一行。 +- 某函数从未成为 trace 起点，不代表它没有被编译，函数体可能已被内联进父 trace。 +- 文本日志很难对功能开启/关闭两组结果做稳定的集合差。 + +我们一开始也把“起点出现次数为 0”误读成“整个函数都在解释执行”。后来用 `jit.dump` 字节码模式复核，才发现多个函数入口没有成为 root trace，但函数体已多次进入其他 trace。真正反复失败的是阶段入口和编排函数。 + +> 看不到 trace 起点，只能证明这里没有成为 root trace 锚点；不能证明整个函数没有进入机器码。 + +### 4.3 把 `start`、`stop`、`abort` 归回同一起点 + +要回答“哪段代码没有编译、为什么”，需要让 LuaJIT 自己交事件流。核心做法是按 trace id 保存 `start` 的位置，再把后续 `stop` 或 `abort` 归回同一个起点： Review Comment: De-jargoning only. Keeps the misdiagnosis in 4.2 — it is the most readable part of the article — but phrases it as something that happened rather than a lesson being delivered. ````suggestion JIT trace 的栈不一定能完整 unwind，12.9% 只能算下界。但在同一个环境里，解释器派发能占到这个量，本身就是个够强的信号：有些高频路径大概没稳定跑在机器码里。 这不是说 trace 越多越好。初始化的代码本来就不必追求编译，不同 trace 之间的开销差别也很大。只有在 CPU 已经饱和、路径确实高频、解释器派发又反常的时候，编译结果才值得往下挖。 ### 4.2 `jit.v` 报了警，也把我们带沟里过一次 打开 `jit.v` 跑一轮短压测，输出里有 417 次 trace 编译成功、493 次 abort。按位置聚合之后，一批路径的 abort 次数整整齐齐停在 11。 但这些是编译事件的次数，不是函数个数，也不是覆盖率或者 CPU 时间。`jit.v` 本身还有几个边界： - abort 行显示的是 trace 中断的位置，而惩罚记在 trace 起点上，两者可能不是同一行。 - 某个函数从没当过 trace 起点，不代表它没被编译，函数体可能已经内联进父 trace 了。 - 文本日志很难对功能开和关两组结果做稳定的集合差。 我们一开始就把“起点出现次数为 0”读成了“整个函数都在解释执行”。后来用 `jit.dump` 的字节码模式复核才发现不是这么回事：好几个函数入口确实没成为 root trace，但函数体已经多次进过别的 trace。真正在反复失败的是阶段入口和编排函数。 > 看不到 trace 起点，只能说明这里没当上 root trace 的锚点，不能说明整个函数没进过机器码。 ### 4.3 把 `start`、`stop`、`abort` 归回同一个起点 想知道到底哪段代码没编译成、为什么没编译成，得让 LuaJIT 自己把事件流交出来。思路不复杂：按 trace id 把 `start` 的位置记下来，后面的 `stop` 或 `abort` 再归回这个起点。 ```` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
![https://github.com/AlinsRan.png"](https://github.com/AlinsRan.png"){kind=link}
![https://github.com/Yilialinn.png"](https://github.com/Yilialinn.png"){kind=link}
