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

2025-05-15 15:51:47作者：段琳惟

问题背景

在 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