Migrer des files d'attente d'envoi vers Cloud Tasks en passant au dernier SDK (Java)

Avant de passer à la dernière version du SDK des services App Engine, consultez la présentation de la migration.

Vous pouvez migrer vers Cloud Tasks automatiquement en mettant à jour le SDK des services App Engine vers la dernière version. Après la mise à niveau, le SDK redirige automatiquement les appels PushQueue vers les API d'interface Cloud Tasks. Cloud Tasks conserve vos files d'attente de tâches et vos tâches existantes. Aucune migration supplémentaire n'est donc requise.

En coulisses, le SDK mis à jour utilise les API Cloud Tasks pour maintenir la parité des fonctionnalités avec les fonctionnalités des files d'attente de tâches. Le SDK est compatible avec les éléments suivants :

  • Création de tâches par lot : le SDK utilise des API par lot pour permettre l'ajout de jusqu'à 100 tâches en un seul appel.
  • Suppression de tâches par lot : le SDK utilise des API par lot pour permettre la suppression de jusqu'à 1 000 tâches en un seul appel.
  • Nouvelles tentatives au niveau des tâches : le SDK accepte les configurations de nouvelles tentatives spécifiques aux tâches.
  • Tâches transactionnelles : le SDK met en file d'attente les tâches dans les transactions Datastore. Pour maintenir la fiabilité, créez ou modifiez le fichier cron.yaml.

Tarifs et quotas

La migration de vos files d'attente d'envoi vers Cloud Tasks peut avoir une incidence sur les tarifs et les quotas de votre application.

Tarifs

Consultez les tarifs de Cloud Tasks pour estimer votre coût mensuel avant de migrer.

Comme pour les files d'attente de tâches, l'envoi de requêtes à votre application App Engine avec une cible d'envoi Cloud Tasks est sans frais. Cependant, contrairement à Task Queues, Cloud Tasks facture les opérations effectuées, telles que la création, la suppression ou la gestion des tâches. Cela peut entraîner un coût mensuel global plus élevé par rapport à la file d'attente de tâches App Engine sans frais.

Si vous effectuez la migration en mettant à niveau le SDK des services App Engine et que votre application met en file d'attente des tâches transactionnelles dans des transactions Datastore, chaque tâche mise en file d'attente entraîne trois écritures, deux lectures et une suppression dans Datastore, en plus de la facturation standard de l'API Cloud Tasks.

Quotas

Les requêtes Cloud Tasks sont également comptabilisées dans vos quotas de requêtes App Engine.

Comme les files d'attente de tâches, Cloud Tasks dispose de quotas spécifiques au service. La migration vers Cloud Tasks modifiera probablement vos quotas.

Optimiser la latence des requêtes

Étant donné que le SDK mis à jour envoie des requêtes directement à l'API Cloud Tasks, la mise en file d'attente ou la suppression de tâches individuelles de manière séquentielle peut augmenter la latence des requêtes par rapport à l'ancien service de files d'attente de tâches. Pour réduire la latence :

  • Regrouper plusieurs tâches dans un seul appel : regroupez les tâches dans des appels d'ajout par lot (jusqu'à 100 tâches par appel) ou des appels de suppression par lot (jusqu'à 1 000 tâches par appel) au lieu de mettre en file d'attente ou de supprimer les tâches une par une dans une boucle.
  • Utilisez des appels d'API asynchrones : utilisez des méthodes non bloquantes telles que addAsync() et deleteTaskAsync() pour que les opérations de tâche ne bloquent pas le traitement des requêtes.

Avant de commencer

Avant de migrer des files d'attente d'envoi vers Cloud Tasks, procédez comme suit :

  1. Assurez-vous d'avoir accès au code source App Engine.

  2. Activez les API Cloud Tasks et Cloud Scheduler :

    Activer les API

  3. Pour vous assurer que le compte de service App Engine dispose des autorisations nécessaires pour permettre au SDK de distribuer des tâches à l'API Cloud Tasks, demandez à votre administrateur d'accorder le rôle IAM Cloud Tasks Enqueuer (roles/cloudtasks.enqueuer) sur le projet.

Mettre à jour le SDK des services App Engine

  1. Assurez-vous que votre application utilise la dernière version du SDK des services App Engine.

    Dans votre pom.xml, mettez à jour le SDK des services App Engine vers la version 5.2.0 ou ultérieure.

    <dependency>
        <groupId>com.google.appengine</groupId>
        <artifactId>appengine-api-1.0-sdk</artifactId>
        <version>5.2.0</version>
    </dependency>
  2. Activer le routage Cloud Tasks

    runtime: java25
    service: my-service-b
    
    env_variables:
      APPENGINE_USE_CLOUDTASK_PUSH_QUEUE: "true"
    

    Mettez à jour la dépendance du SDK App Engine dans votre fichier pom.xml vers la version 5.2.0 ou une version ultérieure.

    Si votre application utilise une configuration XML (appengine-web.xml) :

    <appengine-web-app xmlns="http://appengine.google.com/ns/1.0">
      <service>my-java-service-b</service>
      <runtime>java25</runtime>
      <env-variables>
        <env-var name="APPENGINE_USE_CLOUDTASK_PUSH_QUEUE" value="true" />
      </env-variables>
    </appengine-web-app>
    
  3. Déployez l'application :

    gcloud app deploy
    
  4. Pour vérifier que votre application utilise Cloud Tasks, accédez à la page Cloud Tasks dans la consoleGoogle Cloud .

Configurer des tâches transactionnelles (facultatif)

Si votre application met en file d'attente des tâches dans des transactions Datastore, le SDK s'appuie sur un job Cron interne pour s'assurer que toutes les tâches qui ne sont pas mises en file d'attente lors de la validation du datastore sont finalement traitées.

Pour gérer les tâches transactionnelles de la file d'attente d'envoi, créez ou mettez à jour votre fichier cron.yaml afin d'appeler régulièrement le processeur interne. Exemple :

cron:
- description: "Process push queue transactional tasks"
  url: /_ah/cloudtask/sweep
  schedule: every 30 minutes # Change this based on the usage pattern

Ajoutez un mappage d'URL dans votre fichier web.xml pour com.google.apphosting.utils.servlet.SweeperServlet ou com.google.apphosting.utils.servlet.jakarta.SweeperServlet pour Java 17 et les environnements d'exécution Jakarta EE ultérieurs.

<servlet>
 <servlet-name>cloudtask_sweep</servlet-name>
 <servlet-class>com.google.apphosting.utils.servlet.SweeperServlet</servlet-class>
</servlet>
<servlet-mapping>
 <servlet-name>cloudtask_sweep</servlet-name>
 <url-pattern>/_ah/cloudtask/sweep</url-pattern>
</servlet-mapping>

Étapes suivantes