502 閘道錯誤 - TooBigHeaders

您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件。 資訊

問題

用戶端應用程式會取得 502 Bad Gateway 的 HTTP 狀態碼，以及錯誤代碼 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 Public and Private Cloud 使用者

常見診斷步驟

請使用下列其中一種工具/技巧診斷這項錯誤：

原因：回應中的標頭大小大於允許的限制

診斷

1. 按照常見診斷步驟所述，針對透過 API 監控、追蹤記錄工具或 NGINX 存取記錄找出錯誤的「Fault Code」、「Fault 來源」和「回應酬載大小」。
2. 如果「Fault Source」的值為 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

解析度

限制

Apigee 預期用戶端應用程式和後端伺服器傳送的標頭大小不會超過 Apigee Edge 限制中「要求/回應標頭大小」所述的限制。

1. 如果您是公開雲端使用者，則要求和回應標頭大小的最大上限請參閱 Apigee Edge 限制中的「要求/回應標頭大小」。
2. 如果您是私有雲使用者 ，您可能已修改要求和回應標頭大小的預設上限 (即便這並不是建議做法)。如要決定回應標頭大小上限，請按照如何檢查目前限制中的指示操作。

如何查看目前的限制？

本節說明如何確認訊息處理器中的 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 Proxy 名稱
• 完成用來重現 502 錯誤的 curl 指令
• API 要求的追蹤檔
• 目標/後端伺服器的回應完整輸出內容，以及標頭大小

如果您是 Private Cloud 使用者，請提供下列資訊：

• 觀察失敗要求的完整錯誤訊息
• 機構組織名稱
• 環境名稱
• API Proxy 套裝組合
• 失敗 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