504 Gateway timeout (Шлюз не отвечает) – превышено время ожидания маршрутизатора

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

Symptom

В ответ на вызовы API клиентское приложение получает код статуса HTTP 504 с сообщением Gateway Timeout.

Этот ответ об ошибке указывает на то, что клиент не получил своевременный ответ от Apigee Edge или внутреннего сервера во время выполнения вызова API.

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

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

HTTP/1.1 504 Gateway Time-out

При вызове такого прокси-сервера с помощью cURL или веб-браузера может появиться следующая ошибка:

<!DOCTYPE html>
<html>
<head>
<title>Error</title>
<style>
    body {
        width: 35em;
        margin: 0 auto;
        font-family: Tahoma, Verdana, Arial, sans-serif;
    }
</style>
</head>
<body>
<h1>An error occurred.</h1>
<p>Sorry, the page you are looking for is currently unavailable.<br/>
Please try again later.</p>
</body>
</html>

Что вызывает тайм-ауты?

Обычно запрос к API через платформу Edge проходит по следующему пути: Клиент > Маршрутизатор > Message Processor > Бэкенд-сервер, как показано на рисунке ниже.

Все компоненты среды выполнения Apigee Edge, включая клиентов, маршрутизаторы, процессоры сообщений и серверы бэкэнда, настроены с подходящими значениями времени ожидания по умолчанию, чтобы запросы API не выполнялись слишком долго. Если какой-либо компонент в цепочке не получит ответ от вышестоящего компонента в течение периода времени, указанного в конфигурации времени ожидания, то этот компонент будет отключен по тайм-ауту и обычно вернет ошибку 504 Gateway Timeout.

В этом пособии рассказывается, как устранить ошибку 504, которая возникает, когда истекает время ожидания маршрутизатора.

Время ожидания на маршрутизаторе

По умолчанию время ожидания, настроенное на маршрутизаторах в Apigee Edge, составляет 57 секунд. Это максимальное время, в течение которого прокси-сервер API может выполняться с момента получения запроса к API в Edge до отправки ответа, включая ответ от внутреннего сервиса и все выполненные правила. Значение тайм-аута по умолчанию можно переопределить на маршрутизаторах или виртуальных хостах, как описано в разделе Настройка тайм-аута ввода-вывода на маршрутизаторах.

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

В Edge ошибка 504 Gateway Timeout, вызванная истечением времени ожидания маршрутизатора, обычно возникает по следующим причинам:

Причина Описание Инструкции по устранению неполадок, применимые к
Неправильная конфигурация времени ожидания на маршрутизаторе Это происходит, если для маршрутизатора задан неправильный период ожидания ввода-вывода. Пользователи общедоступного и частного облака Edge

Распространенные этапы диагностики

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

  • Мониторинг API
  • Журналы доступа NGINX

Мониторинг API

Чтобы диагностировать ошибку с помощью мониторинга API:

  1. Перейдите на страницу Анализ > Мониторинг API > Исследование.
  2. Отфильтруйте ошибки 5xx и выберите временной диапазон.
  3. Постройте график Код статуса по оси Y и Время по оси X.
  4. Нажмите на ячейку с ошибками 504, чтобы посмотреть подробную информацию и журналы ошибок, как показано ниже.

    Пример ошибки 504

  5. На панели справа нажмите Посмотреть журналы.

    В окне Журналы трафика обратите внимание на следующие сведения об ошибках 504:

    • Запрос. Метод запроса и URI, используемые для совершения звонков.
    • Response Time: общее время, затраченное на запрос.

    В примере выше:

    • Запрос указывает на GET /test-timeout.
    • Время ответа  – 57.001 секунд. Это означает, что время ожидания маршрутизатора истекло до того, как Message Processor смог ответить, поскольку значение очень близко к заданному по умолчанию времени ожидания ввода-вывода на маршрутизаторе, которое составляет 57 секунд.

    Вы также можете получить все журналы с помощью API мониторинга API GET logs. Например, если вы запросите журналы для org, env, timeRange и status, то сможете скачать все журналы для транзакций, в которых истекло время ожидания клиента.

    Поскольку API Monitoring устанавливает для этих ошибок прокси-сервер - (не задано), вы можете использовать API (Logs API), чтобы получить связанный прокси-сервер для виртуального хоста и пути.504

    For example :

    curl "https://apimonitoring.enterprise.apigee.com/logs/apiproxies?org=ORG&env=ENV&select=https
    
  6. Проверьте время ответа на наличие дополнительных ошибок 504 и убедитесь, что время ответа одинаково (значение времени ожидания ввода-вывода, заданное на маршрутизаторе, составляет 57 секунд) для всех ошибок 504.

Журналы доступа NGINX

Чтобы диагностировать ошибку с помощью журналов доступа NGINX:

  1. Проверьте журналы доступа NGINX:
    /opt/apigee/var/log/edge-router/nginx/ORG~ENV.PORT#_access_log
  2. Выполните поиск, чтобы узнать, были ли 504 ошибки за определенный период (если проблема возникла в прошлом) или есть ли запросы, которые по-прежнему завершаются с ошибкой 504.
  3. Обратите внимание на следующую информацию об ошибках 504:
    • Время ответа
    • URI запроса

    В этом примере мы видим следующую информацию:

    • Время запроса: 57.001 секунд. Это означает, что время ожидания маршрутизатора истекло через 57,001 секунды.

    • Запрос: GET /test-timeout
    • Псевдоним хоста: myorg-test.apigee.net
  4. Проверьте, совпадает ли Время запроса с временем ожидания ввода-вывода, настроенным на маршрутизаторе или виртуальном хосте. Если да, то это означает, что время ожидания маршрутизатора истекло до того, как Message Processor ответил в течение этого периода.

    В приведенном выше примере записи журнала доступа NGINX время запроса, равное 57.001 секундам, очень близко к тайм-ауту ввода-вывода, заданному по умолчанию на маршрутизаторе. Это явно указывает на то, что время ожидания маршрутизатора истекло до того, как процессор сообщений смог ответить.

  5. Определите прокси API, для которого был сделан запрос, используя базовый путь в поле Запрос .

Причина: неправильная конфигурация времени ожидания на маршрутизаторе

диагностика;

  1. Определите, вызваны ли ошибки 504 тем, что время ожидания маршрутизатора истекло до того, как Message Processor смог отправить ответ. Для этого проверьте, совпадает ли Время ответа в API Monitoring или Время запроса в маршрутизаторе (оба поля содержат одну и ту же информацию, но называются по-разному) с тайм-аутом ввода-вывода, настроенным в маршрутизаторе или виртуальном хосте, и задано ли для полей Источник ошибки, Прокси-сервер ошибки и Код ошибки значение -. Это можно сделать с помощью API Monitoring или журналов доступа NGINX, как описано в разделе Общие этапы диагностики.
  2. Проверьте, не меньше ли значение тайм-аута ввода-вывода, заданное на маршрутизаторе или определенном виртуальном хосте, чем значение, заданное на процессоре сообщений или определенном прокси API.

    Для этого выполните инструкции из этого раздела.

Проверка времени ожидания ввода-вывода на виртуальных хостах

Интерфейс Edge

Чтобы проверить время ожидания виртуального хоста с помощью интерфейса Edge, выполните следующие действия:

  1. Войдите в интерфейс Edge.
  2. Перейдите в раздел Администратор > Виртуальные хосты.
  3. Выберите платформу, на которой возникает проблема с тайм-аутом.
  4. Выберите виртуальный хост, для которого вы хотите проверить значение тайм-аута ввода-вывода.
  5. В разделе Свойства найдите значение Тайм-аут чтения прокси-сервера в секундах.

    В приведенном выше примере для параметра Proxy Read Timeout задано значение 120. Это означает, что время ожидания ввода-вывода, настроенное на этом виртуальном хосте, составляет 120 секунд.

Management API

Вы также можете проверить время ожидания чтения прокси-сервера с помощью следующих API управления:

  1. Выполните API Get virtual host (Получить виртуальный хост), чтобы получить конфигурацию virtualhost, как показано ниже:

    Пользователь общедоступного облака

    curl -v -X GET https://api.enterprise.apigee.com/v1/organizations/ORGANIZATION_NAME/environments/ENVIRONMENT_NAME/virtualhosts/VIRTUALHOST_NAME -u USERNAME
    

    Пользователь частного облака

    curl -v -X GET http://MANAGEMENT_SERVER_HOST:PORT#/v1/organizations/ORGANIZATION_NAME/environments/v/virtualhosts/VIRTUALHOST_NAME -u USERNAME
    

    Где:

    ORGANIZATION_NAME – название организации

    ENVIRONMENT_NAME – название среды.

    VIRTUALHOST_NAME – название виртуального хоста.

  2. Проверьте значение, заданное для свойства proxy_read_timeout.

    Пример определения виртуального хоста

    {
      "hostAliases": [
        "api.myCompany,com",
      ],
      "interfaces": [],
      "listenOptions": [],
      "name": "secure",
      "port": "443",
      "retryOptions": [],
      "properties": {
        "property": [
          {
            "name": "proxy_read_timeout",
            "value": "120"
          }
        ]
      },
      "sSLInfo": {
        "ciphers": [],
        "clientAuthEnabled": "false",
        "enabled": "true",
        "ignoreValidationErrors": false,
        "keyAlias": "myCompanyKeyAlias",
        "keyStore": "ref://myCompanyKeystoreref",
        "protocols": []
      },
      "useBuiltInFreeTrialCert": false
    }

    В примере выше для параметра proxy_read_timeout задано значение 120. Это означает, что время ожидания ввода-вывода, настроенное на этом виртуальном хосте, составляет 120 секунд.

Как проверить время ожидания ввода-вывода в файле router.properties

  1. Войдите в систему на компьютере маршрутизатора.
  2. Найдите в каталоге /opt/nginx/conf.d свойство proxy_read_timeout и проверьте, задано ли для него новое значение, как показано ниже:
    grep -ri "proxy_read_timeout" /opt/nginx/conf.d
    
  3. Проверьте значение, заданное для свойства proxy_read_timeout в файле конфигурации определенного виртуального хоста.

    Пример результата команды grep

    /opt/nginx/conf.d/0-default.conf:proxy_read_timeout 57;
    /opt/nginx/conf.d/0-edge-health.conf:proxy_read_timeout 1s;

    В приведенном выше примере выходных данных обратите внимание, что для свойства proxy_read_timeout задано новое значение 57 в файле 0-default.conf, который является файлом конфигурации для виртуального хоста по умолчанию. Это означает, что время ожидания ввода-вывода на маршрутизаторе для виртуального хоста по умолчанию настроено на 57 секунд. Если у вас несколько виртуальных хостов, вы увидите эту информацию для каждого из них. Получите значение proxy_read_timeout для определенного виртуального хоста, который вы использовали для вызовов API, завершившихся с ошибками 504.

Как проверить время ожидания ввода-вывода в прокси-сервере API

Время ожидания ввода-вывода можно посмотреть в следующих разделах:

  • Целевая конечная точка прокси-сервера API
  • Правила ServiceCallout для прокси-сервера API
Как посмотреть время ожидания ввода-вывода в целевой конечной точке прокси-сервера API
  1. В интерфейсе Edge выберите нужный прокси-сервер API, в котором нужно посмотреть значение времени ожидания ввода-вывода.
  2. Выберите конечную точку, которую хотите проверить.
  3. Посмотрите на свойство io.timeout.millis с подходящим значением в элементе <HTTPTargetConnection> конфигурации TargetEndpoint.

    Например, в приведенном ниже коде время ожидания ввода-вывода установлено на уровне 120 секунд:

    <Properties>
      <Property name="io.timeout.millis">120000</Property>
    </Properties>
Как посмотреть время ожидания ввода-вывода в правиле ServiceCallout прокси-сервера API
  1. В интерфейсе Edge выберите прокси-сервер API, в котором хотите посмотреть новое значение времени ожидания ввода-вывода для правила ServiceCallout.
  2. Выберите нужное правило ServiceCallout.
  3. Посмотрите элемент <Timeout> с подходящим значением в конфигурации <ServiceCallout>.

    Например, время ожидания ввода-вывода в следующем коде составит 120 секунд:

    <Timeout>120000</Timeout>

Проверка времени ожидания ввода-вывода на процессорах сообщений

  1. Войдите в систему на компьютере Message Processor.
  2. Найдите ресурс HTTPTransport.io.timeout.millis в каталоге /opt/apigee/edge-message-processor/conf с помощью следующей команды:

    grep -ri "HTTPTransport.io.timeout.millis" /opt/apigee/edge-message-processor/conf
    

    Пример результата

    /opt/apigee/edge-message-processor/conf/http.properties:HTTPTransport.io.timeout.millis=55000
  3. В приведенном выше примере выходных данных обратите внимание, что свойству HTTPTransport.io.timeout.millis задано значение 55000 в http.properties. Это означает, что на Message Processor успешно настроено время ожидания I/O в 55 секунд.

Определив время ожидания, настроенное на маршрутизаторе и Message Processor, проверьте, не задано ли для маршрутизатора или виртуального хоста меньшее значение времени ожидания, чем для Message Processor или прокси-сервера API.

Запишите значения, заданные на всех уровнях, как показано в таблице ниже.

Время ожидания на маршрутизаторе (в секундах) Время ожидания виртуального хоста (в секундах) Время ожидания Message Processor (в секундах) Время ожидания прокси-сервера API (в секундах)
57 - 55 120

В этом примере

  • На маршрутизаторе по умолчанию установлено значение 57 секунд.
  • Значение времени ожидания не задано для определенного виртуального хоста. Это означает, что будет использоваться значение по умолчанию (57 секунд), заданное на самом маршрутизаторе.
  • В Message Processor по умолчанию задано значение 55 секунд.
  • Однако для определенного прокси API задано значение 120 секунд.

Обратите внимание, что более высокое значение времени ожидания настраивается только в прокси API, а маршрутизатор по-прежнему настроен на 57 секунд. Таким образом, время ожидания маршрутизатора истекает через 57 секунд, а обработчик сообщений или серверная часть все ещё обрабатывает ваш запрос. В результате маршрутизатор возвращает клиентскому приложению ошибку 504 Gateway Timeout.

Разрешение

Чтобы устранить эту проблему, выполните следующие действия, чтобы настроить правильное время ожидания ввода-вывода на маршрутизаторе и процессоре сообщений.

  1. Чтобы узнать, какие значения тайм-аута следует задать для разных компонентов, участвующих в потоке запросов API через Apigee Edge, ознакомьтесь с рекомендациями по настройке тайм-аута ввода-вывода.
  2. В приведенном выше примере, если вы определили, что необходимо задать большее значение времени ожидания, поскольку бэкенд-серверу требуется больше времени, и вы увеличили значение времени ожидания Message Processor до 120 секунд, то задайте большее значение времени ожидания, например 123 seconds, на маршрутизаторе. Чтобы новое значение времени ожидания не повлияло на все прокси API, задайте значение 123 seconds только для определенного виртуального хоста, который используется в определенном прокси API.
  3. Чтобы задать время ожидания для виртуального хоста, следуйте инструкциям в разделе Настройка времени ожидания ввода-вывода на маршрутизаторах.