最新の SDK にアップグレードして push キューを Cloud Tasks に移行する(Java)

最新の App Engine サービス SDK バージョンにアップグレードする前に、移行の概要を確認してください。

App Engine サービス SDK を最新バージョンに更新すると、Cloud Tasks に自動的に移行できます。アップグレード後、SDK は PushQueue 呼び出しを Cloud Tasks フロントエンド API に自動的にリダイレクトします。Cloud Tasks は既存のタスクキューとタスクを保持するため、追加の移行は必要ありません。

更新された SDK は、Cloud Tasks API を使用してタスクキュー機能との機能同等性を維持します。SDK は次の機能をサポートしています。

  • バッチタスクの作成: SDK はバッチ API を使用して、1 回の呼び出しで最大 100 個のタスクを追加できます。
  • バッチタスクの削除: SDK はバッチ API を使用して、1 回の呼び出しで最大 1,000 個のタスクを削除できます。
  • タスクレベルの再試行: SDK は、タスク固有の再試行構成をサポートしています。
  • トランザクション タスク: SDK は Datastore トランザクション内でタスクをキューに追加します。信頼性を維持するには、cron.yaml ファイルを作成または変更します。

料金と割り当て

push キューを Cloud Tasks に移行すると、アプリの料金と割り当てに影響する場合があります。

料金

移行する前に、Cloud Tasks の料金を確認して月額費用を見積もります。

タスクキューと同様に、Cloud Tasks の push ターゲットを使用して App Engine アプリにリクエストを送信するのは無料です。ただし、タスクキューとは異なり、Cloud Tasks では、タスクの作成、削除、管理などの実行されたオペレーションに対して課金されます。これにより、無料の App Engine タスクキューと比較して、月額料金が全体的に高くなる可能性があります。

App Engine サービス SDK をアップグレードして移行し、アプリケーションが Datastore トランザクション内でトランザクション タスクをキューに登録する場合、キューに登録された各タスクは、標準の Cloud Tasks API の課金に加えて、Datastore で 3 回の書き込み、2 回の読み取り、1 回の削除が発生します。

割り当て

Cloud Tasks リクエストも App Engine リクエストの割り当てにカウントされます。

タスクキューと同様に、Cloud Tasks にはサービス固有の割り当てがあります。Cloud Tasks に移行すると、割り当てが変更される可能性があります。

リクエストのレイテンシを最適化する

更新された SDK はリクエストを Cloud Tasks API に直接送信するため、個々のタスクを順番にキューに登録または削除すると、以前のタスクキュー サービスと比較してリクエストのレイテンシが増加する可能性があります。レイテンシを最小限に抑えるには:

  • 複数のタスクを 1 回の呼び出しにバッチ処理する: ループ内でタスクを 1 つずつキューに追加または削除するのではなく、タスクをバッチ追加呼び出し(1 回の呼び出しにつき最大 100 個のタスク)またはバッチ削除呼び出し(1 回の呼び出しにつき最大 1,000 個のタスク)にグループ化します。
  • 非同期 API 呼び出しを使用する: addAsync() や deleteTaskAsync() などの非ブロッキング メソッドを使用して、タスク オペレーションがリクエスト処理をブロックしないようにします。

始める前に

push キューを Cloud Tasks に移行する前に、次の手順を完了します。

  1. App Engine のソースコードにアクセスできることを確認します。

  2. Cloud Tasks API と Cloud Scheduler API を有効にします。

    API の有効化

  3. App Engine サービス アカウントに、SDK が Cloud Tasks API にタスクをディスパッチするために必要な権限が付与されるようにするには、プロジェクトに対する Cloud Tasks へのデータ追加(roles/cloudtasks.enqueuer)IAM ロールを付与するよう管理者に依頼してください。

App Engine サービス SDK を更新する

  1. アプリケーションで最新バージョンの App Engine サービス SDK が使用されていることを確認します。

    pom.xml で、App Engine サービス SDK をバージョン 5.2.0 以降に更新します。

    <dependency>
        <groupId>com.google.appengine</groupId>
        <artifactId>appengine-api-1.0-sdk</artifactId>
        <version>5.2.0</version>
    </dependency>
  2. Cloud Tasks ルーティングを有効にする

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

    pom.xml の App Engine SDK の依存関係をバージョン 5.2.0 以降に更新します。

    アプリで 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. アプリをデプロイします。

    gcloud app deploy
    
  4. アプリが Cloud Tasks を使用していることを確認するには、Google Cloud コンソールの [Cloud Tasks] ページに移動します。

トランザクション タスクを構成する(省略可)

アプリが Datastore トランザクション内でタスクをキューに格納する場合、SDK は内部の cron ジョブを使用して、Datastore の commit 中にキューに格納できなかったタスクが最終的に処理されるようにします。

push キューのトランザクション タスクを処理するには、cron.yaml ファイルを作成または更新して、内部プロセッサを定期的に呼び出します。次に例を示します。

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

web.xml ファイルに com.google.apphosting.utils.servlet.SweeperServlet の URL マッピングを追加します。Java 17 以降の Jakarta EE ランタイムの場合は com.google.apphosting.utils.servlet.jakarta.SweeperServlet を追加します。

<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>

次のステップ