首页
/ Apache APISIX 中 limit-count 插件与自定义错误处理的实践

Apache APISIX 中 limit-count 插件与自定义错误处理的实践

2025-05-15 04:19:57作者:伍希望

问题背景

在 Apache APISIX 的实际使用中,我们发现当 limit-count 插件触发请求限制并返回 429 状态码时,这些响应状态码并没有被正确地记录到监控指标中。这个问题最初被误认为是 APISIX 的 bug,但经过深入分析后发现其实是与自定义错误页面处理机制有关。

问题分析

当 limit-count 插件拒绝请求时,APISIX 确实会生成 429 状态码,并记录如下警告日志:

2025/02/25 08:16:10 [warn] 49#49: *42708330 [lua] plugin.lua:1153: run_plugin(): limit-count exits with http status code 429

然而,这些 429 响应却没有出现在 Prometheus 或 Datadog 的监控指标中。经过排查发现,这是因为在 Nginx 配置中自定义了 error_page 处理机制:

error_page 400...429... @error;
location @error {
  default_type 'text/html';
  echo '<html><head><title>$status $status_text</title></head><body><center><h1>$status $status_text</h1></center></html>';
}

这种配置会导致所有错误响应(包括 429)被重定向到自定义错误处理位置 @error,从而绕过了 APISIX 的指标收集机制。

解决方案

为了解决这个问题,我们开发了一个自定义插件来正确处理错误响应,同时保持监控指标的完整性。以下是插件的主要实现思路:

  1. 插件优先级:设置为 10,确保在大多数插件之后执行
  2. 匹配条件:专门针对 429 状态码进行处理
  3. 响应处理
    • 在 header_filter 阶段清除可能被修改的响应头
    • 在 body_filter 阶段重写响应体内容
local core = require("apisix.core")
local schema = {
  type = "object",
  properties = {},
  required = {},
}

local _M = {
  version = 0.1,
  priority = 10,
  name = "custom-error-handler",
  schema = schema,
}

function _M.check_schema(conf)
  return core.schema.check(schema, conf)
end

local function is_match()
  return ngx.status == 429
end

function _M.header_filter(conf, ctx)
  if is_match() then
    core.response.clear_header_as_body_modified()
  end
end

function _M.body_filter(conf, ctx)
  if is_match() then
    local body = core.response.hold_body_chunk(ctx)
    if not body then
      return
    end
    ngx.arg[1] = "<html><head><title>" .. ngx.status .. " " .. ngx.var.status_text .. "</title></head><body><center><h1>" .. ngx.status .. " " .. ngx.var.status_text ..  "</h1></center></html>\n"
  end
end

return _M

实现要点

  1. 状态码保持:插件处理过程中不会改变原始状态码,确保监控系统能正确记录
  2. 响应体重写:在保持状态码的同时,自定义了错误页面的内容
  3. 性能考虑:仅对特定状态码进行处理,避免不必要的开销

扩展思考

这个解决方案虽然解决了 429 状态码的监控问题,但还有进一步优化的空间:

  1. 通用错误处理:可以扩展插件以处理更多类型的错误状态码
  2. 动态配置:通过插件配置决定哪些状态码需要特殊处理
  3. 内容模板化:支持从配置文件加载错误页面模板
  4. 区分错误来源:识别是 APISIX 生成的错误还是上游服务返回的错误

最佳实践建议

  1. 在使用自定义错误页面时,务必考虑对监控系统的影响
  2. 对于关键状态码(如 429)建议保留原始响应头信息
  3. 自定义插件的优先级需要根据实际需求仔细设置
  4. 在生产环境部署前,充分测试插件的各种边界情况

通过这种自定义插件的方式,我们既保持了友好的错误页面展示,又确保了监控系统的完整性,是 APISIX 灵活插件体系的一个典型应用案例。

登录后查看全文
热门项目推荐
相关项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
156
1.99 K
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
942
555
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
405
387
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Python
75
70
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
992
395
ops-mathops-math
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
515
45
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
345
1.32 K
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
194
279