Como configurar o tempo limite de conexão em processadores de mensagens

Você está vendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X.
informações

Este documento explica como configurar o tempo limite de conexão para os processadores de mensagens do Apigee Edge.

O tempo limite de conexão representa o tempo que o processador de mensagens espera para estabelecer a conexão com o servidor de destino. O valor padrão da propriedade de tempo limite de conexão no processador de mensagens é de 3 segundos. Esse tempo limite é aplicável aos servidores de back-end configurados na configuração do endpoint de destino e na política ServiceCallout do seu proxy de API.

O tempo limite de conexão para os processadores de mensagens pode ser aumentado ou reduzido do valor padrão de 3 segundos com base nas suas necessidades. Ele pode ser configurado das seguintes maneiras:

  • No proxy de API
    • No endpoint de destino
    • Na política ServiceCallout
  • No processador de mensagens

As seguintes propriedades controlam o tempo limite de conexão nos processadores de mensagens:

Nome da propriedade Local Descrição
connect.timeout.millis Proxy de API:
  • Endpoint de destino
  • Política de ServiceCallout

Esse é o tempo máximo que o processador de mensagens espera para se conectar ao servidor de destino.

Por padrão, essa propriedade usa o valor definido para a propriedade HTTPClient.connect.timeout.millis no processador de mensagens, em que o valor padrão é 3 segundos.

Se essa propriedade for modificada com um novo valor de tempo limite para o servidor de destino associado a um proxy de API, o tempo de conexão somente desse servidor será afetado.

HTTPClient.connect.timeout.millis processador de mensagens

Esse é o tempo máximo que o processador de mensagens espera para se conectar ao servidor de destino.

Essa propriedade é usada para todos os proxies de API em execução neste processador de mensagens.

O valor padrão dessa propriedade é de 3 segundos.

Você pode modificar essa propriedade, conforme explicado na seção Como configurar o tempo limite de conexão em processadores de mensagens abaixo, ou substituir esse valor configurando a propriedade connect.timeout.millis no nível do proxy da API.

Antes de começar

Antes de seguir as etapas deste documento, é importante entender os seguintes tópicos:

Como configurar o tempo limite de conexão no proxy de API

O tempo limite de conexão pode ser configurado no proxy de API nos seguintes locais:

  • Endpoint de destino
  • Política de ServiceCallout

Configurar o tempo limite de conexão no endpoint de destino do proxy de API

Nesta seção, explicamos como configurar o tempo limite de conexão no endpoint de destino do proxy de API. É possível configurar o tempo limite da conexão por meio da propriedade connect.timeout.millis, que representa o valor do tempo limite da conexão em milissegundos.

  1. Na interface do Edge, selecione o proxy de API específico em que você quer configurar o novo valor de tempo limite de conexão.
  2. Selecione o endpoint de destino específico que você quer modificar.
  3. Adicione a propriedade connect.timeout.millis com um valor adequado no elemento <HTTPTargetConnection> na configuração TargetEndpoint.

    Por exemplo, para alterar o tempo limite de conexão para 5 segundos, adicione o bloco de código a seguir:

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

    Como a propriedade connect.timeout.millis está em milissegundos, o valor para segundos de 5 é 5000.

    Os exemplos a seguir mostram como definir o tempo limite de conexão na configuração do endpoint de destino do seu proxy de API:

    Exemplo de configuração de endpoint de destino usando URL para o servidor de back-end

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

    Exemplo de configuração do endpoint de destino usando o servidor de destino

    <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. Salve as alterações feitas no proxy de API.

Como configurar o tempo limite de conexão na política Service callout do proxy de API

Nesta seção, explicamos como configurar o tempo limite de conexão na política ServiceCallout do proxy de API. É possível configurar o tempo limite da conexão usando a propriedade connect.timeout.millis, que representa o valor do tempo de conexão em milissegundos.

Para configurar o tempo limite de conexão na política ServiceCallout usando a propriedade connect.timeout.millis:

  1. Na interface do Edge, selecione o proxy de API específico em que você quer configurar o novo valor de tempo limite de conexão para a política ServiceCallout.
  2. Selecione a política ServiceCallout específica que você quer modificar.
  3. Adicione a propriedade connect.timeout.millis com um valor adequado no elemento <HTTPTargetConnection> na configuração TargetEndpoint.

    Por exemplo, para mudar o tempo limite de conexão para 5 segundos, adicione o seguinte bloco de código:

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

    Como a propriedade connect.timeout.millis está em milissegundos, o valor para segundos de 5 é 5000.

    Os exemplos a seguir mostram como configurar o tempo limite de conexão na política ServiceCallout do proxy de API:

    Exemplo de configuração de política Service callout usando URL para o servidor de back-end

    <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>
    

    Exemplo de configuração da política ServiceFrase de destaque usando o servidor de destino

    <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. Salve as alterações feitas no proxy de API.

Como configurar o tempo limite de conexão nos processadores de mensagens

Esta seção explica como configurar o tempo limite de conexão nos processadores de mensagens. O tempo limite da conexão pode ser configurado pela propriedade conf_http_HTTPClient.connect.timeout.millis, que representa o valor do tempo limite em milissegundos no componente do processador de mensagens usando o token de acordo com a sintaxe descrita em Como configurar o Edge.

Para configurar o tempo limite de conexão nos processadores de mensagens, faça o seguinte:

  1. Na máquina do processador de mensagens, abra o arquivo a seguir em um editor. Se ainda não existir, crie-o.
    /opt/apigee/customer/application/message-processor.properties
    

    Por exemplo, para abrir o arquivo usando vi, digite o seguinte:

    vi /opt/apigee/customer/application/message-processor.properties
    
  2. Adicione uma linha no seguinte formato ao arquivo de propriedades, substituindo um valor por TIME_IN_MILLISECONDS:
    conf_http_HTTPClient.connect.timeout.millis=TIME_IN_MILLISECONDS
    

    Por exemplo, para alterar o tempo limite de conexão no processador de mensagens para 5 segundos, adicione a seguinte linha:

    conf_http_HTTPClient.connect.timeout.millis=5000
    
  3. Salve as mudanças.
  4. Verifique se o arquivo de propriedades pertence ao usuário apigee, conforme mostrado abaixo:
    chown apigee:apigee /opt/apigee/customer/application/message-processor.properties
    
  5. Reinicie o processador de mensagens conforme mostrado abaixo:
    /opt/apigee/apigee-service/bin/apigee-service edge-message-processor restart
    
  6. Se você tiver mais de um processador de mensagens, repita as etapas acima para todos eles.

Como verificar o tempo limite de conexão nos processadores de mensagens

Esta seção explica como verificar se o tempo limite de conexão foi modificado com êxito nos processadores de mensagens.

Mesmo que você use o token conf_http_HTTPClient.connect.timeout.millis para definir o tempo limite de conexão no processador de mensagens, é necessário verificar se a propriedade HTTPClient.connect.timeout.millis real foi definida com o novo valor.

  1. Na máquina do processador de mensagens, pesquise a propriedade HTTPTransport.connect.timeout.millis no diretório /opt/apigee/edge-message-processor/conf e verifique se ela foi definida com o novo valor, conforme mostrado abaixo:
    grep -ri "HTTPClient.connect.timeout.millis" /opt/apigee/edge-message-processor/conf
    
  2. Se o novo valor de tempo limite de conexão for definido no processador de mensagens, o comando acima mostrará o novo valor no arquivo http.properties.

    O resultado do comando acima depois de você configurar o tempo limite de conexão como 5 segundos é o seguinte:

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

    No exemplo de saída acima, observe que a propriedade HTTPClient.connect.timeout.millis foi definida com o novo valor 5000 em http.properties. Isso indica que o tempo limite de conexão foi configurado para 5 segundos no processador de mensagens.

  3. Se o valor antigo da propriedade HTTPClient.connect.timeout.millis ainda aparecer, verifique se você seguiu todas as etapas descritas em Como configurar o tempo limite de conexão nos processadores de mensagens corretamente. Se você esqueceu alguma etapa, repita todas as etapas corretamente.
  4. Se ainda assim não for possível modificar o tempo limite da conexão, entre em contato com o suporte do Apigee Edge do Google Cloud.