Configura el tiempo de espera de E/S en los routers

Estás viendo la documentación de Apigee Edge.
Ir a la documentación de Apigee X. info

En este documento, se explica cómo configurar el tiempo de espera de E/S en los routers de Apigee Edge.

El tiempo de espera de E/S en el router representa el tiempo durante el cual el router espera recibir una respuesta del Message Processor después de establecer la conexión y enviar la solicitud al Message Processor. El valor predeterminado del tiempo de espera de E/S en el router es de 57 segundos.

El tiempo de espera de E/S para los routers se puede aumentar o disminuir desde el valor predeterminado de 57 segundos según tus necesidades. Se puede configurar de las siguientes maneras:

  • En un host virtual
  • En el router

Las siguientes propiedades controlan el tiempo de espera de E/S en los routers:

Nombre de la propiedad Ubicación Descripción
proxy_read_timeout Host virtual

Especifica el tiempo máximo durante el cual el router espera recibir una respuesta del Message Processor después de establecer la conexión y enviar la solicitud al Message Processor.

Si no hay respuesta del Message Processor dentro de este período de tiempo de espera, se agota el tiempo de espera del router.

De forma predeterminada, esta propiedad toma el valor establecido para la conf_load_balancing_load.balancing.driver.proxy.read.timeout propiedad en el router. El valor predeterminado es 57 segundos.

Si esta propiedad se modifica con un nuevo valor de tiempo de espera para un host virtual específico, entonces solo se verán afectados los proxies de API que usen ese host virtual específico.

conf_load_balancing_load.balancing.driver.proxy.read.timeout Router

Especifica el tiempo máximo durante el cual el router espera recibir una respuesta del Message Processor después de establecer la conexión y enviar la solicitud al Message Processor.

Si no hay respuesta del Message Processor dentro de este período de tiempo de espera, se agota el tiempo de espera del router.

Esta propiedad se usa para todos los hosts virtuales en este router.

El valor predeterminado de esta propiedad es 57 segundos.

Puedes modificar esta propiedad como se explica en Configura el tiempo de espera de E/S en los routers a continuación o puedes anular este valor si estableces la propiedad proxy_read_timeout en el nivel del host virtual.

Puedes establecer el intervalo de tiempo para esta propiedad como algo que no sean segundos con la siguiente notación: 

ms: milliseconds
s:  seconds (default)
m:  minutes
h:  hours
d:  days
w:  weeks
M:  months (length of 30 days)
y:  years (length of 365 days)
conf_load_balancing_load.balancing.driver.nginx.upstream_next_timeout Router

Especifica el tiempo total que el router espera para recibir una respuesta de todos los procesadores de mensajes después de establecer la conexión y enviar la solicitud a cada procesador de mensajes.

Esto se aplica cuando tu instalación de Edge tiene varios procesadores de mensajes y se habilita el reintento cuando se producen errores. Tiene el valor de uno de los siguientes:

  • El valor actual de conf_load_balancing_load.balancing.driver.proxy.read.timeout
  • El valor predeterminado de 57 segundos

Al igual que con la propiedad conf_load_balancing_load.balancing.driver.proxy.read.timeout, puedes especificar intervalos de tiempo que no sean los predeterminados (segundos).

Antes de comenzar

Antes de usar los pasos de este documento, asegúrate de comprender los siguientes temas:

Configura el tiempo de espera de E/S en el host virtual

En esta sección, se explica cómo configurar el tiempo de espera de E/S en el host virtual asociado con una organización y un entorno. El tiempo de espera de E/S se puede configurar en el host virtual a través de la propiedad proxy_read_timeout, que representa el valor del tiempo de espera de E/S en segundos.

Puedes configurar el host virtual con uno de los siguientes métodos:

  • IU de Edge
  • API de Edge

IU de Edge

Para configurar el host virtual con la IU de Edge, haz lo siguiente:

  1. Accede a la IU de Edge.
  2. Navega a Administrador > Hosts virtuales.
  3. Selecciona un entorno específico en el que deseas realizar este cambio.
  4. Selecciona el host virtual específico para el que deseas configurar el nuevo valor de tiempo de espera de E/S.
  5. En Propiedades, actualiza el valor de Tiempo de espera de lectura del proxy en segundos.

    Por ejemplo, si deseas cambiar el tiempo de espera a 120 segundos, escribe 120 como se muestra en la siguiente figura:

    Valor de tiempo de espera de lectura del proxy de 120

  6. Guarda el cambio.

API de Edge

Para configurar el host virtual con la API de Edge, haz lo siguiente:

  1. Obtén la configuración actual del host virtual con la API de Get virtual host como se muestra a continuación:

    Usuario de la nube pública 

    curl -v -X GET https//api.enterprise.apigee.com/v1/organizations/{organization-name}/environments/{environment-name}/virtualhosts/{virtualhost-name} -u <username>

    Usuario de la nube privada 

    curl -v -X GET http://<management-host>:<port #>/v1/organizations/{organization-name}/environments/{environment-name}/virtualhosts/{virtualhost-name} -u <username>

    Donde:

    {organization-name} es el nombre de la organización.

    {environment-name} es el nombre del entorno.

    {virtualhost-name} es el nombre del host virtual.

    Configuración de virtualhost de muestra 

        {
      "hostAliases": [
        "api.myCompany,com"
      ],
      "interfaces": [],
      "listenOptions": [],
      "name": "secure",
      "port": "443",
      "retryOptions": [],
      "sSLInfo": {
        "ciphers": [],
        "clientAuthEnabled": "false",
        "enabled": "true",
        "ignoreValidationErrors": false,
        "keyAlias": "myCompanyKeyAlias",
        "keyStore": "ref://myCompanyKeystoreref",
        "protocols": []
      },
      "useBuiltInFreeTrialCert": false
    }
  2. Agrega la propiedad proxy_read_timeout a la carga útil JSON de configuración del host virtual existente en properties con el valor en segundos.

    Por ejemplo, para cambiar el tiempo de espera de E/S a 120 segundos, agrega el properties bloque de código como se muestra a continuación:

    Configuración de host virtual actualizada de muestra 

    {
  "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
}
  3. Guarda la configuración de host virtual actualizada en un archivo. Por ejemplo, virtualhost-payload.json.
  4. Actualiza la configuración de virtualhost con el cambio usando la Update a virtual host API de la siguiente manera:

    Usuario de la nube pública 

    curl -v -X POST Content-Type: application/json
https://api.enterprise.apigee.com/v1/organizations/{organization-name}/environments/{environment-name}/virtualhosts/{virtualhost-name} -d @virtualhost-payload.json -u <username>

    Usuario de la nube privada 

    curl -v -X POST Content-Type: application/json
http://<management-host>:<port #>/v1/organizations/{organization-name}/environments/{environment-name}/virtualhosts/{virtualhost-name} -d @virtualhost-payload.json -u <username>

    Donde:

    {organization-name} es el nombre de la organización.

    {environment-name} es el nombre del entorno.

    {virtualhost-name} es el nombre del host virtual.

Verifica el tiempo de espera de E/S en los hosts virtuales

En esta sección, se explica cómo verificar que el tiempo de espera de E/S se haya modificado correctamente en el host virtual con la API de Edge.

  1. Ejecuta la API de Get virtual host para obtener la virtualhost configuración como se muestra a continuación:

    Usuario de la nube pública 

    curl -v -X GET https://api.enterprise.apigee.com/v1/organizations/{organization-name}/environments/{environment-name}/virtualhosts/{virtualhost-name} -u <username>

    Usuario de la nube privada 

    curl -v -X GET http://<management server-host>:<port #>/v1/organizations/{organization-name}/environments/{environment-name}/virtualhosts/{virtualhost-name} -u <username>

    Donde:

    {organization-name} es el nombre de la organización.

    {environment-name} es el nombre del entorno.

    {virtualhost-name} es el nombre del host virtual.

  2. Verifica que la propiedad proxy_read_timeout se haya establecido en el valor nuevo.

    Configuración de host virtual actualizada de muestra 

    {
  "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
}

    En el ejemplo anterior, observa que proxy_read_timeout se estableció con el valor nuevo de 120 segundos.

  3. Si aún ves el valor anterior de proxy_read_timeout,verifica que hayas seguido correctamente todos los pasos descritos en Configura el tiempo de espera de E/S en el host virtual. Si omitiste algún paso, repite todos los pasos correctamente.
  4. Si aún no puedes modificar el tiempo de espera de E/S, comunícate con el equipo de asistencia de Apigee Edge.

Configura el tiempo de espera de E/S en los routers

En esta sección, se explica cómo configurar el tiempo de espera de E/S en los routers. El tiempo de espera de E/S se puede configurar a través de la propiedad del router conf_load_balancing_load.balancing.driver.proxy.read.timeout, que representa el valor del tiempo de espera de E/S en segundos.

Para configurar el tiempo de espera de E/S en los routers, haz lo siguiente:

  1. En la máquina del router, abre el siguiente archivo en un editor. Si aún no existe, créalo. 
    /opt/apigee/customer/application/router.properties

    Por ejemplo, para abrir el archivo con vi, ingresa el siguiente comando: 

    vi /opt/apigee/customer/application/router.properties
  2. Agrega una línea en el siguiente formato al archivo properties y sustituye un valor por time_in_seconds: 
    3. conf_load_balancing_load.balancing.driver.proxy.read.timeout=time_in_seconds

    Por ejemplo, para cambiar el tiempo de espera de E/S en el router a 120 segundos, agrega la siguiente línea: 

    conf_load_balancing_load.balancing.driver.proxy.read.timeout=120

    También puedes modificar el tiempo de espera de E/S en minutos. Por ejemplo, para cambiar el tiempo de espera a dos minutos, agrega la siguiente línea: 

    conf_load_balancing_load.balancing.driver.proxy.read.timeout=2m
  3. Guarda los cambios.
  4. Asegúrate de que este archivo de propiedades sea propiedad del usuario apigee como se muestra a continuación: 
    chown apigee:apigee /opt/apigee/customer/application/router.properties
  5. Reinicia el router como se muestra a continuación: 
    /opt/apigee/apigee-service/bin/apigee-service edge-router restart
  6. Si tienes más de un router, repite los pasos anteriores en todos los routers.

Verifica el tiempo de espera de E/S en los routers

En esta sección, se explica cómo verificar que el tiempo de espera de E/S se haya modificado correctamente en los routers.

Aunque uses el token conf_load_balancing_load.balancing.driver.proxy.read.timeout para establecer el tiempo de espera de E/S en el router, debes verificar si la propiedad real proxy_read_timeout se estableció con el valor nuevo.

  1. Busca la propiedad proxy_read_timeout en el /opt/nginx/conf.d directorio y verifica si se estableció con el valor nuevo de la siguiente manera: 
    grep -ri "proxy_read_timeout" /opt/nginx/conf.d
  2. Si el nuevo valor de tiempo de espera de E/S se establece correctamente en el router, el comando anterior muestra el valor nuevo en todos los archivos de configuración del host virtual.

    El siguiente es el resultado de muestra del comando grep anterior cuando el tiempo de espera de E/S es de 120 segundos: 

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

    En el resultado de ejemplo anterior, observa que la propiedad proxy_read_timeout se estableció con el valor nuevo 120 en 0-default.conf que es el archivo de configuración del host virtual predeterminado. Esto indica que el tiempo de espera de E/S se configuró correctamente en 120 segundos en el router.

  3. Si aún ves el valor anterior de la propiedad proxy_read_timeout, entonces verifica que hayas seguido correctamente todos los pasos descritos en Configura el tiempo de espera de E/S en los routers. Si omitiste algún paso, repite todos los pasos correctamente.
  4. Si aún no puedes modificar el tiempo de espera de E/S, comunícate con el equipo de asistencia de Apigee Edge.

Próximos pasos

Obtén información para configurar el tiempo de espera de E/S en el procesador de mensajes.