Migra listas de aplicaciones en cola a Cloud Tasks (Go)

Antes de actualizar a la versión más reciente del SDK de los servicios de App Engine, revisa la descripción general de la migración.

Actualiza a las bibliotecas cliente de Cloud Tasks

Si prefieres dejar de usar los servicios agrupados en paquetes heredados por completo, puedes migrar tu código para usar la API de Cloud Tasks directamente. Esto requiere refactorizar el código de tu aplicación.

Con Cloud Tasks, puedes acceder al mismo servicio al que accedes con la API de RPC de las listas de tareas en cola. Esto significa que no necesitas volver a crear tus listas y tareas de aplicaciones en cola existentes. Sin embargo, debes migrar el código que crea las listas o tareas de aplicaciones en cola o que interactúa con ellas para usar la API de Cloud Tasks.

Puedes crear tareas y listas de aplicaciones en cola y, además, interactuar con ellas mediante las API de REST y de RPC de Cloud Tasks, la biblioteca cliente de Cloud Tasks , Google Cloud CLI y la Google Cloud consola. En esta página, se proporcionan ejemplos mediante la gcloud CLI y la biblioteca cliente de Cloud Tasks.

Funciones no disponibles en Cloud Tasks

Para la migración de las bibliotecas cliente de Cloud Tasks, las siguientes funciones no están disponibles en Cloud Tasks:

  • Agregar tareas en cola en las transacciones de Datastore
  • Usar la biblioteca de tarea diferida en lugar de un servicio de trabajador
  • Trabajar con tareas en aplicaciones multiusuario
  • Simular con el servidor de desarrollo local
  • Agrega tareas de manera asíncrona

Como alternativa, si actualizas al SDK más reciente, las funciones como las tareas diferidas, los espacios de nombres y la simulación local se admiten a través del wrapper del SDK.

Precios y cuotas

Migrar las listas de aplicaciones en cola a Cloud Tasks puede afectar los precios y las cuotas de tu app.

Precios

Revisa los precios de Cloud Tasks para calcular tu costo mensual antes de la migración.

Al igual que con las listas de tareas en cola, enviar solicitudes a tu app de App Engine con un destino de envío de Cloud Tasks es gratis. Sin embargo, a diferencia de las listas de tareas en cola, Cloud Tasks cobra por la operación realizada, como crear, borrar o administrar tareas. Esto puede generar un costo mensual general más alto en comparación con la lista de tareas en cola de App Engine complementaria.

Cuotas

Las solicitudes de Cloud Tasks también se incluyen en las cuotas de solicitudes de App Engine.

Al igual que las listas de tareas en cola, Cloud Tasks tiene cuotas específicas del servicio. Es probable que la migración a Cloud Tasks cambie tus cuotas.

Antes de comenzar

En las siguientes secciones, se analizan los pasos de configuración antes de migrar las listas de aplicaciones en cola a Cloud Tasks.

Migra listas de extracción

Antes de comenzar, migra las listas de extracción antes de seguir las instrucciones de esta guía para migrar las listas de aplicaciones en cola. No se recomienda migrar las listas de extracción después de migrar las listas de aplicaciones en cola, ya que es probable que el uso obligatorio del archivo queue.yaml genere un comportamiento inesperado con Cloud Tasks.

Protege la configuración de las colas

Una vez que comienzas el proceso de migración a Cloud Tasks, modificar tu archivo queue.yaml puede generar un comportamiento inesperado y no se recomienda. Protege tu configuración de cola ante las modificaciones mediante el archivo queue.yaml con los siguientes pasos.

  1. Configura gcloud CLI para omitir el archivo queue.yaml en implementaciones futuras.

    Agrega el archivo queue.yaml a un .gcloudignore archivo. Para verificar si ya tienes un archivo .gcloudignore, puedes ejecutar el siguiente comando en tu terminal desde el directorio de nivel superior de la app. Con este comando, se mostrará el nombre del archivo si existe.

    ls -a | grep .gcloudignore

    Para obtener más información sobre los archivos .gcloudignore, consulta la referencia de .gcloudignore.

  2. Restringe los permisos en tu archivo queue.yaml.

    Sigue las prácticas recomendadas que se describen en nuestra guía Protege la configuración de las colas.

  3. Obtén información sobre Cloud Tasks y el archivo queue.yaml (opcional).

    Cuando usas la API de Cloud Tasks para administrar la configuración de las colas, la implementación de un archivo queue.yaml anula la configuración que estableció Cloud Tasks, lo que puede causar un comportamiento inesperado. Lee Usa la administración de colas en lugar de queue.yaml para obtener más información.

Autentica la app en la API de Cloud Tasks

Debes autenticar la app en la API de Cloud Tasks. En esta sección, se analiza la autenticación para dos casos de uso diferentes.

Para desarrollar o probar la app de forma local, te recomendamos usar una cuenta de servicio. Si deseas obtener instrucciones para configurar una cuenta de servicio y conectarla a la app, lee Obtén y proporciona las credenciales de cuenta de servicio de forma manual.

Para implementar la app en App Engine, no necesitas proporcionar ninguna autenticación nueva. Las credenciales predeterminadas de la aplicación (ADC) infieren los detalles de autenticación para las apps de App Engine.

Importa las bibliotecas cliente de Cloud

Para usar la biblioteca cliente de Cloud Tasks con tu app de App Engine, sigue estos pasos:

  1. Descarga la dependencia de la biblioteca cliente de Cloud Tasks:

    go get cloud.google.com/go/cloudtasks/apiv2

  2. Importa las dependencias de la biblioteca cliente de Cloud Tasks en los archivos que son responsables de crear y poner en cola tus tareas:

    import (
  "context"
  "fmt"

  cloudtasks "cloud.google.com/go/cloudtasks/apiv2"
  taskspb "cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb"
)

Crea y administra las colas

En esta sección, se describe cómo crear y administrar las colas mediante la API de Cloud Tasks.

Con Cloud Tasks, no usas un archivo queue.yaml para crear o administrar colas. En su lugar, debes usar la API de Cloud Tasks. No se recomienda usar un archivo queue.yaml y la API de Cloud Tasks, pero podría ser una parte inevitable de la migración de las listas de tareas en cola a Cloud Tasks según la app. Lee Usa la administración de colas en lugar de queue.yaml para obtener información sobre las prácticas recomendadas.

Crea colas

Lee esta sección si la app crea colas de manera programática o si deseas crear colas adicionales desde la línea de comandos.

En Cloud Tasks, los nombres de las colas tienen el formato projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID. La LOCATION_ID parte del nombre de la cola corresponde a una Google Cloud región. La parte QUEUE_ID del nombre de la cola es equivalente al campo name de una cola de la lista de tareas en cola. El nombre de la cola se genera durante la creación de la cola en función del proyecto, la región y el QUEUE_ID que especifiques.

En general, la ubicación de la cola (es decir, la región) debe ser la misma que la región de la app. Las dos excepciones a esta regla son para las apps que usan la región europe-west y las que usan la región us-central. En Cloud Tasks, estas regiones se llaman europe-west1 y us-central1, respectivamente.

Puedes especificar la configuración opcional de la cola durante su creación, pero también puedes hacerlo si actualizas la cola después de crearla.

No es necesario volver a crear colas existentes. En su lugar, lee las partes pertinentes de esta guía para migrar el código que interactúa con las colas existentes.

Vuelve a usar nombres de colas

Después de borrar una cola, debes esperar 7 días para crear otra con el mismo ID en el mismo proyecto y la misma ubicación (es decir, región).

En el siguiente ejemplo, se crean dos colas mediante Cloud Tasks. La primera cola tiene el ID de cola queue-blue y está configurada para enviar todas las tareas a la versión v2 del servicio task-module con una frecuencia de 5/s. La segunda cola tiene el ID de cola queue-red y envía las tareas con una frecuencia de 1/s. Ambas se crean en el proyecto con el ID del proyecto en la ubicación us-central1. Este es el equivalente de Cloud Tasks a crear colas en las listas de tareas en cola.

gcloud

Gcloud CLI infiere el proyecto y la ubicación a partir de la configuración de gcloud CLI.

gcloud tasks queues create queue-blue \
    --max-dispatches-per-second=5 \
    --routing-override=service:task-module,version:v2
 
gcloud tasks queues create queue-red \
    --max-dispatches-per-second=1

Para obtener más información, consulta la referencia de Cloud Tasks Crea una cola de Cloud Tasks queue.

Configura la frecuencia de procesamiento de la cola

En la siguiente tabla, se enumeran los campos de las listas de tareas en cola que difieren de los de Cloud Tasks.

Campo de listas de tareas en cola Campo de Cloud Tasks Descripción
rate max_dispatches_per_second La frecuencia máxima con la que se envían las tareas desde la cola
max_concurrent_requests max_concurrent_dispatches La cantidad máxima de tareas simultáneas que se pueden enviar desde la cola
bucket_size max_burst_size

Cloud Tasks calcula una propiedad max_burst_size solo de GET que limita la rapidez con la que se procesan las tareas en la cola según el valor de max_dispatches_per_second. Este campo permite que la cola tenga una frecuencia alta para que el procesamiento se inicie poco después de poner la tarea en cola, pero limita el uso de recursos cuando muchas tareas se ponen en cola durante un período corto.

Para las colas de App Engine que se crearon o actualizaron con un archivo, max_burst_size es inicialmente igual a bucket_size. Sin embargo, si la cola se pasa más tarde a un comando update mediante cualquier interfaz de Cloud Tasks, max_burst_size se restablecerá según el valor de max_dispatches_per_second, sin importar si se actualizó max_dispatches_per_second.

total_storage_limit Obsoleto en Cloud Tasks Cloud Tasks no admite la configuración de un límite de almacenamiento personalizado

Puedes configurar la frecuencia de procesamiento de la cola cuando la crees o puedes actualizarla después. En el siguiente ejemplo, se usa Cloud Tasks para establecer la frecuencia de procesamiento en una cola llamada queue-blue que ya se creó. En el siguiente ejemplo, se restablece max_burst_size según el valor max_dispatches_per_second de 20 si se creó o configuró queue-blue con un archivo queue.yaml. Este es el equivalente de Cloud Tasks de establecer la frecuencia de procesamiento de colas en las listas de tareas en cola.

gcloud

gcloud tasks queues update queue-blue \
    --max-dispatches-per-second=20 \
    --max-concurrent-dispatches=10

Para obtener más información, consulta Define los límites de frecuencia.

Inhabilita y reanuda colas

Cloud Tasks usa el término pausar de la misma manera que las listas de tareas en cola usan el término inhabilitar. Pausar una cola detiene la ejecución de las tareas de la cola hasta que se reanude. Sin embargo, puedes seguir agregando tareas a una cola que está en pausa. En Cloud Tasks se usa el término reanudar de la misma manera que en la lista de tareas en cola.

En el siguiente ejemplo, se pausa una cola con el ID queue1. Este es el equivalente de Cloud Tasks a inhabilitar colas en las listas de tareas en cola.

gcloud

gcloud tasks queues pause queue1

Para obtener más información, lee la referencia de Cloud Tasks Pausa colas.

Borra colas

Una vez que borres una cola, debes esperar 7 días antes de crear una con el mismo nombre. Se recomienda que borres definitivamente todas las tareas de una cola y vuelvas a configurarla si no puedes esperar 7 días.

En el siguiente ejemplo, se borra la cola con el ID queue1. Este es el equivalente de Cloud Tasks a borrar colas en las listas de tareas en cola.

gcloud

gcloud tasks queues delete queue1

Para obtener más información, lee la referencia de Cloud Tasks Borra colas.

Crea y administra tareas

En esta sección, se describe cómo crear y administrar tareas con la API de Cloud Tasks.

Crea tareas

En la siguiente tabla, se enumeran los campos de las listas de tareas en cola que difieren de los de Cloud Tasks.

Campo de listas de tareas en cola Campo de Cloud Tasks Descripción
N/A app_engine_http_request Crea una solicitud que se orienta a un servicio de App Engine. Estas tareas se denominan tareas de App Engine.
method http_method Especifica el método de solicitud, por ejemplo, POST
url relative_uri Especifica el controlador de tareas. Ten en cuenta la diferencia en la letra final: i para el identificador uniforme de recursos en lugar de l en localizador uniforme de recursos.
target app_engine_routing Opcional. Especifica el service, la version y la instance para una tarea de App Engine. Si no se establece, se usan la instancia, la versión y el servicio predeterminados.

En el siguiente ejemplo, se crea una tarea que se enruta al controlador /update_counter en el servicio predeterminado de App Engine. Este es el equivalente de Cloud Tasks a crear tareas en las listas de tareas en cola.

gcloud

gcloud tasks create-app-engine-task \
    --queue=default \
    --method=POST \
    --relative-uri=/update_counter \
    --routing=service:worker \
    --body-content=10

Para obtener más información, consulta la referencia de Cloud Tasks Crea tareas de App Engine.

Especifica el servicio de destino y el enrutamiento

Especificar el servicio, la versión y la instancia de destino de App Engine para las tareas de App Engine es opcional. De forma predeterminada, las tareas de App Engine se enrutan al servicio, la versión y la instancia que son los predeterminados en el momento en que se intenta realizar la tarea.

Configura la propiedad app_engine_routing de la tarea durante su creación a fin de especificar un servicio, una versión o una instancia de App Engine diferentes para la tarea.

Si quieres enrutar todas las tareas de una cola determinada al mismo servicio, instancia o versión de App Engine, puedes establecer la propiedad app_engine_routing_override en la cola.

Para obtener más información, lee la referencia Configura el enrutamiento de Cloud Tasks.

Pasa datos al controlador

Al igual que con las listas de tareas en cola, puedes pasar datos al controlador de dos maneras con Cloud Tasks. Puedes pasar datos como parámetros de consulta en el URI relativo o puedes pasar los datos en el cuerpo de la solicitud mediante los métodos HTTP POST o PUT.

Cloud Tasks usa el término cuerpo de la misma manera que las listas de tareas en cola usan el término carga útil. En Cloud Tasks, el tipo de contenido del cuerpo predeterminado es octet-stream en lugar de texto sin formato. Puedes configurar el tipo de contenido del cuerpo si lo especificas en el encabezado.

En el siguiente ejemplo, se pasa una clave al controlador /update_counter de dos maneras diferentes. Este es el equivalente de Cloud Tasks a pasar datos al controlador en las listas de tareas en cola.

gcloud

gcloud tasks create-app-engine-task \
    --queue=default \
    --method=GET  \
    --relative-uri=/update_counter?key=blue \
    --routing=service:worker
 
gcloud tasks create-app-engine-task \
    --queue=default \
    --method=POST \
    --relative-uri=/update_counter \
    --routing=service:worker \
    --body-content="{'key': 'blue'}"

Especifica el nombre de la tarea

Es opcional especificar el nombre de la tarea. Si no especificas el nombre de la tarea, Cloud Tasks lo crea por ti; para ello, genera un ID de tarea y, además, infiere el proyecto y la ubicación (es decir, la región) según la cola que especificaste durante la creación de la tarea.

Los nombres de las tareas tienen el formato projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID. La parte TASK_ID del nombre de la tarea es equivalente al campo name de la lista de tareas en cola.

Vuelve a usar nombres de tareas

Debes esperar antes de volver a usar el nombre de una tarea. El tiempo que debes esperar antes de hacerlo depende de si la cola que envía la tarea se creó en Cloud Tasks o en las listas de tareas en cola.

Para las tareas en colas que se crearon mediante las listas de tareas en cola (incluida la cola predeterminada), debes esperar alrededor de 9 días después de que se borre o ejecute la tarea original. Para las tareas en colas que se crearon con Cloud Tasks, debes esperar alrededor de 1 hora después de que se borre o ejecute la tarea original.

En el siguiente ejemplo, se crea una tarea con el TASK_ID configurado como first-try y se agrega a la cola predeterminada. Este es el equivalente de Cloud Tasks a asignar nombres a tareas en las listas de tareas en cola.

gcloud

Para crear el nombre de la tarea, gcloud CLI infiere el proyecto y la ubicación de tu configuración.

gcloud tasks create-app-engine-task first-try \
    --queue=default \
    --method=GET \
    --relative-uri=/url/path

Vuelve a intentar tareas fallidas

Puedes establecer la configuración de reintento de tareas en las colas durante la creación de la cola o cuando la actualizas. En la siguiente tabla, se muestra el campo Listas de tareas en cola y el campo Cloud Tasks correspondiente.

Campo de listas de tareas en cola Campo de Cloud Tasks
task_retry_limit max_attempts
task_age_limit max_retry_duration
min_backoff_seconds min_backoff
max_backoff_seconds max_backoff
max_doublings max_doublings

Usa parámetros de reintento específicos de la tarea

Los parámetros de reintento específicos de la tarea que se configuraron en las listas de tareas en cola funcionan en Cloud Tasks, pero no puedes editarlos ni establecerlos en tareas nuevas. Para cambiar los parámetros de reintento de una tarea que tiene parámetros de reintento específicos de la tarea, vuelve a crearla con una cola de Cloud Tasks que tenga los parámetros de reintento deseados.

En el siguiente ejemplo, se muestran varias situaciones de reintento:

  • En fooqueue, las tareas se vuelven a intentar hasta siete veces y durante dos días, como máximo, desde el primer intento de ejecución. Una vez que se pasan ambos límites, la tarea falla de forma permanente.
  • En barqueue, App Engine aumenta el intervalo linealmente entre cada reintento hasta alcanzar la máxima retirada para reintentar las tareas, y lo hace de manera indefinida en el intervalo máximo (por lo que los intervalos entre solicitudes son de 10 segundos, 20, 30, …, 190, 200, 200, …).
  • En bazqueue, el intervalo de reintento comienza con 10 segundos, luego se duplica tres veces, luego aumenta linealmente y, por último, reintenta de forma indefinida en el intervalo máximo (por lo que los intervalos entre solicitudes son de 10 segundos, 20, 40, 80, 160, 240, 300, 300, …).

Este es el equivalente de Cloud Tasks a reintentar tareas en las listas de tareas en cola.

gcloud

Cuando configuras opciones que especifican una cantidad de segundos, debes incluir s después del número entero (p.ej., 200s y no 200).

gcloud tasks queues create fooqueue \
    --max-attempts=7 \
    --max-retry-duration=172800s  #2*60*60*24 seconds in 2 days
 
gcloud tasks queues create barqueue \
    --min-backoff=10s \
    --max-backoff=200s \
    --max-doublings=0
 
gcloud tasks queues create bazqueue \
    --min-backoff=10s \
    --max-backoff=300s \
    --max-doublings=3

Para obtener más información, consulta la referencia de Cloud Tasks Configura parámetros de reintento.

Borra tareas de una cola

Cuando borras una tarea que se encontraba en una cola creada con el archivo queue.yaml, debes esperar hasta 9 días antes de crear una con el mismo nombre, o 1 hora si la tarea se encontraba en una cola que se creó mediante Cloud Tasks.

En el siguiente ejemplo, se borra la tarea con el ID foo de la cola con el ID queue1. Este es el equivalente de Cloud Tasks a borrar tareas en las listas de tareas en cola.

gcloud

El proyecto y la ubicación de la tarea se infieren del proyecto predeterminado de la gcloud CLI.

gcloud tasks delete foo --queue=queue1

Para obtener más información, consulta la referencia de Cloud Tasks Borra una tarea de una cola.

Borra definitivamente las tareas

En el siguiente ejemplo, se borran definitivamente todas las tareas de la cola con el ID queue1. Este es el equivalente de Cloud Tasks a borrar definitivamente las tareas de las listas de tareas en cola.

gcloud

El proyecto y la ubicación de la cola se infieren del proyecto predeterminado de gcloud CLI.

gcloud tasks queues purge queue1

Para obtener más información, consulta la referencia de Cloud Tasks Borra definitivamente todas las tareas de una cola.

¿Qué sigue?