502 Плохой шлюз — TooBigHeaders

Вы просматриваете документацию Apigee Edge .
Перейдите в документацию Apigee X.info

Симптом

В ответ на вызовы API клиентское приложение получает HTTP-статус 502 Bad Gateway с кодом ошибки protocol.http.TooBigHeaders .

Сообщение об ошибке

Клиентское приложение получает следующий код ответа:

HTTP/1.1 502 Bad Gateway

Кроме того, вы можете увидеть следующее сообщение об ошибке:

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

Возможные причины

Эта ошибка возникает, если общий размер заголовков, отправляемых целевым/бэкэнд-сервером в Apigee Edge в составе HTTP-ответа, превышает допустимый лимит в Apigee Edge .

Вот возможные причины этой ошибки:

Общие этапы диагностики

Для диагностики этой ошибки воспользуйтесь одним из следующих инструментов/методов:

Причина: Размер заголовков в ответе превышает допустимый лимит.

Диагноз

1. Определите код ошибки , источник ошибки и размер полезной нагрузки ответа для обнаруженной ошибки, используя мониторинг API, инструмент трассировки или журналы доступа NGINX, как описано в разделе «Общие шаги диагностики» .
2. Если в поле Fault Source указано значение target , это означает, что ответ, отправленный целевым/бэкэнд-сервером в Apigee, содержит заголовки, размер которых превышает допустимый лимит в Apigee Edge .
3. Проверить, превышают ли заголовки ответа от целевого/бэкенд-сервера допустимый лимит, можно одним из следующих способов:

   Сообщение об ошибке

   Для проверки используйте сообщение об ошибке:

   Если у вас есть доступ к полному сообщению об ошибке, полученному от Apigee Edge, обратитесь к faultstring ). faultstring указывает на то, что размер заголовка ответа превысил допустимый предел.

   Пример сообщения об ошибке:

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

   В приведенном выше сообщении об ошибке обратите внимание на faultstring , указывающую на то, что ответ содержит заголовки, общий размер которых превышает допустимый лимит .

   Фактический запрос

   Для проверки с использованием фактического запроса:

   Если у вас есть доступ к фактическому запросу, отправленному на целевой/бэкэнд-сервер, выполните следующие шаги:

   1. Если вы являетесь пользователем публичного/частного облака , отправьте запрос непосредственно на бэкэнд-сервер с самого бэкэнд-сервера или с любой другой машины, с которой вам разрешено отправлять запросы на бэкэнд-сервер.
   2. Если вы являетесь пользователем частного облака , вы также можете отправить запрос на бэкэнд-сервер через один из обработчиков сообщений.
   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 .

   Журналы обработчика сообщений

   Для проверки с использованием журналов обработчика сообщений:

   Если вы используете частное облако, то можете использовать журналы обработчика сообщений, чтобы проверить, не превысил ли размер заголовков ответа допустимый лимит в 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 КБ, он останавливается и выдает ошибку:

      response headers size exceeding 25,600

      Это означает, что общий размер заголовков превышает 25 КБ, и Apigee выдает ошибку, когда размер начинает превышать лимит в 25 КБ, с кодом ошибки protocol.http.TooBigHeaders

Разрешение

Пределы

Apigee ожидает, что клиентское приложение и серверная часть не будут отправлять заголовки размером больше допустимого предела, указанного в документации по размеру заголовков запроса/ответа в разделе «Ограничения Apigee Edge» .

1. Если вы используете публичное облако , то максимальный предел размера заголовков запроса и ответа указан в разделе «Ограничения Apigee Edge» для размера заголовков запроса/ответа .
2. Если вы используете частное облако, то, возможно, изменили максимальное ограничение по умолчанию для размера заголовков запроса и ответа (хотя это и не рекомендуется). Вы можете определить максимальное ограничение размера заголовков ответа, следуя инструкциям в разделе «Как проверить текущее ограничение» .

Как проверить текущий лимит?

В этом разделе объясняется, как проверить, что свойство HTTPResponse.headers.limit было обновлено новым значением в обработчиках сообщений.

1. На машине обработчика сообщений найдите свойство HTTPResponse.headers.limit в каталоге /opt/apigee/edge-message-processor/conf и проверьте, какое значение установлено, как показано ниже:

   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 КБ.

Если вам по-прежнему нужна помощь службы поддержки Apigee, перейдите по ссылке «Необходимо собрать диагностическую информацию» .

Необходимо собрать диагностическую информацию.

Соберите следующую диагностическую информацию, а затем свяжитесь со службой поддержки Apigee Edge :

Если вы являетесь пользователем публичного облака , предоставьте следующую информацию:

• Название организации
• Название среды
• Имя API-прокси
• Полная команда curl , использованная для воспроизведения ошибки 502
• Файл трассировки для запросов API
• Полный вывод ответа от целевого/бэкенд-сервера, включая размер заголовков.

Если вы являетесь пользователем частного облака , предоставьте следующую информацию:

• Полное сообщение об ошибке, полученное для неудачных запросов.
• Название организации
• Название среды
• Пакет API-прокси
• Файл трассировки для неудачных запросов API
• Полная команда curl , использованная для воспроизведения ошибки 502
• Полный вывод ответа от целевого/бэкенд-сервера, включая размер заголовков.

• Журналы доступа 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