Apache APISIX 中 limit-count 插件与自定义错误处理的实践
2025-05-15 19:41:47作者:伍希望
问题背景
在 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 的指标收集机制。
解决方案
为了解决这个问题,我们开发了一个自定义插件来正确处理错误响应,同时保持监控指标的完整性。以下是插件的主要实现思路:
- 插件优先级:设置为 10,确保在大多数插件之后执行
- 匹配条件:专门针对 429 状态码进行处理
- 响应处理:
- 在 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
实现要点
- 状态码保持:插件处理过程中不会改变原始状态码,确保监控系统能正确记录
- 响应体重写:在保持状态码的同时,自定义了错误页面的内容
- 性能考虑:仅对特定状态码进行处理,避免不必要的开销
扩展思考
这个解决方案虽然解决了 429 状态码的监控问题,但还有进一步优化的空间:
- 通用错误处理:可以扩展插件以处理更多类型的错误状态码
- 动态配置:通过插件配置决定哪些状态码需要特殊处理
- 内容模板化:支持从配置文件加载错误页面模板
- 区分错误来源:识别是 APISIX 生成的错误还是上游服务返回的错误
最佳实践建议
- 在使用自定义错误页面时,务必考虑对监控系统的影响
- 对于关键状态码(如 429)建议保留原始响应头信息
- 自定义插件的优先级需要根据实际需求仔细设置
- 在生产环境部署前,充分测试插件的各种边界情况
通过这种自定义插件的方式,我们既保持了友好的错误页面展示,又确保了监控系统的完整性,是 APISIX 灵活插件体系的一个典型应用案例。
登录后查看全文
热门项目推荐
相关项目推荐
- DDeepSeek-V3.1-BaseDeepSeek-V3.1 是一款支持思考模式与非思考模式的混合模型Python00
- QQwen-Image-Edit基于200亿参数Qwen-Image构建,Qwen-Image-Edit实现精准文本渲染与图像编辑,融合语义与外观控制能力Jinja00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~054CommonUtilLibrary
快速开发工具类收集,史上最全的开发工具类,欢迎Follow、Fork、StarJava04GitCode百大开源项目
GitCode百大计划旨在表彰GitCode平台上积极推动项目社区化,拥有广泛影响力的G-Star项目,入选项目不仅代表了GitCode开源生态的蓬勃发展,也反映了当下开源行业的发展趋势。07GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00openHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!C0378- WWan2.2-S2V-14B【Wan2.2 全新发布|更强画质,更快生成】新一代视频生成模型 Wan2.2,创新采用MoE架构,实现电影级美学与复杂运动控制,支持720P高清文本/图像生成视频,消费级显卡即可流畅运行,性能达业界领先水平Python00
- GGLM-4.5-AirGLM-4.5 系列模型是专为智能体设计的基础模型。GLM-4.5拥有 3550 亿总参数量,其中 320 亿活跃参数;GLM-4.5-Air采用更紧凑的设计,拥有 1060 亿总参数量,其中 120 亿活跃参数。GLM-4.5模型统一了推理、编码和智能体能力,以满足智能体应用的复杂需求Jinja00
Yi-Coder
Yi Coder 编程模型,小而强大的编程助手HTML013
热门内容推荐
最新内容推荐
项目优选
收起

React Native鸿蒙化仓库
C++
179
263

🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
869
514

openGauss kernel ~ openGauss is an open source relational database management system
C++
130
183

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
328
377

本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
333
1.09 K

harmony-utils 一款功能丰富且极易上手的HarmonyOS工具库,借助众多实用工具类,致力于助力开发者迅速构建鸿蒙应用。其封装的工具涵盖了APP、设备、屏幕、授权、通知、线程间通信、弹框、吐司、生物认证、用户首选项、拍照、相册、扫码、文件、日志,异常捕获、字符、字符串、数字、集合、日期、随机、base64、加密、解密、JSON等一系列的功能和操作,能够满足各种不同的开发需求。
ArkTS
28
0

为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.08 K
0

deepin linux kernel
C
22
5

微信开发 Java SDK,支持微信支付、开放平台、公众号、视频号、企业微信、小程序等的后端开发,记得关注公众号及时接受版本更新信息,以及加入微信群进行深入讨论
Java
829
22

🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
601
58