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

2025-05-15 13:57:05作者：段琳惟

Apisix是一个基于Nginx的API网关，主要用于微服务架构中的API管理和服务发现。它的特点是高性能、轻量级、易于配置等。适用于API管理和负载均衡场景。

项目地址：https://gitcode.com/gh_mirrors/api/apisix

问题背景

在 Apache APISIX 网关的实际使用中，开发者发现当 limit-count 插件触发限流并返回 429 状态码时，这些响应状态码并未被正确记录到监控指标中。这导致监控系统无法准确反映实际的限流情况，给系统运维和性能分析带来了困扰。

问题分析

经过深入排查，发现问题并非出在 APISIX 本身，而是由于自定义的错误页面处理配置覆盖了默认行为。在 Nginx 配置中，开发者设置了 error_page 指令将所有错误状态码（包括 429）重定向到一个自定义的错误处理位置 @error，这导致：

原始响应状态码被"隐藏"
监控插件无法捕获真实的限流响应
虽然日志中仍能看到限流警告，但指标数据不完整

解决方案

方案一：调整错误页面配置

最简单的解决方案是修改 Nginx 配置，不对 429 状态码进行错误页面重定向：

error_page 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 421 422 423 424 425 426 428 431 451 500 501 502 503 504 505 506 507 508 510 511 @error;

注意这里从列表中移除了 429 状态码，这样限流响应将保持原始状态，可以被监控插件正确捕获。

方案二：开发自定义插件

对于需要更精细控制错误响应的场景，可以开发一个自定义插件。以下是一个处理 429 响应的插件示例：

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_limit_reached()
  return ngx.status == 429
end

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

function _M.body_filter(conf, ctx)
  if is_limit_reached() 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 状态码
清除可能被修改的响应头
生成自定义的错误响应体
保持原始状态码不变，确保监控系统能正确记录

最佳实践建议

监控完整性：确保监控系统能捕获所有重要的 HTTP 状态码，特别是 4xx 和 5xx 系列
错误处理策略：根据业务需求设计合理的错误处理策略，平衡用户体验和系统可观测性
插件开发：当标准功能无法满足需求时，考虑开发自定义插件，但要注意插件优先级和执行顺序
测试验证：任何配置变更后，都应通过实际请求验证监控数据是否如预期收集

总结

在 APISIX 网关中正确处理限流响应和错误状态码是保证系统可观测性的重要环节。通过合理配置或开发自定义插件，开发者可以确保监控系统获得完整准确的数据，为系统运维和性能优化提供可靠依据。本文提供的两种解决方案各有适用场景，开发者应根据实际需求选择最合适的实现方式。

Apisix是一个基于Nginx的API网关，主要用于微服务架构中的API管理和服务发现。它的特点是高性能、轻量级、易于配置等。适用于API管理和负载均衡场景。

项目地址：https://gitcode.com/gh_mirrors/api/apisix

登录后查看全文

热门内容推荐

1 freeCodeCamp猫照片应用教程中的HTML注释测试问题分析 2 freeCodeCamp课程视频测验中的Tab键导航问题解析 3 freeCodeCamp论坛排行榜项目中的错误日志规范要求 4 freeCodeCamp全栈开发课程中React组件导出方式的衔接问题分析 5 freeCodeCamp音乐播放器项目中的函数调用问题解析 6 freeCodeCamp JavaScript高阶函数中的对象引用陷阱解析 7 freeCodeCamp全栈开发课程中React实验项目的分类修正 8 freeCodeCamp英语课程视频测验选项与提示不匹配问题分析 9 freeCodeCamp课程页面空白问题的技术分析与解决方案 10 freeCodeCamp博客页面工作坊中的断言方法优化建议

最新内容推荐

项目优选

收起

deepin linux kernel

OpenHarmony documentation | OpenHarmony开发者文档

Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台，包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分，采用java语言实现，可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用

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

HarmonyOS-Examples

本仓将收集和展示仓颉鸿蒙应用示例代码，欢迎大家投稿，在仓颉鸿蒙社区展现你的妙趣设计！

金融AI编程实战

为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制，新手友好，让学生以亲身实践开源开发的方式，学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线，涉及 Bash、Python、SQL、BI、AI 等全技术栈，培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。

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

本项目是CANN提供的数学类基础计算算子库，实现网络在NPU上加速计算。

Cangjie-Examples

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

ohos_react_native

React Native鸿蒙化仓库