502 閘道錯誤 - TooBigLine

您目前查看的是 Apigee Edge 說明文件。
前往 Apigee X 說明文件。 info

問題

用戶端應用程式會收到 HTTP 狀態碼 502 Bad Gateway，以及錯誤碼 protocol.http.TooBigLine ，做為 API 呼叫的回應。

錯誤訊息

用戶端應用程式會取得下列回應代碼：

HTTP/1.1 502 Bad Gateway

此外，您可能會看到下列錯誤訊息：

{
   "fault":{
      "faultstring":"response line size exceeding 2,048",
      "detail":{
         "errorcode":"protocol.http.TooBigLine"
      }
   }
}

可能原因

如果目標/後端伺服器傳送至 Apigee Edge 的 Response-Line 大小超過 Apigee Edge 允許的上限，就會發生這個錯誤。

在探討這個錯誤的可能原因之前，我們先瞭解「回應行」的意義，以及如何檢查其大小。

瞭解回覆行

典型的 HTTP 回應包含三個部分：

1. Status-Line (在 Apigee 中稱為 Response-Line)
2. ( Set of HTTP headers )
3. [ Body ]

回應行包含三個部分：通訊協定版本，後面接著數字狀態碼和相關聯的文字片語，如下所示：

Response-Line   = <HTTP-Version> <Status-Code> <Reason-Phrase>

目標/後端伺服器應用程式傳送 HTTP 回應時，傳送的第一行代表上述的回應行。接著是標頭和回應主體/酬載。以下螢幕截圖範例顯示典型的 curl 要求、「Request」(要求) 部分和「Response」(回應) 部分 (以及回應行)。

瞭解回覆行大小

1. 在上述範例中，回應中的 start 行 (第一行) 也稱為「Response-Line」，如下所示：

   HTTP/1.1 200 OK

   這個回應行包含 15 ASCII characters，因此大小為 ~15 bytes。由於這是在 Apigee Edge 允許的限制內，因此 Apigee Edge 會將回應傳回給用戶端，不會發生任何錯誤。

2. 同樣地，如果您查看上方錯誤訊息中的 faultstring，會發現其中包含 "response line size exceeding 2,048"。這表示目標/後端伺服器傳送的 HTTP 回應中，Response-Line 超過 2,048 個位元組。

瞭解大型回應行

根據 狀態行 (在此稱為回應行) 和一般 HTTP 要求與回應的定義，大小會遠小於 Apigee Edge 中定義的 2 K 預設限制，因此我們可能不會達到限制。不過，在下列情況下，您可能會超過這個限制：

1. 目標/後端伺服器不是 HTTP 系統。可能是以非 HTTP 回應的形式回覆。
2. 目標/後端伺服器發生問題，並在 HTTP 回應中傳送長回應行。

如要進一步瞭解這項錯誤，請參閱「 Getting error protocol.http.TooBigLine, "response line size exceeding 2,048」。

以下是可能導致錯誤的原因：

常見的診斷步驟

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

原因：回應行大小超過允許的上限

診斷

1. 使用 API 監控、追蹤工具或 NGINX 存取記錄，判斷觀察到的錯誤的錯誤代碼和錯誤來源，如常見診斷步驟所述。
2. 如果「Fault Source」的值為 target，表示目標/後端伺服器應用程式傳送至 Apigee 的 Response-Line 大小，大於 Apigee Edge 允許的上限。

3. 如要驗證回應行大小是否超過 2 KB 的允許上限，請使用下列其中一種方法：

   錯誤訊息

   如何使用錯誤訊息進行驗證：

   如果您可以存取 Apigee Edge 傳送的完整錯誤訊息，請參閱faultstring。

   錯誤訊息範例：

   "faultstring":"response line size exceeding 2,048"

   上述 faultstring 表示回應行大小超過 2 KB 的上限。

   實際要求

   如要使用實際要求進行驗證，請按照下列步驟操作：

   如果您有權存取向目標/後端伺服器應用程式發出的實際要求，請執行下列步驟：

   1. 確認 Response-Line 的大小
   2. 如果發現 URI 大小超過 Apigee Edge 允許的限制，這就是問題的原因。

      目標/後端伺服器的範例回應：

      curl -v http://HOSTALIAS/test
      

      *   Trying 3.2.1.4...
      * TCP_NODELAY set
      * Connected to <hostalias> (3.2.1.4) port 80 (#0)
      > GET /test HTTP/1.1
      > Host: HOSTALIAS
      > User-Agent: curl/7.64.1
      > Accept: */*
      >
      < HTTP/1.1 200 1111…<trimmed>...11111111
      < Date: Mon, 26 Jul 2021 07:07:18 GMT
      < Content-Type: application/json
      < Content-Length: 269
      < Connection: keep-alive
      < Server: gunicorn/19.9.0
      < Access-Control-Allow-Origin: *
      < Access-Control-Allow-Credentials: true
      <
      {
      <Response Body>
      }
      * Connection #0 to host <hostalias> left intact
      * Closing connection 0

      在上述情況中，Response-Line HTTP/1.1 200 1111…<trimmed>...11111111 大於 2 KB，也就是包含超過 2 K 個 ASCII 字元。

      如果您使用其他用戶端，可以查看用戶端記錄，嘗試找出傳送至 Apigee Edge 的 Response-Line 大小。

   訊息處理器記錄

   如要使用訊息處理器記錄進行驗證，請按照下列步驟操作：

   如果您是 私有雲使用者，則可使用訊息處理器記錄檔，驗證 Response-Line 大小是否超過 Apigee Edge 允許的限制。

   1. 如要使用 API 監控、追蹤工具或 NGINX 存取記錄判斷失敗要求的訊息 ID，請參閱「常見診斷步驟」。

   2. 在訊息處理器記錄中搜尋郵件 ID：

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

   3. 您會找到類似下列的 system.log 行：

      2021-07-26 06:45:41,451 org:myorg env:prod api:testtoobigline rev:1 messageid:r-5110240-1
      NIOThread@1 ERROR HTTP.CLIENT - HTTPClient$Context$3.onException() :
      ClientChannel[Connected: Remote:3.2.1.2:80 Local:192.168.205.251:44398]@20592
      useCount=1 bytesRead=0 bytesWritten=201 age=144ms  lastIO=0ms  isOpen=true.onExceptionRead
      exception: {}
      com.apigee.errors.http.server.BadGateway: response line size exceeding 2,048
      at <snipped>
      
      2021-07-26 06:45:41,451 org:myorg env:prod api:testtoobigline rev:1
      messageid:r-5110240-1  NIOThread@1 ERROR ADAPTORS.HTTP.FLOW -
      AbstractResponseListener.onException() : AbstractResponseListener.onError
      (HTTPResponse@6a5d6c33, response line size exceeding 2,048)

      上述錯誤訊息中的 message = response line size exceeding 2,048 文字表示回應行大小超過 2 KB。因此，Apigee Edge 會擲回例外狀況，並向用戶端應用程式傳回 502 狀態碼和 protocol.http.TooBigline 錯誤代碼。

解析度

限制

Apigee 預期用戶端應用程式和後端伺服器不會傳送大小超出允許上限的要求/回應行，如 Apigee Edge 限制中的「要求/回應行限制」所述。

1. 如果您是公有雲使用者，則要求和回應行大小上限與 Apigee Edge 限制中要求/回應行大小的規定相同。
2. 如果您是私有雲使用者 ，可能已修改要求和回應行大小的預設上限 (即使不建議這麼做)。如要判斷回應行的大小上限，請按照「如何查看目前上限」一文中的操作說明進行。

如何查看目前的限制？

本節說明如何確認訊息處理器上的屬性 HTTPResponse.line.limit 已更新為新值。

1. 在訊息處理器電腦上，搜尋 /opt/apigee/edge-message-processor/conf 目錄中的 HTTPResponse.line.limit 屬性，然後檢查已設定的值，如下所示：

   grep -ri "HTTPResponse.line.limit" /opt/apigee/edge-message-processor/conf
   

2. 上述指令的範例結果如下：

   /opt/apigee/edge-message-processor/conf/http.properties:HTTPResponse.line.limit=2k

3. 在上述範例輸出內容中，請注意屬性 HTTPResponse.line.limit 已在 http.properties 中設為 2k 值。

   這表示在 Apigee for Private Cloud 中設定的回應行大小限制為 2 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