This repository has been archived by the owner on Feb 1, 2024. It is now read-only.
/
queue.py
450 lines (380 loc) · 20.5 KB
/
queue.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
# -*- coding: utf-8 -*-
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
import proto # type: ignore
from google.cloud.tasks_v2beta2.types import target
from google.protobuf import duration_pb2 # type: ignore
from google.protobuf import timestamp_pb2 # type: ignore
__protobuf__ = proto.module(
package="google.cloud.tasks.v2beta2",
manifest={"Queue", "RateLimits", "RetryConfig", "QueueStats",},
)
class Queue(proto.Message):
r"""A queue is a container of related tasks. Queues are
configured to manage how those tasks are dispatched.
Configurable properties include rate limits, retry options,
target types, and others.
Attributes:
name (str):
Caller-specified and required in
[CreateQueue][google.cloud.tasks.v2beta2.CloudTasks.CreateQueue],
after which it becomes output only.
The queue name.
The queue name must have the following format:
``projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID``
- ``PROJECT_ID`` can contain letters ([A-Za-z]), numbers
([0-9]), hyphens (-), colons (:), or periods (.). For
more information, see `Identifying
projects <https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects>`__
- ``LOCATION_ID`` is the canonical ID for the queue's
location. The list of available locations can be obtained
by calling
[ListLocations][google.cloud.location.Locations.ListLocations].
For more information, see
https://cloud.google.com/about/locations/.
- ``QUEUE_ID`` can contain letters ([A-Za-z]), numbers
([0-9]), or hyphens (-). The maximum length is 100
characters.
app_engine_http_target (google.cloud.tasks_v2beta2.types.AppEngineHttpTarget):
App Engine HTTP target.
An App Engine queue is a queue that has an
[AppEngineHttpTarget][google.cloud.tasks.v2beta2.AppEngineHttpTarget].
pull_target (google.cloud.tasks_v2beta2.types.PullTarget):
Pull target.
A pull queue is a queue that has a
[PullTarget][google.cloud.tasks.v2beta2.PullTarget].
rate_limits (google.cloud.tasks_v2beta2.types.RateLimits):
Rate limits for task dispatches.
[rate_limits][google.cloud.tasks.v2beta2.Queue.rate_limits]
and
[retry_config][google.cloud.tasks.v2beta2.Queue.retry_config]
are related because they both control task attempts however
they control how tasks are attempted in different ways:
- [rate_limits][google.cloud.tasks.v2beta2.Queue.rate_limits]
controls the total rate of dispatches from a queue (i.e.
all traffic dispatched from the queue, regardless of
whether the dispatch is from a first attempt or a retry).
- [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config]
controls what happens to particular a task after its
first attempt fails. That is,
[retry_config][google.cloud.tasks.v2beta2.Queue.retry_config]
controls task retries (the second attempt, third attempt,
etc).
retry_config (google.cloud.tasks_v2beta2.types.RetryConfig):
Settings that determine the retry behavior.
- For tasks created using Cloud Tasks: the queue-level
retry settings apply to all tasks in the queue that were
created using Cloud Tasks. Retry settings cannot be set
on individual tasks.
- For tasks created using the App Engine SDK: the
queue-level retry settings apply to all tasks in the
queue which do not have retry settings explicitly set on
the task and were created by the App Engine SDK. See `App
Engine
documentation <https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks>`__.
state (google.cloud.tasks_v2beta2.types.Queue.State):
Output only. The state of the queue.
``state`` can only be changed by calling
[PauseQueue][google.cloud.tasks.v2beta2.CloudTasks.PauseQueue],
[ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue],
or uploading
`queue.yaml/xml <https://cloud.google.com/appengine/docs/python/config/queueref>`__.
[UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue]
cannot be used to change ``state``.
purge_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. The last time this queue was purged.
All tasks that were
[created][google.cloud.tasks.v2beta2.Task.create_time]
before this time were purged.
A queue can be purged using
[PurgeQueue][google.cloud.tasks.v2beta2.CloudTasks.PurgeQueue],
the `App Engine Task Queue SDK, or the Cloud
Console <https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue>`__.
Purge time will be truncated to the nearest microsecond.
Purge time will be unset if the queue has never been purged.
task_ttl (google.protobuf.duration_pb2.Duration):
The maximum amount of time that a task will be retained in
this queue.
Queues created by Cloud Tasks have a default ``task_ttl`` of
31 days. After a task has lived for ``task_ttl``, the task
will be deleted regardless of whether it was dispatched or
not.
The ``task_ttl`` for queues created via queue.yaml/xml is
equal to the maximum duration because there is a `storage
quota <https://cloud.google.com/appengine/quotas#Task_Queue>`__
for these queues. To view the maximum valid duration, see
the documentation for [Duration][google.protobuf.Duration].
tombstone_ttl (google.protobuf.duration_pb2.Duration):
The task tombstone time to live (TTL).
After a task is deleted or completed, the task's tombstone
is retained for the length of time specified by
``tombstone_ttl``. The tombstone is used by task
de-duplication; another task with the same name can't be
created until the tombstone has expired. For more
information about task de-duplication, see the documentation
for
[CreateTaskRequest][google.cloud.tasks.v2beta2.CreateTaskRequest.task].
Queues created by Cloud Tasks have a default
``tombstone_ttl`` of 1 hour.
stats (google.cloud.tasks_v2beta2.types.QueueStats):
Output only. The realtime, informational
statistics for a queue. In order to receive the
statistics the caller should include this field
in the FieldMask.
"""
class State(proto.Enum):
r"""State of the queue."""
STATE_UNSPECIFIED = 0
RUNNING = 1
PAUSED = 2
DISABLED = 3
name = proto.Field(proto.STRING, number=1,)
app_engine_http_target = proto.Field(
proto.MESSAGE,
number=3,
oneof="target_type",
message=target.AppEngineHttpTarget,
)
pull_target = proto.Field(
proto.MESSAGE, number=4, oneof="target_type", message=target.PullTarget,
)
rate_limits = proto.Field(proto.MESSAGE, number=5, message="RateLimits",)
retry_config = proto.Field(proto.MESSAGE, number=6, message="RetryConfig",)
state = proto.Field(proto.ENUM, number=7, enum=State,)
purge_time = proto.Field(proto.MESSAGE, number=8, message=timestamp_pb2.Timestamp,)
task_ttl = proto.Field(proto.MESSAGE, number=9, message=duration_pb2.Duration,)
tombstone_ttl = proto.Field(
proto.MESSAGE, number=10, message=duration_pb2.Duration,
)
stats = proto.Field(proto.MESSAGE, number=16, message="QueueStats",)
class RateLimits(proto.Message):
r"""Rate limits.
This message determines the maximum rate that tasks can be
dispatched by a queue, regardless of whether the dispatch is a first
task attempt or a retry.
Note: The debugging command,
[RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask], will run a
task even if the queue has reached its
[RateLimits][google.cloud.tasks.v2beta2.RateLimits].
Attributes:
max_tasks_dispatched_per_second (float):
The maximum rate at which tasks are dispatched from this
queue.
If unspecified when the queue is created, Cloud Tasks will
pick the default.
- For [App Engine
queues][google.cloud.tasks.v2beta2.AppEngineHttpTarget],
the maximum allowed value is 500.
- This field is output only for [pull
queues][google.cloud.tasks.v2beta2.PullTarget]. In
addition to the ``max_tasks_dispatched_per_second``
limit, a maximum of 10 QPS of
[LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks]
requests are allowed per pull queue.
This field has the same meaning as `rate in
queue.yaml/xml <https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate>`__.
max_burst_size (int):
The max burst size.
Max burst size limits how fast tasks in queue are processed
when many tasks are in the queue and the rate is high. This
field allows the queue to have a high rate so processing
starts shortly after a task is enqueued, but still limits
resource usage when many tasks are enqueued in a short
period of time.
The `token
bucket <https://wikipedia.org/wiki/Token_Bucket>`__
algorithm is used to control the rate of task dispatches.
Each queue has a token bucket that holds tokens, up to the
maximum specified by ``max_burst_size``. Each time a task is
dispatched, a token is removed from the bucket. Tasks will
be dispatched until the queue's bucket runs out of tokens.
The bucket will be continuously refilled with new tokens
based on
[max_dispatches_per_second][RateLimits.max_dispatches_per_second].
The default value of ``max_burst_size`` is picked by Cloud
Tasks based on the value of
[max_dispatches_per_second][RateLimits.max_dispatches_per_second].
The maximum value of ``max_burst_size`` is 500.
For App Engine queues that were created or updated using
``queue.yaml/xml``, ``max_burst_size`` is equal to
`bucket_size <https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size>`__.
If
[UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue]
is called on a queue without explicitly setting a value for
``max_burst_size``, ``max_burst_size`` value will get
updated if
[UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue]
is updating
[max_dispatches_per_second][RateLimits.max_dispatches_per_second].
max_concurrent_tasks (int):
The maximum number of concurrent tasks that Cloud Tasks
allows to be dispatched for this queue. After this threshold
has been reached, Cloud Tasks stops dispatching tasks until
the number of concurrent requests decreases.
If unspecified when the queue is created, Cloud Tasks will
pick the default.
The maximum allowed value is 5,000.
This field is output only for [pull
queues][google.cloud.tasks.v2beta2.PullTarget] and always
-1, which indicates no limit. No other queue types can have
``max_concurrent_tasks`` set to -1.
This field has the same meaning as `max_concurrent_requests
in
queue.yaml/xml <https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests>`__.
"""
max_tasks_dispatched_per_second = proto.Field(proto.DOUBLE, number=1,)
max_burst_size = proto.Field(proto.INT32, number=2,)
max_concurrent_tasks = proto.Field(proto.INT32, number=3,)
class RetryConfig(proto.Message):
r"""Retry config.
These settings determine how a failed task attempt is retried.
Attributes:
max_attempts (int):
The maximum number of attempts for a task.
Cloud Tasks will attempt the task ``max_attempts`` times
(that is, if the first attempt fails, then there will be
``max_attempts - 1`` retries). Must be > 0.
unlimited_attempts (bool):
If true, then the number of attempts is
unlimited.
max_retry_duration (google.protobuf.duration_pb2.Duration):
If positive, ``max_retry_duration`` specifies the time limit
for retrying a failed task, measured from when the task was
first attempted. Once ``max_retry_duration`` time has passed
*and* the task has been attempted
[max_attempts][google.cloud.tasks.v2beta2.RetryConfig.max_attempts]
times, no further attempts will be made and the task will be
deleted.
If zero, then the task age is unlimited.
If unspecified when the queue is created, Cloud Tasks will
pick the default.
This field is output only for [pull
queues][google.cloud.tasks.v2beta2.PullTarget].
``max_retry_duration`` will be truncated to the nearest
second.
This field has the same meaning as `task_age_limit in
queue.yaml/xml <https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters>`__.
min_backoff (google.protobuf.duration_pb2.Duration):
A task will be
[scheduled][google.cloud.tasks.v2beta2.Task.schedule_time]
for retry between
[min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff]
and
[max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff]
duration after it fails, if the queue's
[RetryConfig][google.cloud.tasks.v2beta2.RetryConfig]
specifies that the task should be retried.
If unspecified when the queue is created, Cloud Tasks will
pick the default.
This field is output only for [pull
queues][google.cloud.tasks.v2beta2.PullTarget].
``min_backoff`` will be truncated to the nearest second.
This field has the same meaning as `min_backoff_seconds in
queue.yaml/xml <https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters>`__.
max_backoff (google.protobuf.duration_pb2.Duration):
A task will be
[scheduled][google.cloud.tasks.v2beta2.Task.schedule_time]
for retry between
[min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff]
and
[max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff]
duration after it fails, if the queue's
[RetryConfig][google.cloud.tasks.v2beta2.RetryConfig]
specifies that the task should be retried.
If unspecified when the queue is created, Cloud Tasks will
pick the default.
This field is output only for [pull
queues][google.cloud.tasks.v2beta2.PullTarget].
``max_backoff`` will be truncated to the nearest second.
This field has the same meaning as `max_backoff_seconds in
queue.yaml/xml <https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters>`__.
max_doublings (int):
The time between retries will double ``max_doublings``
times.
A task's retry interval starts at
[min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff],
then doubles ``max_doublings`` times, then increases
linearly, and finally retries at intervals of
[max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff]
up to
[max_attempts][google.cloud.tasks.v2beta2.RetryConfig.max_attempts]
times.
For example, if
[min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff]
is 10s,
[max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff]
is 300s, and ``max_doublings`` is 3, then the a task will
first be retried in 10s. The retry interval will double
three times, and then increase linearly by 2^3 \* 10s.
Finally, the task will retry at intervals of
[max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff]
until the task has been attempted
[max_attempts][google.cloud.tasks.v2beta2.RetryConfig.max_attempts]
times. Thus, the requests will retry at 10s, 20s, 40s, 80s,
160s, 240s, 300s, 300s, ....
If unspecified when the queue is created, Cloud Tasks will
pick the default.
This field is output only for [pull
queues][google.cloud.tasks.v2beta2.PullTarget].
This field has the same meaning as `max_doublings in
queue.yaml/xml <https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters>`__.
"""
max_attempts = proto.Field(proto.INT32, number=1, oneof="num_attempts",)
unlimited_attempts = proto.Field(proto.BOOL, number=2, oneof="num_attempts",)
max_retry_duration = proto.Field(
proto.MESSAGE, number=3, message=duration_pb2.Duration,
)
min_backoff = proto.Field(proto.MESSAGE, number=4, message=duration_pb2.Duration,)
max_backoff = proto.Field(proto.MESSAGE, number=5, message=duration_pb2.Duration,)
max_doublings = proto.Field(proto.INT32, number=6,)
class QueueStats(proto.Message):
r"""Statistics for a queue.
Attributes:
tasks_count (int):
Output only. An estimation of the number of
tasks in the queue, that is, the tasks in the
queue that haven't been executed, the tasks in
the queue which the queue has dispatched but has
not yet received a reply for, and the failed
tasks that the queue is retrying.
oldest_estimated_arrival_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. An estimation of the nearest
time in the future where a task in the queue is
scheduled to be executed.
executed_last_minute_count (int):
Output only. The number of tasks that the
queue has dispatched and received a reply for
during the last minute. This variable counts
both successful and non-successful executions.
concurrent_dispatches_count (int):
Output only. The number of requests that the
queue has dispatched but has not received a
reply for yet.
effective_execution_rate (float):
Output only. The current maximum number of
tasks per second executed by the queue. The
maximum value of this variable is controlled by
the RateLimits of the Queue. However, this value
could be less to avoid overloading the endpoints
tasks in the queue are targeting.
"""
tasks_count = proto.Field(proto.INT64, number=1,)
oldest_estimated_arrival_time = proto.Field(
proto.MESSAGE, number=2, message=timestamp_pb2.Timestamp,
)
executed_last_minute_count = proto.Field(proto.INT64, number=3,)
concurrent_dispatches_count = proto.Field(proto.INT64, number=4,)
effective_execution_rate = proto.Field(proto.DOUBLE, number=5,)
__all__ = tuple(sorted(__protobuf__.manifest))