En esta página, se explican las diferencias entre usar la
API de Cloud Tasks para administrar las colas
y subir un archivo
queue.yaml
de Cloud Tasks para lograr los mismos fines. También se analizan algunos de los riesgos de mezclar los mecanismos y cómo solucionar los problemas más comunes.
Introducción
La API de Cloud Tasks ofrece una interfaz independiente de App Engine al servicio Task Queue de App Engine. Como parte de esa interfaz, proporciona la capacidad de administrar colas, incluso mediante la consola o el comando gcloud
. Las colas que se crean con la API de Cloud Tasks son accesibles desde el SDK de App Engine y viceversa. Para mantener la compatibilidad, es posible usar el archivo de configuración que usa el SDK de App Engine, queue.yaml
, para crear y configurar las colas que se usarán a través de la API de Cloud Tasks. Sin embargo, combinar la configuración mediante un archivo con la configuración a través de la API de Cloud Tasks puede producir consecuencias inesperadas.
Riesgos de mezclar queue.yaml
con los métodos de administración de colas de Cloud Tasks
Para el servicio subyacente, los archivos queue.yaml
son definitivos. Si subes un queue.yaml
que omite colas existentes de tu proyecto, sin importar cómo se las haya creado, esas colas se inhabilitan o pausan. Por lo tanto, si usas la API de Cloud Tasks para llamar a CreateQueue
o UpdateQueue
y, luego, subes un archivo queue.yaml
que los omite, las colas que se crearon en las llamadas de Cloud Tasks están inhabilitadas.
Considera la siguiente situación:
- Llama a
CreateQueue
para crear una cola llamada "cloud-tasks-queue". Crea un archivo
queue.yaml
con el siguiente contenido:queue: - name: queue-yaml-queue
¿Cuál es el estado actual de este proyecto? La cola llamada "cloud-tasks-queue" y cualquier otra cola que haya existido previamente quedan en estado DISABLED
, y la cola llamada "queue-yaml-queue" está en estado RUNNING
.
Este comportamiento puede resultar sorprendente si creas colas a través de la API de Cloud Tasks. En las instrucciones a continuación, se explica cómo reanudar una cola inhabilitada.
Del mismo modo, si una cola está inhabilitada en la API de Cloud Tasks, pero luego aparece en un archivo queue.yaml
que se subió, esa cola se reanuda.
Si se borra una cola con el método DeleteQueue
y, luego, aparece en un archivo queue.yaml
, la carga de queue.yaml
puede fallar, ya que los nombres de las colas no se pueden volver a usar durante varios días después de la eliminación.
prácticas recomendadas
Si es la primera vez que usas Cloud Tasks o App Engine, usa la API de Cloud Tasks
exclusivamente para administrar tus colas y evitar el uso de queue.yaml
por completo. Los métodos de administración de colas de Cloud Tasks le dan al usuario más opciones en cuanto a la creación, actualización y eliminación de colas.
Sin embargo, si ya eres usuario de queue.yaml
, solo deberías considerar cambiar a los métodos de administración de colas si comprendes los
desventajas de combinar queue.yaml
con los métodos de administración de colas de Cloud Tasks.
Para evitar que los usuarios mezclen métodos de administración de tareas, una opción es crear una aplicación web o una herramienta de línea de comandos que todos los usuarios deban usar para crear, actualizar y borrar colas. Si esa herramienta usa los métodos de administración
de colas de Cloud Tasks o queue.yaml
es un detalle de la implementación de la herramienta
por el que los usuarios no deben preocuparse. Si los usuarios deben usar la herramienta,
puedes garantizar que no se mezcle de forma involuntaria los
métodos de administración de colas de Cloud Tasks y el uso de queue.yaml
.
Para facilitar el uso de una herramienta de este tipo, puedes otorgarle funciones de administrador de colas a la herramienta y exigir que los usuarios se autentiquen para usarla. Para obtener más información sobre la administración de accesos, consulta Configuración de colas seguras.
Depuración
Puedes inspeccionar los registros de auditoría de actividad del administrador para recuperar el historial de cambios de configuración de colas, que incluye las operaciones de creación, actualización y eliminación de colas.
gcloud logging read \
'protoPayload.methodName=
(com.google.appengine.legacy.queue_created OR
com.google.appengine.legacy.queue_updated OR
google.cloud.tasks.v2.CloudTasks.CreateQueue OR
google.cloud.tasks.v2.CloudTasks.UpdateQueue OR
google.cloud.tasks.v2.CloudTasks.DeleteQueue)'
Por ejemplo, si se inhabilita una cola existente con la carga de un queue.yaml
, aparecerá el mensaje “Cola inhabilitada '[QUEUE_NAME]'” en el registro de auditoría a través del
método com.google.appengine.legacy.queue_updated
.
Cómo reanudar una cola inhabilitada con la carga de queue.yaml
Si mezclas queue.yaml
con los métodos de administración de colas de Cloud Tasks, subir un archivo queue.yaml
podría inhabilitar accidentalmente una cola creada a través de la API de Cloud Tasks.
Para reanudar la cola, puedes llamar a ResumeQueue
en la cola o agregarlo a queue.yaml
y subirlo. Ten en cuenta que, si antes configuraste un rate
de procesamiento personalizado en la configuración queue.yaml
de la cola, ResumeQueue
restablece la cola al valor predeterminado rate
. Esto se refleja en el campo maxDispatchesPerSecond
de la respuesta a ResumeQueue
.
Cuotas
Si usas queue.yaml
para crear tus colas de forma predeterminada, puedes crear un máximo de 100. Las colas creadas con la API de Cloud Tasks tienen un máximo predeterminado de 1,000. Al igual que en otros casos, la mezcla de los métodos de queue.yaml
y la API de Cloud Tasks puede generar resultados inesperados. Por ejemplo, supongamos que creas algunas colas con queue.yaml
y, luego, obtienes un aumento de la cuota de 2,000. Si, luego, usas el método de la API de Cloud Tasks para crear más colas, obtendrás errores de cuota. Para solucionar el problema, envía una solicitud mediante Editar cuotas en la página Cuotas de la consola de Google Cloud.
Información adicional sobre los métodos de administración de colas de Cloud Tasks
Configuración y demora en el inicio de las colas
Cuando se cambia la configuración de las colas, es posible que la modificación tarde varios minutos en aplicarse. Por ejemplo, después de llamar a CreateQueue
o UpdateQueue
, pueden pasar varios minutos antes de que puedas llamar correctamente a CreateTask
en esa cola.
Cloud Tasks y la cola default
de App Engine
La cola de App Engine denominada "default" recibe un tratamiento especial en el SDK de App Engine y en la API de Cloud Tasks.
Si la cola default
aún no existe, se creará en las siguientes situaciones:
- Cuando se agrega la primera tarea a la cola
default
mediante el SDK de App Engine. - Cuando se sube un archivo
queue.yaml
que especifica una coladefault
. - Cuando se llama a
CreateQueue
oUpdateQueue
para crear la coladefault
A fin de preservar la compatibilidad con App Engine, Cloud Tasks aplica las siguientes restricciones:
- Si se crea una cola llamada "default", debe ser una cola que use tareas de App Engine.
- Una vez creadas, los usuarios no pueden borrar la cola
default
.
En la API de Cloud Tasks, lo siguiente también se aplica a la cola default
:
- La API de Cloud Tasks no crea de forma automática la cola
default
ni ninguna otra. - Al igual que con cualquier otra cola, cuando se llama a
GetQueue
en la coladefault
, se produce un error no encontrado si se realiza la llamada antes de crear la cola. - De manera similar, la cola
default
no aparece en el resultado deListQueues
antes de su creación. - La configuración de la cola
default
se puede cambiar con la llamadaUpdateQueue
.
¿Qué sigue?
- Consulta los documentos de referencia para conocer los métodos disponibles en la API de RPC de Cloud Tasks.
- Consulta los métodos disponibles en la API de REST de Cloud Tasks en los documentos de referencia.
- Obtén más información sobre
queue.yaml
.