502 网关无效 - TooBigHeaders

您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档。 信息

问题

客户端应用收到 HTTP 状态代码 502 Bad Gateway（错误代码为 protocol.http.TooBigHeaders ）作为 API 调用的响应。

错误消息

客户端应用会获得以下响应代码： 

HTTP/1.1 502 Bad Gateway

此外，您可能还会看到以下错误消息： 

{
   "fault":{
      "faultstring":"response headers size exceeding 25,600",
      "detail":{
         "errorcode":"protocol.http.TooBigHeaders"
      }
   }
}

可能的原因

如果目标/后端服务器作为 HTTP 响应的一部分发送到 Apigee Edge 的标头总大小超过 Apigee Edge 中允许的限制，就会发生此错误。

以下是导致此错误的可能原因：

原因 说明 适用的问题排查说明
响应中的标头大小超出允许的上限 作为发送给 Apigee Edge 的 HTTP 响应的一部分，特定标头的标头大小或目标/后端服务器发送的所有标头的标头大小总和超过 Apigee Edge 中允许的限制。 Edge 公有云和私有云用户

常见诊断步骤

使用以下工具/技巧之一来诊断此错误：

API 监控

要使用 API Monitoring 诊断错误，请执行以下操作：

  1. 以拥有 适当角色的用户身份 登录 Apigee Edge 界面。

  2. 切换到您要调查问题的组织。

  3. 前往 Analyze > API Monitoring > Investigate 页面。
  4. 选择您发现错误的具体时间范围。
  5. 您可以选择 Proxy（代理）过滤器以缩小错误代码的范围。
  6. 根据时间绘制故障代码。

  7. 选择具有错误代码 protocol.http.TooBigHeaders 的单元格，如下所示：

    （ 查看大图）

  8. 您将看到有关错误代码 protocol.http.TooBigHeaders 的信息，如下所示：

    （ 查看大图）

  9. 点击查看日志，然后展开失败请求所在的行。

    （ 查看大图）

  10. 在日志窗口中，请注意以下详细信息：
    • 状态代码：502
    • 错误来源：target
    • 错误代码：protocol.http.TooBigHeaders。
  11. 如果故障来源的值为 target 且故障代码的值为 protocol.http.TooBigHeaders，则表示来自目标/ 后端服务器的 HTTP 响应的标头大小大于 Apigee Edge 中允许的限制。

跟踪工具

  1. 启用跟踪会话，并执行以下任一操作：
    1. 等待 502 Bad Gateway 错误发生，或者
    2. 如果您可以重现问题，请进行 API 调用并重现 502 Bad Gateway 错误。
  2. 选择其中一个失败的请求并检查跟踪记录。
  3. 浏览跟踪记录的不同阶段，并找到发生故障的位置。

  4. 通常，您会在名为 Error 的流中看到此错误，位于 Request sent to target server 阶段之后，如下所示：

    （ 查看大图）

    记下跟踪记录中的错误值：

    • 错误：response headers size exceeding 25,600
    • error.class：com.apigee.errors.http.server.BadGateway

    这表示 Apigee Edge（消息处理器组件）会在从后端服务器收到响应后立即抛出错误，因为标头大小超出允许的上限。

  5. 您会在 Apigee Edge 发送的 Response Sent to Client 错误响应中看到失败，如下所示：

    （ 查看大图）

  6. 记下跟踪记录中的错误值。上面的轨迹示例展示了：
    • 错误： 502 Bad Gateway。
    • 错误内容： {"fault":{"faultstring":"response headers size exceeding 25,600","detail":{"errorcode":"protocol.http.TooBigHeaders"}}}

  7. 转到跟踪记录中的 AX（已记录的 Analytics 数据）阶段，然后点击该阶段以查看相关详情。

    （ 查看大图）

    请注意以下值：

    错误标头 值
    X-Apigee-fault-code protocol.http.TooBigHeaders
    X-Apigee-fault-source target
    错误内容：正文 {"fault":{"faultstring":"response headers size exceeding 25,600","detail":{"errorcode":"protocol.http.TooBigHeaders"}}}

NGINX

如需使用 NGINX 访问日志诊断错误，请执行以下操作：

  1. 如果您是 Private Cloud 用户，则可以使用 NGINX 访问日志来确定有关 HTTP 502 Bad Gateway 的关键信息。

  2. 检查 NGINX 访问日志：

    /opt/apigee/var/log/edge-router/nginx/ORG~ENV.PORT#_access_log

    其中：将 ORG、ENV 和 PORT# 替换为实际值。

  3. 搜索以查看在特定持续时间内是否存在任何错误代码为 protocol.http.TooBigHeaders 的 502 错误（如果问题是过去发生的），或者是否有任何请求仍然失败并显示 502。

  4. 如果您确实发现 X-Apigee-fault-code 与 X-Apigee-fault-code 的值匹配的任何 502 错误，则确定 X-Apigee-fault-code 的值。

    NGINX 访问日志中的 502 错误示例：

    NGINX 访问日志中的上述示例条目具有 X-Apigee-fault-code 和 X-Apigee-fault-code 的以下值：

    错误标头 值
    X-Apigee-fault-code protocol.http.TooBigHeaders
    X-Apigee-fault-source target

原因：响应中的标头大小超出允许的上限

诊断

  1. 按照常见诊断步骤中所述，确定使用 API 监控、跟踪工具或 NGINX 访问日志观察到的错误的错误代码、故障来源和响应载荷大小。
  2. 如果故障来源的值为 target，则表示目标/后端服务器发送到 Apigee 的响应中的标头大小大于 Apigee Edge 中允许的限制。
  3. 您可以使用以下方法之一来验证来自目标/后端的响应是否包含大小大于允许限制的标头：

    错误消息

    如需使用错误消息进行验证，请执行以下操作：

    如果您有权访问从 Apigee Edge 收到的完整错误消息，请参阅 faultstring。faultstring 表示响应标头大小超出了允许的限制。

    示例错误消息：

    "faultstring":"response headers size exceeding 25,600"

    在上述错误消息中，请注意 faultstring 响应的某些标头的总大小超过了允许的限制。

    实际请求

    如需使用实际请求进行验证，请执行以下操作：

    如果您有权访问向目标/后端服务器发出的实际请求，请执行以下步骤：

    1. 如果您是公有云/私有云用户，请从后端服务器本身或您获准向后端服务器发出请求的任何其他机器中直接向后端服务器发出请求。
    2. 如果您是 Private Cloud 用户，还可以从某个消息处理器向后端服务器发出请求。
    3. 检查从后端服务器收到的响应，专门计算并验证响应中传递的标头的总大小。

    4. 如果您发现响应载荷中的标头大小超过 Apigee Edge 中允许的限制，这就是问题的原因。

      来自目标服务器的响应示例：

      curl -v https://TARGET_SERVER_HOST/test

      * About to connect() to 10.1.0.10 port 9000 (#0)
*   Trying 10.1.0.10...
* Connected to 10.1.0.10 (10.1.0.10) port 9000 (#0)
> GET /test HTTP/1.1
> User-Agent: curl/7.29.0
> Host: 10.1.0.10:9000
> Accept: */*
<
< HTTP/1.1 200 OK
< Accept-Ranges: bytes
< Content-Length: 0
< Content-Type: text/plain; charset=utf-8
< Last-Modified: Tue, 20 Jul 2021 09:23:56 GMT
< Testheader1: XVlBzgba—-<snipped>---THctcuAx
< Testheader2: hxKQFDaFpLSj—-<snipped>---FbcXoEFfRsWxP
< Date: Fri, 23 Jul 2021 09:51:22 GMT
<
* Connection #0 to host 10.1.0.10 left intact

      在上面的示例中，Testheader1 和 Testheader2 的大小较高，这正是导致此错误的原因，因为它超出了 Apigee Edge 中的允许限制。

    消息处理器日志

    如需使用消息处理器日志进行验证，请执行以下操作：

    如果您是 Private Cloud 用户，则可以使用消息处理器日志来验证响应标头大小是否超出了 Apigee Edge 中允许的限制。

    1. 检查消息处理器日志：

      /opt/apigee/var/log/edge-message-processor/logs/system.log

    2. 搜索以查看在特定持续时间内是否存在任何 502 错误（如果问题是在过去发生的），或者是否有任何请求仍然失败并显示 502。您可以使用以下搜索字符串： 
      grep -ri "response headers size exceeding"
    3. 您会发现，system.log 中的行与以下内容类似。响应标头大小可能因具体情况而异： 
      2021-07-23 08:25:12,307 org:myorg env:prod api:bigheadertest rev:1
messageid:r23ijb1b-1  NIOThread@1 ERROR HTTP.CLIENT -
HTTPClient$Context$3.onException() :  ClientChannel[Connected:
Remote:3.7.1.1:9000 Local:192.168.2.1:56098]@8414 useCount=1
bytesRead=0 bytesWritten=207 age=640ms  lastIO=0ms  isOpen=true.onExceptionRead
exception: {}
com.apigee.errors.http.server.BadGateway: response headers size exceeding 25,600

2021-07-23 08:25:12,307 org:myorg env:prod api:bigheadertest
rev:1 messageid:r23ijb1b-1  NIOThread@1 ERROR ADAPTORS.HTTP.FLOW -
AbstractResponseListener.onException() : AbstractResponseListener.onError
(HTTPResponse@31f3ef88, response headers size exceeding 25,600)

    4. 一旦消息处理器从后端/目标服务器收到响应，并发现标头的总大小超过 25 KB，它就会停止运行并抛出错误：

      response headers size exceeding 25,600

      这表明总标头大小超过 25 KB，当其大小开始超过 25 KB 的上限时，Apigee 会抛出错误，同时错误代码为 protocol.http.TooBigHeaders

分辨率

修正尺寸

方法 1 [推荐]：修复目标服务器应用，确保发送的标头大小不超过 Apigee 限制

  1. 分析特定目标服务器发送响应标头大小超过限制中定义的允许限制的原因。
  2. 如果不希望这样，请修改后端服务器应用，使其发送的响应标头的大小小于 Apigee Edge 中允许的限制。
  3. 检查标头信息是否可以作为响应正文的一部分发送。
  4. 如果可行，请发送您计划在响应正文中作为标头的一部分发送的任何大型信息。这样可确保您不会超出响应标头限制。

CwC

方法 2：使用 CwC 属性提高响应标头大小限制

Apigee 提供了 CwC 属性，可用于提高响应标头大小限制。如需了解详情，请参阅 配置消息处理器的限制

限制

Apigee 要求客户端应用和后端服务器发送的标头大小不会超过 Apigee Edge 限制中针对请求/响应标头大小所允许的限制。

  1. 如果您是公有云用户，则请求和响应标头大小的上限如 Apigee Edge 限制中的请求/响应标头大小中所述。
  2. 如果您是 Private Cloud 用户 ，则可能修改了请求和响应标头的默认上限（尽管不建议这样做）。您可以按照如何查看当前限制中的说明确定响应标头的大小上限。

如何查看当前的上限？

本部分介绍如何验证属性 HTTPResponse.headers.limit 是否已使用消息处理器上的新值更新。

  1. 在消息处理器计算机上，在 /opt/apigee/edge-message-processor/conf 目录中搜索属性 HTTPResponse.headers.limit，然后检查设置的值，如下所示： 
    grep -ri "HTTPResponse.headers.limit" /opt/apigee/edge-message-processor/conf
  2. 上述命令的示例结果如下所示： 
    /opt/apigee/edge-message-processor/conf/http.properties:HTTPResponse.headers.limit=25k

  3. 请注意，在上面的示例输出中，属性 HTTPResponse.headers.limit 已使用 http.properties 的值 25k 进行了设置。

    这表示在 Apigee 中，适用于私有云的响应载荷大小上限为 25 KB。

如果您仍然需要 Apigee 支持的任何帮助，请参阅必须收集诊断信息。

必须收集的诊断信息

收集以下诊断信息，然后联系 Apigee Edge 支持团队：

如果您是公有云用户，请提供以下信息：

  • 组织名称
  • 环境名称
  • API 代理名称
  • 完成用于重现 502 错误的 curl 命令
  • API 请求的跟踪文件
  • 来自目标/后端服务器的响应的完整输出以及标头大小

如果您是 Private Cloud 用户，请提供以下信息：

  • 观察到失败请求的完整错误消息
  • 组织名称
  • 环境名称
  • API 代理软件包
  • 失败 API 请求的跟踪文件
  • 完成用于重现 502 错误的 curl 命令
  • 来自目标/后端服务器的响应的完整输出以及标头大小

  • NGINX 访问日志 /opt/apigee/var/log/edge-router/nginx/ORG~ENV.PORT#_access_log

    其中：将 ORG、ENV 和 PORT# 替换为实际值。

  • 消息处理器系统日志 /opt/apigee/var/log/edge-message-processor/logs/system.log