Referencia queue.xml

Las aplicaciones que utilizan el SDK de App Engine para administrar las listas de tareas en cola definen estas colas mediante un archivo de configuración denominado queue.xml. Para las apps en Java, este archivo se almacena en el directorio WEB-INF de la aplicación. Puedes utilizar queue.xml para configurar tanto las listas de aplicaciones en cola como las listas de extracción. Este archivo de configuración es opcional para las listas de aplicaciones en cola, las que tienen una cola predeterminada. Las listas de extracción deben configurarse específicamente en queue.xml.

Ejemplo

A continuación, se incluye un ejemplo básico que define un cola nombrada y anula la frecuencia de procesamiento predeterminada:

<queue-entries>
  <queue>
    <name>my-push-queue</name>
    <rate>1/s</rate>
  </queue>
</queue-entries>

El siguiente es un ejemplo más complejo de una configuración queue.xml que demuestra la configuración de la cantidad de intentos de tareas y la modificación de la frecuencia de procesamiento predeterminada.

<queue-entries>
  <queue>
    <name>fooqueue</name>
    <rate>1/s</rate>
    <retry-parameters>
      <task-retry-limit>7</task-retry-limit>
      <task-age-limit>2d</task-age-limit>
    </retry-parameters>
  </queue>
  <queue>
    <name>barqueue</name>
    <rate>1/s</rate>
    <retry-parameters>
      <min-backoff-seconds>10</min-backoff-seconds>
      <max-backoff-seconds>200</max-backoff-seconds>
      <max-doublings>0</max-doublings>
    </retry-parameters>
  </queue>
  <queue>
    <name>bazqueue</name>
    <rate>1/s</rate>
    <retry-parameters>
      <min-backoff-seconds>10</min-backoff-seconds>
      <max-backoff-seconds>200</max-backoff-seconds>
      <max-doublings>3</max-doublings>
    </retry-parameters>
  </queue>
</queue-entries>

Sintaxis

El archivo queue.xml es un archivo XML cuyo elemento raíz es <queue-entries>. Esta directiva puede contener cero o más colas especificadas en los elementos <queue>. Cada definición de cola puede especificar los siguientes elementos:

Elemento Descripción
<bucket-size> (listas de aplicaciones en cola)

Opcional: Una lista de tareas en cola utiliza el algoritmo de depósito de token para controlar la frecuencia de ejecución de la tarea. Cada cola nombrada tiene un depósito de token que puede contener una cantidad de tokens igual al máximo especificado por el valor bucket_size. Cada vez que tu aplicación ejecuta una tarea, se quita un token del depósito. Continúas procesando las tareas en la cola hasta que el depósito de la cola se queda sin tokens. App Engine rellena el depósito con tokens nuevos de forma continua según la frecuencia que hayas especificado para la cola.

El tamaño del depósito limita la rapidez con la que se procesa la cola cuando existen muchas tareas en cola y la frecuencia es alta. El valor máximo para el tamaño del depósito es de 500. Esto te permite tener una frecuencia alta, por lo que el procesamiento comienza poco después de que se pone una tarea en cola; aun así, limita el uso de recursos cuando muchas tareas se ponen en cola en un período corto de tiempo.

Si no especificas el bucket_size para una cola, el valor predeterminado es de 5. Te recomendamos establecer ese valor en un valor mayor porque el tamaño predeterminado podría ser demasiado pequeño para muchos casos prácticos: el tamaño recomendado es la frecuencia de procesamiento dividida por 5 (frecuencia/5).

<max-concurrent-requests> (listas de aplicaciones en cola)

Opcional: Establece la cantidad máxima de tareas que pueden ejecutarse de manera simultánea desde la cola especificada. El valor es un número entero. De manera predeterminada, el límite es de 1,000 tareas por cola. El límite superior recomendado es de 5,000 tareas por cola. Ten en cuenta que las colas pueden avanzar lentamente cuando se crean por primera vez o si han estado inactivas durante un tiempo.

La restricción de la cantidad de tareas simultáneas te brinda más control sobre la frecuencia de ejecución de la cola y puede evitar que se ejecuten demasiadas tareas a la vez. También puede evitar la contención del almacén de datos y hacer que los recursos estén disponibles para otras colas o el procesamiento en línea.

<mode>

Opcional: Identifica el modo de la cola. El valor predeterminado para esta configuración es push, que identifica una cola como una lista de aplicaciones en cola. Si deseas utilizar listas de extracción, configura el modo en pull.

<name>

Obligatorio El nombre de la cola. Este es el nombre que especificas cuando llamas a QueueFactory.getQueue().

Un nombre de cola puede contener letras mayúsculas y minúsculas, números y guiones. La longitud máxima para un nombre de cola es de 100 caracteres.

Todas las apps tienen una lista de aplicaciones en cola con un nombre predeterminado. Esta cola tiene una frecuencia de ajuste predeterminado de 5 tareas por segundo, pero puedes cambiar esta frecuencia; para ello, define una cola predeterminada en queue.xml. Si no configuras una cola predeterminada en queue.xml, la cola predeterminada no se muestra en Google Cloud Platform Console hasta que se utiliza por primera vez. Puedes personalizar la configuración para esta cola; para ello, define una cola con el nombre default.

<rate> (listas de aplicaciones en cola)

Obligatorio Con qué frecuencia se procesan las tareas en esta cola. El valor es un número seguido por una barra y una unidad de tiempo, donde la unidad es s para los segundos, m para los minutos, h para las horas o d para los días. Por ejemplo, el valor 5/m indica que las tareas se procesarán con una frecuencia de 5 veces por minuto. El valor máximo para rate es 500/s.

Si el número es 0 (como en 0/s), la cola se considera "pausada" y no se procesan tareas.

<retry-parameters>

Opcional: Configura los reintentos para las tareas con errores en las listas de aplicaciones en cola. Esta adición te permite especificar la cantidad máxima para reintentar las tareas con errores en una cola específica. También puedes establecer un límite de tiempo para los reintentos y controlar el intervalo entre intentos.

Los parámetros de reintento pueden contener los siguientes subelementos:

<task-retry-limit>
Esto es en realidad un límite general en la cantidad máxima de reintentos para una tarea. Si se especifica 0 o 1 y la tarea falla, no se reintenta la tarea en absoluto. Si se especifica con task_age_limit, se reintenta la tarea hasta que se hayan alcanzado ambos límites. Si no se especifica este parámetro, la tarea se reintenta indefinidamente.
<task-age-limit> (listas de aplicaciones en cola)
El límite de tiempo para reintentar una tarea con errores, medido desde la primera ejecución de la tarea. El valor es un número seguido por una unidad de tiempo, donde la unidad es s para los segundos, m para los minutos, h para las horas o d para los días. Por ejemplo, el valor 5d especifica un límite de cinco días después del primer intento de ejecución de la tarea. Si no se especifica este parámetro, la tarea se reintenta indefinidamente. Si se especifica con task_retry_limit, App Engine reintenta la tarea hasta que se hayan alcanzado ambos límites.
<min-backoff-seconds> (listas de aplicaciones en cola)
La cantidad mínima de segundos que se espera antes de reintentar una tarea que falla. El valor predeterminado es 0.1.
<max-backoff-seconds> (listas de aplicaciones en cola)
La cantidad máxima de segundos que se espera antes de reintentar una tarea que falla. El valor predeterminado es 3600.
<max-doublings> (listas de aplicaciones en cola)
La cantidad máxima de veces que se puede reintentar el intervalo entre tareas con errores se duplicará antes de que el aumento se vuelva constante. La constante es: 2**max_doublings * min_backoff_seconds. El valor predeterminado es 16.
<target> (listas de aplicaciones en cola)

Opcional: Una string que da nombre a un servicio o una versión, una versión frontend o un backend, donde se ejecutarán todas las tareas puestas en cola para esta cola. El valor predeterminado es una string vacía.

La string se agrega al nombre del dominio de tu app cuando se compila la solicitud HTTP para una tarea. Por ejemplo, si el ID de tu app es my-app y configuras el destino en my-version.my-service, el nombre de host de la URL se establecerá en my-version.my-service.my-app.appspot.com.

Si no se especifica el destino, las tareas se invocan en la misma versión de la aplicación donde se pusieron en cola. Por lo tanto, si pusiste en cola una tarea desde la versión predeterminada de la aplicación sin especificar un destino en la cola, la tarea se invoca en la versión predeterminada de la aplicación. Ten en cuenta que si la versión predeterminada de la aplicación cambia entre el momento en que la tarea se pone en cola y el momento en que se ejecuta, la tarea se ejecutará en la versión predeterminada nueva.

Si utilizas servicios junto con un archivo de despacho, la solicitud HTTP de tu tarea podría ser interceptada y reenviada a otro servicio.

Los siguientes elementos pueden especificarse para todas las colas dentro de una app dentro del elemento raíz <queue-entries>:

Elemento Descripción
<total-storage-limit>

Opcional: Una string que anula el límite de almacenamiento de cuota predeterminado disponible para el almacenamiento taskqueue (100 M). Por ejemplo:


<queue-entries>
  <total-storage-limit>1.2G</total-storage-limit>
  <queue>
    <name>fooqueue</name>
  </queue>
</queue-entries>

Esta cuota es parte de la cuota de almacenamiento total de la aplicación (incluidas las cuotas del almacén de datos y de blobstore).

Si no se especifica ningún sufijo, el número que especificas se interpretará como bytes. Se admiten los siguientes sufijos:

  • B (bytes)
  • K (kilobytes)
  • M (megabytes)
  • G (gigabytes)
  • T (terabytes)

Si <total-storage-limit> supera el almacenamiento total del disco que está disponible para una aplicación, el límite se redondea.

Cómo implementar el archivo de configuración de cola

El archivo queue.xml debe encontrarse en el directorio WEB-INF del servicio predeterminado.

Para implementar el archivo de configuración de colas en el almacén de datos sin alterar la versión actual del servidor, usa el siguiente comando:

appcfg.sh update_queues <application directory>

reemplazando <application directory> con la ruta hacia el directorio principal de tu aplicación.

Cómo borrar colas

Para borrar una cola:

  1. Quita la definición de la cola de tu archivo queue.xml.

  2. Sube el cambio a tu archivo queue.xml.

    [PATH_TO_APP_ENGINE_SDK]\bin\appcfg.sh update_queues [YOUR_APP_DIR]
    

    o en Windows:

    [PATH_TO_APP_ENGINE_SDK]\bin\appcfg.cmd update_queues [YOUR_APP_DIR]
    
  3. Borra la cola en GCP Console, selecciona la cola y haz clic en Borrar cola:

    Ir a la página de listas de tareas en cola

Si borras una cola de GCP Console, debes esperar 7 días antes de volver a crearla con el mismo nombre.

¿Te ha resultado útil esta página? Enviar comentarios:

Enviar comentarios sobre...

Entorno estándar de App Engine para Java