Настройка времени ожидания соединения на процессорах сообщений

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

В этом документе объясняется, как настроить тайм-аут соединения для обработчиков сообщений Apigee Edge.

Параметр «Тайм-аут соединения» обозначает время, в течение которого обработчик сообщений ожидает установления соединения с целевым сервером. Значение по умолчанию для параметра «Тайм-аут соединения» в обработчике сообщений составляет 3 секунды. Этот период ожидания применяется к бэкэнд-серверам, настроенным в конфигурации целевой конечной точки и в политике ServiceCallout вашего API-прокси.

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

  • В API-прокси
    • В целевой конечной точке
    • В политике ServiceCallout
  • В процессоре сообщений

Следующие параметры управляют временем ожидания соединения в обработчиках сообщений:

Название объекта недвижимости Расположение Описание
connect.timeout.millis API-прокси:
  • Целевая конечная точка
  • Политика ServiceCallout

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

По умолчанию это свойство принимает значение, установленное для свойства HTTPClient.connect.timeout.millis в обработчике сообщений, где значение по умолчанию составляет 3 секунды.

Если это свойство изменяется с новым значением таймаута для целевого сервера, связанного с API-прокси, то это повлияет только на время подключения к этому целевому серверу.

HTTPClient.connect.timeout.millis Обработчик сообщений

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

Это свойство используется для всех API-прокси, работающих на этом обработчике сообщений.

Значение по умолчанию для этого параметра составляет 3 секунды.

Вы можете изменить это свойство, как описано в разделе «Настройка таймаута соединения в обработчиках сообщений» ниже, или переопределить это значение, установив свойство connect.timeout.millis на уровне API-прокси.

Прежде чем начать

Прежде чем приступить к выполнению действий, описанных в этом документе, убедитесь, что вы понимаете следующие темы:

Настройка таймаута соединения в API-прокси

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

  • Целевая конечная точка
  • Политика ServiceCallout

Настройка таймаута соединения в целевой конечной точке API-прокси

В этом разделе объясняется, как настроить тайм-аут соединения в целевой конечной точке вашего API-прокси. Тайм-аут соединения можно настроить с помощью свойства connect.timeout.millis , которое представляет значение тайм-аута соединения в миллисекундах.

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

    Например, чтобы изменить время ожидания соединения на 5 секунд, добавьте следующий блок кода:

    <Properties>
      <Property name="connect.timeout.millis">5000</Property>
    </Properties>

    Поскольку свойство connect.timeout.millis измеряется в миллисекундах, значение для 5 секунд будет равно 5000 .

    В следующих примерах показано, как настроить тайм-аут соединения в конфигурации целевой конечной точки вашего API-прокси:

    Пример конфигурации целевой конечной точки с использованием URL-адреса для бэкэнд-сервера.

    <TargetEndpoint name="default">
      <HTTPTargetConnection>
        <URL>https://mocktarget.apigee.net/json</URL>
        <Properties>
          <Property name="connect.timeout.millis">5000</Property>
        </Properties>
      </HTTPTargetConnection>
    </TargetEndpoint>

    Пример конфигурации целевой конечной точки с использованием целевого сервера.

    <TargetEndpoint name="default">
      <HTTPTargetConnection>
        <LoadBalancer>
          <Server name="target1" />
          <Server name="target2" />
        </LoadBalancer>
        <Properties>
          <Property name="connect.timeout.millis">5000</Property>
        </Properties>
        <Path>/test</Path>
      </HTTPTargetConnection>
    </TargetEndpoint>
  4. Сохраните изменения, внесенные в ваш API-прокси.

Настройка таймаута соединения в политике ServiceCallout API-прокси

В этом разделе объясняется, как настроить тайм-аут соединения в политике ServiceCallout вашего API-прокси. Тайм-аут соединения можно настроить с помощью свойства connect.timeout.millis , которое представляет собой значение времени соединения в миллисекундах.

Чтобы настроить тайм-аут соединения в политике ServiceCallout с помощью свойства connect.timeout.millis :

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

    Например, чтобы изменить время ожидания соединения на 5 секунд, добавьте следующий блок кода:

    <Properties>
      <Property name="connect.timeout.millis">5000</Property>
    </Properties>

    Поскольку свойство connect.timeout.millis измеряется в миллисекундах, значение для 5 секунд будет равно 5000 .

    В следующих примерах показано, как настроить тайм-аут соединения в политике ServiceCallout вашего API-прокси:

    Пример настройки политики ServiceCallout с использованием URL-адреса для бэкэнд-сервера.

    <ServiceCallout name="Service-Callout-1">
      <DisplayName>Service Callout-1</DisplayName>
      <HTTPTargetConnection>
        <Properties>
          <Property name="connect.timeout.millis">5000</Property>
        </Properties>
        <URL>https://mocktarget.apigee.net/json</URL>
      </HTTPTargetConnection>
    </ServiceCallout>

    Пример настройки политики ServiceCallout с использованием целевого сервера.

    <ServiceCallout enabled="true" name="Service-Callout-1">
      <DisplayName>Service Callout-1</DisplayName>
      <Response>calloutResponse</Response>
      <HTTPTargetConnection>
        <LoadBalancer>
          <Server name="target1" />
          <Server name="target2" />
        </LoadBalancer>
        <Properties>
          <Property name="connect.timeout.millis">5000</Property>
        </Properties>
      <Path>/test</Path>
      </HTTPTargetConnection>
    </ServiceCallout>
  4. Сохраните изменения, внесенные в ваш API-прокси.

Настройка тайм-аута соединения в обработчиках сообщений

В этом разделе объясняется, как настроить тайм-аут соединения в обработчиках сообщений. Тайм-аут соединения можно настроить с помощью свойства conf_http_HTTPClient.connect.timeout.millis , которое представляет значение тайм-аута соединения в миллисекундах в компоненте обработчика сообщений, используя токен в соответствии с синтаксисом, описанным в разделе « Как настроить Edge» .

Для настройки времени ожидания соединения в обработчиках сообщений выполните следующие действия:

  1. На машине обработки сообщений откройте следующий файл в текстовом редакторе. Если он еще не существует, создайте его.
    /opt/apigee/customer/application/message-processor.properties

    Например, чтобы открыть файл с помощью vi , введите следующее:

    vi /opt/apigee/customer/application/message-processor.properties
    
  2. Добавьте в файл свойств строку следующего формата, заменив значение параметра TIME_IN_MILLISECONDS :
    conf_http_HTTPClient.connect.timeout.millis=TIME_IN_MILLISECONDS

    Например, чтобы изменить время ожидания соединения в обработчике сообщений на 5 секунд, добавьте следующую строку:

    conf_http_HTTPClient.connect.timeout.millis=5000
  3. Сохраните изменения.
  4. Убедитесь, что файл свойств принадлежит пользователю apigee , как показано ниже:
    chown apigee:apigee /opt/apigee/customer/application/message-processor.properties
    
  5. Перезапустите обработчик сообщений, как показано ниже:
    /opt/apigee/apigee-service/bin/apigee-service edge-message-processor restart
    
  6. Если у вас несколько обработчиков сообщений, повторите описанные выше шаги для всех обработчиков сообщений.

Проверка таймаута соединения в обработчиках сообщений.

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

Даже если вы используете токен conf_http_HTTPClient.connect.timeout.millis для установки времени ожидания соединения в обработчике сообщений, необходимо убедиться, что фактическое свойство HTTPClient.connect.timeout.millis было установлено с новым значением.

  1. На машине обработчика сообщений найдите свойство HTTPTransport.connect.timeout.millis в каталоге /opt/apigee/edge-message-processor/conf и проверьте, установлено ли для него новое значение, как показано ниже:
    grep -ri "HTTPClient.connect.timeout.millis" /opt/apigee/edge-message-processor/conf
    
  2. Если новое значение таймаута соединения успешно установлено в обработчике сообщений, то приведенная выше команда отобразит новое значение в файле http.properties .

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

    /opt/apigee/edge-message-processor/conf/http.properties:HTTPClient.connect.timeout.millis=5000

    В приведенном выше примере обратите внимание, что свойство HTTPClient.connect.timeout.millis в http.properties было установлено на новое значение 5000 Это указывает на то, что время ожидания соединения успешно настроено на 5 секунд в обработчике сообщений.

  3. Если для свойства HTTPClient.connect.timeout.millis по-прежнему отображается старое значение, убедитесь, что вы правильно выполнили все шаги, описанные в разделе «Настройка таймаута соединения в обработчиках сообщений» . Если вы пропустили какой-либо шаг, повторите все шаги заново.
  4. Если вам по-прежнему не удается изменить время ожидания соединения, обратитесь в службу поддержки Google Cloud Apigee Edge .