Como configurar o tempo limite de E/S em processadores de mensagens

Você está lendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X.
info

Neste documento, explicamos como configurar o tempo limite de E/S para os processadores de mensagens do Apigee Edge.

O tempo limite de E/S no processador de mensagens representa o tempo que o processador de mensagens aguarda para receber uma resposta do servidor de back-end ou para que o soquete esteja pronto para gravar uma solicitação no servidor de back-end, antes de atingir o tempo limite.

O valor padrão do tempo limite de E/S do processador de mensagens é 55 seconds. Esse período de tempo limite é aplicável aos servidores de back-end configurados na configuração do endpoint de destino e na política ServiceCallout do proxy de API.

O tempo limite de E/S para processadores de mensagens pode ser aumentado ou diminuído do valor padrão de 55 seconds com base nas suas necessidades. Ele pode ser configurado nos seguintes locais:

  • No proxy de API
    • Endpoint de destino
    • Política ServiceCallout
  • No processador de mensagens

As propriedades a seguir controlam o tempo limite de E/S nos processadores de mensagens:

Nome da propriedade Local Descrição
io.timeout.millis

Proxy de API:

  • Endpoint de destino
  • Política ServiceCallout

Este é o tempo máximo em que o processador de mensagens faz o seguinte:

  • Aguarda para receber uma resposta do servidor de back-end, depois de estabelecer a conexão e enviar a solicitação ao servidor de back-end OU
  • Aguarda que o soquete esteja pronto para o processador de mensagens enviar a solicitação ao servidor de back-end.

Se não houver resposta do servidor de back-end dentro desse período de tempo limite, o processador de mensagens vai atingir o tempo limite.

Por padrão, essa propriedade usa o valor definido para a HTTPTransport.io.timeout.millis propriedade no processador de mensagens. O valor padrão é 55 seconds.

Se essa propriedade for modificada com um novo valor de tempo limite para um proxy de API específico, apenas esse proxy de API será afetado.

HTTPTransport.io.timeout.millis Processador de mensagens

Este é o tempo máximo em que o processador de mensagens faz o seguinte:

  • Aguarda para receber uma resposta do servidor de back-end, depois de estabelecer a conexão e enviar a solicitação ao servidor de back-end OU
  • Aguarda que o soquete esteja pronto para o processador de mensagens enviar a solicitação ao servidor de back-end.

Se não houver resposta do servidor de back-end dentro desse período de tempo limite, o processador de mensagens vai atingir o tempo limite.

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

O valor padrão dessa propriedade é 55 seconds.

É possível modificar essa propriedade conforme explicado em Configurar o tempo limite de E/S em processadores de mensagens ou substituir esse valor definindo a propriedade io.timeout.millis no nível do proxy de API.

Antes de começar

Antes de usar as etapas neste documento, entenda os seguintes tópicos:

Configurar o tempo limite de E/S no proxy de API

O tempo limite de E/S pode ser configurado nos seguintes locais do proxy de API:

  • Endpoint de destino
  • Política ServiceCallout

Configurar o tempo limite de E/S no endpoint de destino do proxy de API

Esta seção explica como configurar o tempo limite de E/S no endpoint de destino do proxy de API. O tempo limite de E/S pode ser configurado pela propriedade io.timeout.millis, que representa o valor do tempo limite de E/S 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 E/S.
  2. Selecione o endpoint de destino específico que você quer modificar.
  3. Adicione a propriedade io.timeout.millis com um valor adequado no <HTTPTargetConnection> elemento na TargetEndpoint configuração.
  4. Por exemplo, para mudar o tempo limite de E/S para 120 segundos, adicione o seguinte bloco de código:

        <Properties>
          <Property name="io.timeout.millis">120000</Property>
        </Properties>

    Como a propriedade io.timeout.millis está em milissegundos, o valor de 120 segundos é 120000.

    Os exemplos a seguir mostram como configurar o tempo limite de E/S na configuração do endpoint de destino do proxy de API:

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

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

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

    <TargetEndpoint name="default">
      <HTTPTargetConnection>
        <LoadBalancer>
          <Server name="target1" />
          <Server name="target2" />
        </LoadBalancer>
        <Properties>
          <Property name="io.timeout.millis">120000</Property>
        </Properties>
        <Path>/test</Path>
      </HTTPTargetConnection>
    </TargetEndpoint>
  5. Salve as mudanças feitas no proxy de API.

Configurar o tempo limite de E/S na política ServiceCallout do proxy de API

Esta seção explica como configurar o tempo limite de E/S na política ServiceCallout do seu proxy de API. O tempo limite de E/S pode ser configurado pelo elemento <Timeout> ou pela propriedade io.timeout.millis. O elemento <Timeout> e a propriedade io.timeout.millis representam os valores de tempo limite de E/S em milissegundos.

É possível configurar o tempo limite de E/S na política ServiceCallout usando um dos seguintes métodos:

  • <Timeout> elemento.
  • Propriedade io.timeout.millis.

Elemento de tempo limite

Para configurar o tempo limite de E/S na política ServiceCallout usando o <Timeout> elemento, faça o seguinte:

  1. Na interface do Edge, selecione o proxy de API específico em que você quer configurar o novo valor de tempo limite de E/S para a política ServiceCallout.
  2. Selecione a política ServiceCallout específica que você quer modificar.
  3. Adicione o elemento <Timeout> com um valor adequado na configuração <ServiceCallout>.

    Por exemplo, para mudar o tempo limite de E/S para 120 segundos, adicione a seguinte linha de código:

        <Timeout>120000</Timeout>

    Como o elemento <Timeout> está em milissegundos, o valor de 120 segundos é 120000.

    O exemplo a seguir mostra como configurar o tempo limite de E/S na política ServiceCallout usando o <Timeout> elemento:

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

    <ServiceCallout name="Service-Callout-1">
        <DisplayName>ServiceCallout-1</DisplayName>
        <Timeout>120000</Timeout>
        <HTTPTargetConnection>
            <Properties/>
            <URL>https://mocktarget.apigee.net/json</URL>
        </HTTPTargetConnection>
    </ServiceCallout>
  4. Salve as mudanças feitas no proxy de API.

Propriedade io.timeout.millis

Para configurar o tempo limite de E/S na política ServiceCallout usando a io.timeout.millis propriedade, faça o seguinte:

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

    Por exemplo, para mudar o tempo limite de E/S para 120 segundos, adicione o seguinte bloco de código:

        <Properties>
          <Property name="io.timeout.millis">120000</Property>
        </Properties>

    Como a propriedade io.timeout.millis está em milissegundos, o valor de 120 segundos é 120000.

    Os exemplos a seguir mostram como configurar o tempo limite de E/S na configuração do endpoint de destino do proxy de API:

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

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

    Exemplo de configuração de política ServiceCallout usando o servidor de destino

    <ServiceCallout enabled="true" name="Service-Callout-1">
        <DisplayName>ServiceCallout-1</DisplayName>
        <Response>calloutResponse</Response>
        <HTTPTargetConnection>
            <LoadBalancer>
                <Server name="target1" />
                <Server name="target2" />
            </LoadBalancer>
            <Properties>
                <Property name="io.timeout.millis">120000</Property>
            </Properties>
            <Path>/test</Path>
        </HTTPTargetConnection>
    </ServiceCallout>
  4. Salve as mudanças feitas no proxy de API.

Configurar o tempo limite de E/S em processadores de mensagens

Esta seção explica como configurar o tempo limite de E/S nos processadores de mensagens. O tempo limite de E/S pode ser configurado pela propriedade HTTPTransport.io.timeout.millis, que representa o valor do tempo limite de E/S 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 E/S nos processadores de mensagens, faça o seguinte:

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

    Por exemplo, para abrir o arquivo usando vi, insira o seguinte comando:

    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_HTTPTransport.io.timeout.millis=TIME_IN_MILLISECONDS

    Por exemplo, para mudar o tempo limite de E/S no processador de mensagens para 120 segundos, adicione a seguinte linha:

    conf_http_HTTPTransport.io.timeout.millis=120000
  3. Salve as alterações.
  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 em todos os processadores de mensagens.

Verificar o tempo limite de E/S nos processadores de mensagens

Esta seção explica como verificar se o tempo limite de E/S foi modificado com êxito nos Processadores de Mensagens.

Embora você use o token conf_http_HTTPTransport.io.timeout.millis para definir o tempo limite de E/S no processador de mensagens, é necessário verificar se a propriedade real HTTPTransport.io.timeout.millis foi definida com o novo valor.

  1. Na máquina do processador de mensagens, pesquise a propriedade HTTPTransport.io.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 "HTTPTransport.io.timeout.millis" /opt/apigee/edge-message-processor/conf
  2. Se o novo valor de tempo limite de E/S for definido com êxito no processador de mensagens, o comando acima mostrará o novo valor no arquivo http.properties.
  3. O resultado de amostra do comando acima depois de configurar o tempo limite de E/S para 120 segundos é o seguinte:

    /opt/apigee/edge-message-processor/conf/http.properties:HTTPTransport.io.timeout.millis=120000

    No exemplo de saída acima, observe que a propriedade HTTPTransport.io.timeout.millis foi definida com o novo valor 120000 em http.properties. Isso indica que o tempo limite de E/S foi configurado com êxito para 120 segundos no processador de mensagens.

  4. Se você ainda vir o valor antigo da propriedade HTTPTransport.io.timeout.millis, verifique se seguiu todas as etapas descritas em Configurar o tempo limite de E/S em processadores de mensagens corretamente. Se você perdeu alguma etapa, repita todas as etapas corretamente.
  5. Se você ainda não conseguir modificar o tempo limite de E/S, entre em contato com o suporte do Apigee Edge.

E agora?

Saiba mais sobre Configurar o tempo limite de E/S em roteadores