Creating Push Queues

Python 2.7/3.7 |Java 8/11 |PHP 5/7 |Ruby |Go 1.11/1.12+ |Node.js

This page describes how to create and customize a push queue, and how to examine the contents of a queue.

This solution is no longer recommended: This page describes how to use a superseded App Engine service. Apps that use this service can only run in App Engine and will need to upgrade to a recommended solution before migrating to newer App Engine runtimes.

Using a queue configuration file to create queues

To process a task, you must add it to a push queue. App Engine provides a default push queue, named default, which is configured and ready to use with default settings. If you want, you can just add all your tasks to the default queue, without having to create and configure other queues.

To add queues or change the default configuration, edit the queue configuration file for your application, which you upload to App Engine. You can create up to 100 queues. Queues cannot be created dynamically.

This queue configuration file defines two queues:

queue:
- name: queue-blue
  target: v2.task-module
  rate: 5/s

- name: queue-red
  rate: 1/s

To upload the file:

gcloud app deploy queue.yaml

Note: Your app should not assume App Engine processes tasks in a queue in the order in which they were enqueued.

All tasks added to queue-blue are sent to the target module v2.task-module. The refresh rate of queue-red is changed from 5/s to 1/s. Tasks will be dequeued and sent to their targets at the rate of 1 task per second.

If you delete a queue, you must wait approximately 7 days before creating a new queue with the same name.

There are many other parameters that can be added to the configuration file to customize the behavior of a push queue. For more information, see the queue configuration file reference.

Note: If you are using a service account to manage authentication for deploying your queue configuration file, it needs to have the serviceusage.services.list permission. This permission can be added either using the serviceusage.serviceUsageViewer role or by creating a custom role with that permission.

Defining the push queue processing rate

You can control the rate at which tasks are processed in each of your queues by defining other directives, such as rate, bucket_size, and max_concurrent_requests.

The task queue uses token buckets to control the rate of task execution. Each named queue has a token bucket that holds tokens, up to the maximum specified by the bucket_size, or a maximum of 5 tokens if you don't specify the bucket size.

Each time your application executes a task, a token is removed from the bucket. Your app continues processing tasks in the queue until the queue's bucket runs out of tokens. App Engine refills the bucket with new tokens continuously based on the rate that you specified for the queue.

If your queue contains tasks to process, and the queue's bucket contains tokens, App Engine simultaneously processes as many tasks as there are tokens. This can lead to bursts of processing, consuming system resources and competing with user-serving requests.

If you want to prevent too many tasks from running at once or to prevent datastore contention, use max_concurrent_requests.

The following sample shows how to set max_concurrent_requests to limit tasks and also shows how to adjust the bucket size and rate based on your application's needs and available resources:

queue:
- name: queue-blue
  rate: 20/s
  bucket_size: 40
  max_concurrent_requests: 10

Setting storage limits for all queues

You can use your queue configuration file to define the total amount of storage that task data can consume over all queues. To define the total storage limit, include an element named total_storage_limit at the top level:

# Set the total storage limit for all queues to 120MB
total_storage_limit: 120M
queue:
- name: queue-blue
  rate: 35/s