queue.yaml 構成ファイルは、アプリが使用するほぼすべてのタスクキュー （push または pull） の作成と構成に使用されます。すべての App Engine アプリには、default という名前の自動的に事前構成された push
キューがあります。default キューは自分で作成しませんが、queue.yaml ファイルを使用して他のキューを追加したり、default
キューの構成を変更したりできます。
push キューを構成するには、queue.yaml または
キュー管理メソッドのいずれかを Cloud Tasks から使用しますが、
両方を同時に使用することはできません。queue.yaml アップロード
メソッドとキュー管理メソッドを混在させると、予期しない結果が生じる可能性があるため、おすすめしません。
pull キューを構成するには、queue.yaml ファイルを使用する必要があります。
Cloud Tasks は pull
キューをサポートしていません。
例
名前付きのキューを定義し、デフォルトの処理レートをオーバーライドする基本的な例を次に示します。
queue:
- name: my-push-queue
rate: 1/s
タスクの試行回数を設定し、デフォルトの処理レートを変更する queue.yaml 構成の複雑な例を以下に示します。
queue:
- name: fooqueue
rate: 1/s
retry_parameters:
task_retry_limit: 7
task_age_limit: 2d
- name: barqueue
rate: 1/s
retry_parameters:
min_backoff_seconds: 10
max_backoff_seconds: 200
max_doublings: 0
- name: bazqueue
rate: 1/s
retry_parameters:
min_backoff_seconds: 10
max_backoff_seconds: 200
max_doublings: 3
構文
queue.yaml ファイルは、ルート ディレクティブが queue である YAML ファイルです。このディレクティブには、0 個以上の名前付きキューが含まれています。各キューの定義では以下の要素を指定できます。
| 要素 | 説明 |
|---|---|
bucket_size（push キュー） |
省略可。タスクキューでは、トークン バケット アルゴリズムを使用して、タスクの実行レートが制御されます。名前付きの各キューには、bucket_size 値で指定されている最大個数以内のトークンを保持するトークン バケットがあります。アプリケーションで 1 つのタスクが実行されるごとに、バケットからトークンが 1 つ削除されます。 キューのバケットにトークンがなくなるまで、そのキュー内のタスクの処理を続けます。キューに対してユーザーが指定したレートに基づいて、App Engine はバケットに新しいトークンを補充し続けます。 キューに数多くのタスクがあり、レートが高い場合は、バケットサイズによってキューの処理レートが制限されます。バケットサイズの最大値は 500 です。これにより、タスクがキューに投入されるとすぐに処理が開始されるようにレートを高くすると同時に、数多くのタスクが短時間にキューに投入された場合のリソース使用量を制限できます。 キューの bucket_size を指定していない場合、デフォルト値は 5 です。多くの場合、デフォルトのサイズでは小さすぎるため、これより大きい値を設定することをおすすめします。たとえば、処理レートに基づいてバケットサイズを決定できます。 この要素の詳細については、 |
max_concurrent_requests（push キュー） |
省略可。指定されたキューから同時に実行できるタスクの最大数を設定します。この値は整数です。デフォルトでは、キューごとに実行できるタスクが 1,000 個までです。推奨される上限は、キューごとに実行できるタスクが 5,000 個までです。キューは、最初に作成されたときや、しばらくアイドル状態だったときは、ゆっくりと増加することに注意してください。 現在のタスクの数を制限すると、キューの実行レートをより詳細に制御して、同時に実行されるタスクの数が多くなりすぎないようにすることができます。また、Datastore での競合を防止し、他のキューやオンライン処理でリソースを使用できるようになります。 この要素の詳細については、Cloud Tasks API リファレンスにある |
mode |
省略可。キューモードを指定します。この設定のデフォルト値は |
name |
必須。キューの名前。 これは キュー名には大文字、小文字、数字、ハイフンを使用できます。キュー名の最大長は 100 文字です。
どのアプリにも default という名の push キューがあります。このキューには、1 秒あたり 5 タスクのレートが事前に設定されています。このデフォルト キューは、最初に使用または構成されるまで Google Cloud console に表示されません。デフォルト キューの変更（デフォルト レートの変更など）は、 |
rate（push キュー） |
必須。このキューでタスクを処理する頻度です。値は数値の後にスラッシュと時間の単位を付けたものです。単位は、
数値が この要素の詳細については、Cloud Tasks API リファレンスにある |
retry_parameters |
省略可。push キューで失敗したタスクの再試行回数を構成します。この要素を追加して、特定のキューで失敗するタスクの最大再試行回数を指定できます。再試行の制限時間を設定したり、再試行の間隔を制御したりすることもできます。 再試行パラメータには、次のサブ要素を含めることができます。
|
target（push キュー） |
省略可。サービス / バージョン、フロントエンド バージョン、またはバックエンドの名前となる文字列です。このキューに追加されたすべてのタスクを実行するための名前です。デフォルト値は空の文字列です。
タスクの HTTP リクエストを構築するときは、アプリのドメイン名の前に文字列を付加します。たとえば、アプリ ID が ターゲットを指定しない場合は、タスクをキューに登録したのと同じバージョンのアプリケーションで呼び出されます。つまり、キューのターゲットを指定せずに、デフォルトのアプリケーション バージョンからタスクをキューに登録した場合、タスクはデフォルトのアプリケーション バージョンで呼び出されます。タスクをキューに追加してからタスクが実行されるまでの間にデフォルトのアプリケーション バージョンが変更された場合、タスクは新しいデフォルト バージョンで実行されることに注意してください。 サービスを ディスパッチ ファイルと一緒に使用している場合、タスクの HTTP リクエストがインターセプトされて、別のサービスに再ルーティングされる可能性があります。 |
アプリ内のすべてのキューに対して、次の要素を指定できます。
| 要素 | 説明 |
|---|---|
total_storage_limit |
省略可。タスクキュー ストレージ（100 MB）で利用可能な、デフォルトで割り当てられたストレージ上限をオーバーライドする文字列。次に例を示します。 total_storage_limit: 1.2G queue: - name: fooqueue この割り当ては、アプリケーションの合計ストレージ容量（ Datastore と Blobstore の容量を含む）の一部です。 接尾辞が指定されていない場合、指定する数値は、バイト単位であると解釈されます。次の接尾辞がサポートされています。
|
キュー構成ファイルのデプロイ
queue.yaml ファイルは、ルート ディレクトリまたはデフォルト サービスを定義するディレクトリに配置する必要があります。
キー構成ファイルをデプロイするには、次のコマンドを実行します。
gcloud app deploy queue.yaml
キューの削除
キューを削除するには:
queue.yamlファイルからキューの定義を削除します。変更した
queue.yamlファイルをアップロードします。gcloud app deploy queue.yaml
Google Cloud コンソールでキューを削除し、キューを選択して [キューを削除] をクリックします。
Google Cloud コンソールでキューを削除した場合、同じ名前のキューをもう一度作成するには 7 日間経過している必要があります。