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
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
|
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!-- Process this file with docbook-to-man to generate an nroff manual
page: `docbook-to-man manpage.sgml > manpage.1'. You may view
the manual page with: `docbook-to-man manpage.sgml | nroff -man |
less'. A typical entry in a Makefile or Makefile.am is:
manpage.1: manpage.sgml
docbook-to-man $< > $@
The docbook-to-man binary is found in the docbook-to-man package.
Please remember that if you create the nroff version in one of the
debian/rules file targets (such as build), you will need to include
docbook-to-man in your Build-Depends control field.
-->
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
<!ENTITY dhfirstname "<firstname>Michael</firstname>">
<!ENTITY dhsurname "<surname>Fladischer</surname>">
<!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY dhdate "<date>12 July 2013</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
<!ENTITY dhemail "<email>FladischerMichael@fladi.at</email>">
<!ENTITY dhusername "fladi">
<!ENTITY dhucpackage "<refentrytitle>CELERY</refentrytitle>">
<!ENTITY dhpackage "celery">
<!ENTITY debian "<productname>Debian</productname>">
<!ENTITY gnu "<acronym>GNU</acronym>">
<!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
]>
<refentry>
<refentryinfo>
<address>
&dhemail;
</address>
<author>
&dhfirstname;
&dhsurname;
</author>
<copyright>
<year>2013</year>
<holder>&dhusername;</holder>
</copyright>
&dhdate;
</refentryinfo>
<refmeta>
&dhucpackage;
&dhsection;
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose>Celery Worker Daemon</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage;</command>
<arg>command</arg>
<arg><option>-A/--app=<replaceable>APP</replaceable></option></arg>
<arg><option>-b/--broker=<replaceable>BROKER</replaceable></option></arg>
<arg><option>--loader=<replaceable>LOADER</replaceable></option></arg>
<arg><option>--config=<replaceable>CONFIG</replaceable></option></arg>
<arg><option>--workdir=<replaceable>WORKING_DIRECTORY</replaceable></option></arg>
<arg><option>-q/--quiet</option></arg>
<arg><option>-C/--no-color</option></arg>
<arg><option>--version</option></arg>
<arg><option>--help</option></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This manual page documents briefly the
<command>&dhpackage;</command> command.</para>
<para>This manual page was written for the &debian; distribution
because the original program does not have a manual page.</para>
<para>
<command>&dhpackage;</command> is a program that manages the
Celery Worker Daemons and their queues.
</para>
</refsect1>
<refsect1>
<title>COMMANDS</title>
<para>
All inspect commands supports a --timeout argument, This is the number of seconds to wait for responses. You may have to increase this timeout if
you’re not getting a response due to latency.
</para>
<variablelist>
<varlistentry>
<term>
<arg>shell</arg>
</term>
<listitem>
<para>
Drop into a Python shell. The locals will include the celery variable, which is the current app. Also all known tasks will be
automatically added to locals (unless the --without-tasks flag is set). Uses Ipython, bpython, or regular python in that order if
installed. You can force an implementation using --force-ipython|-I, --force-bpython|-B, or --force-python|-P.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<arg>status</arg>
</term>
<listitem>
<para>
List active nodes in this cluster.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<arg>result <option>-t <replaceable>task name</replaceable></option> <replaceable>uuid</replaceable></arg>
</term>
<listitem>
<para>
Show the result of a task. Note that you can omit the name of the task as long as the task doesn’t use a custom result backend.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<arg>purge</arg>
</term>
<listitem>
<para>
Purge messages from all configured task queues.
Warning: There is no undo for this operation, and messages will be permanently deleted!
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<arg>inspect active</arg>
</term>
<listitem>
<para>
List active tasks. These are all the tasks that are currently being executed.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<arg>inspect scheduled</arg>
</term>
<listitem>
<para>
List scheduled ETA tasks. These are tasks reserved by the worker because they have the eta or countdown argument set.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<arg>inspect reserved</arg>
</term>
<listitem>
<para>
List reserved tasks. This will list all tasks that have been prefetched by the worker, and is currently waiting to be executed (does not
include tasks with an eta).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<arg>inspect revoked</arg>
</term>
<listitem>
<para>
List history of revoked tasks.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<arg>inspect registered</arg>
</term>
<listitem>
<para>
List registered tasks.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<arg>inspect stats</arg>
</term>
<listitem>
<para>
Show worker statistics.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<arg>control enable_events</arg>
</term>
<listitem>
<para>
Enable events.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<arg>control disable_events</arg>
</term>
<listitem>
<para>
Disable events.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<arg>migrate <replaceable>from</replaceable> <replaceable>to</replaceable></arg>
</term>
<listitem>
<para>
Migrate tasks from one broker to another (EXPERIMENTAL). This command will migrate all the tasks on one broker to another. As this
command is new and experimental you should be sure to have a backup of the data before proceeding. The value for each broker should be
a URL.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>This program follows the usual &gnu; command line syntax,
with long options starting with two dashes (`-'). A summary of
options is included below.</para>
<variablelist>
<varlistentry>
<term>
<option>-A <replaceable class="parameter">APP</replaceable></option>
<option>--app=<replaceable class="parameter">APP</replaceable></option>
</term>
<listitem>
<para>App instance to use (e.g. module.attr_name).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-b <replaceable class="parameter">BROKER</replaceable></option>
<option>--broker=<replaceable class="parameter">BROKER</replaceable></option>
</term>
<listitem>
<para>URL to the broker. Default is 'amqp://guest@localhost//'.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--loader=<replaceable class="parameter">LOADER</replaceable></option>
</term>
<listitem>
<para>name of custom loader class to use.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--config=<replaceable class="parameter">CONFIG</replaceable></option>
</term>
<listitem>
<para>Name of the configuration module.</para>
</listitem>
</varlistentry><varlistentry>
<term>
<option>--workdir=<replaceable class="parameter">WORKING_DIRECTORY</replaceable></option>
</term>
<listitem>
<para>Optional directory to change to after detaching.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--quiet</option>
</term>
</varlistentry>
<varlistentry>
<term>
<option>-C</option>
<option>--no-color</option>
</term>
</varlistentry>
<varlistentry>
<term>
<option>--version</option>
</term>
<listitem>
<para>Show program's version number and exit.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-h</option>
<option>--help</option>
</term>
<listitem>
<para>Show help message and exit.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>celeryd(1), celerybeat (1), celeryctl (1).</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>This manual page was written by &dhusername; &dhemail; for
the &debian; system (and may be used by others). Permission is
granted to copy, distribute and/or modify this document under
the terms of the &gnu; General Public License, Version 2 any
later version published by the Free Software Foundation.
</para>
<para>
On Debian systems, the complete text of the GNU General Public
License can be found in /usr/share/common-licenses/GPL.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!-- Process this file with docbook-to-man to generate an nroff manual
page: `docbook-to-man manpage.sgml > manpage.1'. You may view
the manual page with: `docbook-to-man manpage.sgml | nroff -man |
less'. A typical entry in a Makefile or Makefile.am is:
manpage.1: manpage.sgml
docbook-to-man $< > $@
The docbook-to-man binary is found in the docbook-to-man package.
Please remember that if you create the nroff version in one of the
debian/rules file targets (such as build), you will need to include
docbook-to-man in your Build-Depends control field.
-->
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
<!ENTITY dhfirstname "<firstname>Michael</firstname>">
<!ENTITY dhsurname "<surname>Fladischer</surname>">
<!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY dhdate "<date>12 July 2013</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
<!ENTITY dhemail "<email>FladischerMichael@fladi.at</email>">
<!ENTITY dhusername "fladi">
<!ENTITY dhucpackage "<refentrytitle>CELERY</refentrytitle>">
<!ENTITY dhpackage "celery">
<!ENTITY debian "<productname>Debian</productname>">
<!ENTITY gnu "<acronym>GNU</acronym>">
<!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
]>
<refentry>
<refentryinfo>
<address>
&dhemail;
</address>
<author>
&dhfirstname;
&dhsurname;
</author>
<copyright>
<year>2013</year>
<holder>&dhusername;</holder>
</copyright>
&dhdate;
</refentryinfo>
<refmeta>
&dhucpackage;
&dhsection;
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose>Celery Worker Daemon</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage;</command>
<arg>command</arg>
<arg><option>-A/--app=<replaceable>APP</replaceable></option></arg>
<arg><option>-b/--broker=<replaceable>BROKER</replaceable></option></arg>
<arg><option>--loader=<replaceable>LOADER</replaceable></option></arg>
<arg><option>--config=<replaceable>CONFIG</replaceable></option></arg>
<arg><option>--workdir=<replaceable>WORKING_DIRECTORY</replaceable></option></arg>
<arg><option>-q/--quiet</option></arg>
<arg><option>-C/--no-color</option></arg>
<arg><option>--version</option></arg>
<arg><option>--help</option></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This manual page documents briefly the
<command>&dhpackage;</command> command.</para>
<para>This manual page was written for the &debian; distribution
because the original program does not have a manual page.</para>
<para>
<command>&dhpackage;</command> is a program that manages the
Celery Worker Daemons and their queues.
</para>
</refsect1>
<refsect1>
<title>COMMANDS</title>
<para>
All inspect commands supports a --timeout argument, This is the number of seconds to wait for responses. You may have to increase this timeout if
you’re not getting a response due to latency.
</para>
<variablelist>
<varlistentry>
<term>
<arg>shell</arg>
</term>
<listitem>
<para>
Drop into a Python shell. The locals will include the celery variable, which is the current app. Also all known tasks will be
automatically added to locals (unless the --without-tasks flag is set). Uses Ipython, bpython, or regular python in that order if
installed. You can force an implementation using --force-ipython|-I, --force-bpython|-B, or --force-python|-P.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<arg>status</arg>
</term>
<listitem>
<para>
List active nodes in this cluster.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<arg>result <option>-t <replaceable>task name</replaceable></option> <replaceable>uuid</replaceable></arg>
</term>
<listitem>
<para>
Show the result of a task. Note that you can omit the name of the task as long as the task doesn’t use a custom result backend.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<arg>purge</arg>
</term>
<listitem>
<para>
Purge messages from all configured task queues.
Warning: There is no undo for this operation, and messages will be permanently deleted!
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<arg>inspect active</arg>
</term>
<listitem>
<para>
List active tasks. These are all the tasks that are currently being executed.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<arg>inspect scheduled</arg>
</term>
<listitem>
<para>
List scheduled ETA tasks. These are tasks reserved by the worker because they have the eta or countdown argument set.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<arg>inspect reserved</arg>
</term>
<listitem>
<para>
List reserved tasks. This will list all tasks that have been prefetched by the worker, and is currently waiting to be executed (does not
include tasks with an eta).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<arg>inspect revoked</arg>
</term>
<listitem>
<para>
List history of revoked tasks.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<arg>inspect registered</arg>
</term>
<listitem>
<para>
List registered tasks.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<arg>inspect stats</arg>
</term>
<listitem>
<para>
Show worker statistics.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<arg>control enable_events</arg>
</term>
<listitem>
<para>
Enable events.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<arg>control disable_events</arg>
</term>
<listitem>
<para>
Disable events.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<arg>migrate <replaceable>from</replaceable> <replaceable>to</replaceable></arg>
</term>
<listitem>
<para>
Migrate tasks from one broker to another (EXPERIMENTAL). This command will migrate all the tasks on one broker to another. As this
command is new and experimental you should be sure to have a backup of the data before proceeding. The value for each broker should be
a URL.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>This program follows the usual &gnu; command line syntax,
with long options starting with two dashes (`-'). A summary of
options is included below.</para>
<variablelist>
<varlistentry>
<term>
<option>-A <replaceable class="parameter">APP</replaceable></option>
<option>--app=<replaceable class="parameter">APP</replaceable></option>
</term>
<listitem>
<para>App instance to use (e.g. module.attr_name).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-b <replaceable class="parameter">BROKER</replaceable></option>
<option>--broker=<replaceable class="parameter">BROKER</replaceable></option>
</term>
<listitem>
<para>URL to the broker. Default is 'amqp://guest@localhost//'.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--loader=<replaceable class="parameter">LOADER</replaceable></option>
</term>
<listitem>
<para>name of custom loader class to use.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--config=<replaceable class="parameter">CONFIG</replaceable></option>
</term>
<listitem>
<para>Name of the configuration module.</para>
</listitem>
</varlistentry><varlistentry>
<term>
<option>--workdir=<replaceable class="parameter">WORKING_DIRECTORY</replaceable></option>
</term>
<listitem>
<para>Optional directory to change to after detaching.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--quiet</option>
</term>
</varlistentry>
<varlistentry>
<term>
<option>-C</option>
<option>--no-color</option>
</term>
</varlistentry>
<varlistentry>
<term>
<option>--version</option>
</term>
<listitem>
<para>Show program's version number and exit.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>-h</option>
<option>--help</option>
</term>
<listitem>
<para>Show help message and exit.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>celeryd(1), celerybeat (1), celeryctl (1).</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>This manual page was written by &dhusername; &dhemail; for
the &debian; system (and may be used by others). Permission is
granted to copy, distribute and/or modify this document under
the terms of the &gnu; General Public License, Version 2 any
later version published by the Free Software Foundation.
</para>
<para>
On Debian systems, the complete text of the GNU General Public
License can be found in /usr/share/common-licenses/GPL.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
|
