Changelog 142 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524
  1. ================
  2. Change history
  3. ================
  4. .. contents::
  5. :local:
  6. .. _version-2.2.10:
  7. 2.2.10
  8. ======
  9. :release-date: 2012-02-07 04:40 P.M GMT
  10. * Fixes infinite loop in ``safe_str`` (Issue #481).
  11. .. _version-2.2.9:
  12. 2.2.9
  13. =====
  14. :release-date: 2011-12-13 11:00 A.M GMT
  15. * The group id was not changed if both ``--uid`` and ``--gid`` specified.
  16. .. _version-2.2.8:
  17. 2.2.8
  18. =====
  19. :release-date: 2011-11-25 16:00 P.M GMT
  20. :by: Ask Solem
  21. .. _v228-security-fixes:
  22. Security Fixes
  23. --------------
  24. * [Security: `CELERYSA-0001`_] Daemons would set effective id's rather than
  25. real id's when the :option:`--uid`/:option:`--gid` arguments to
  26. :program:`celeryd-multi`, :program:`celeryd_detach`,
  27. :program:`celerybeat` and :program:`celeryev` were used.
  28. This means privileges weren't properly dropped, and that it would
  29. be possible to regain supervisor privileges later.
  30. .. _`CELERYSA-0001`:
  31. http://github.com/ask/celery/tree/master/docs/sec/CELERYSA-0001.txt
  32. .. _version-2.2.7:
  33. 2.2.7
  34. =====
  35. :release-date: 2011-06-13 16:00 P.M BST
  36. * New signals: :signal:`after_setup_logger` and
  37. :signal:`after_setup_task_logger`
  38. These signals can be used to augment logging configuration
  39. after Celery has set up logging.
  40. * Redis result backend now works with Redis 2.4.4.
  41. * celeryd_multi: The :option:`--gid` option now works correctly.
  42. * celeryd: Retry wrongfully used the repr of the traceback instead
  43. of the string representation.
  44. * App.config_from_object: Now loads module, not attribute of module.
  45. * Fixed issue where logging of objects would give "<Unrepresentable: ...>"
  46. .. _version-2.2.6:
  47. 2.2.6
  48. =====
  49. :release-date: 2011-04-15 16:00 P.M CEST
  50. .. _v226-important:
  51. Important Notes
  52. ---------------
  53. * Now depends on Kombu 1.1.2.
  54. * Dependency lists now explicitly specifies that we don't want python-dateutil
  55. 2.x, as this version only supports py3k.
  56. If you have installed dateutil 2.0 by accident you should downgrade
  57. to the 1.5.0 version::
  58. pip install -U python-dateutil==1.5.0
  59. or by easy_install::
  60. easy_install -U python-dateutil==1.5.0
  61. .. _v226-fixes:
  62. Fixes
  63. -----
  64. * The new ``WatchedFileHandler`` broke Python 2.5 support (Issue #367).
  65. * Task: Don't use ``app.main`` if the task name is set explicitly.
  66. * Sending emails did not work on Python 2.5, due to a bug in
  67. the version detection code (Issue #378).
  68. * Beat: Adds method ``ScheduleEntry._default_now``
  69. This method can be overridden to change the default value
  70. of ``last_run_at``.
  71. * An error occurring in process cleanup could mask task errors.
  72. We no longer propagate errors happening at process cleanup,
  73. but log them instead. This way they will not interfere with publishing
  74. the task result (Issue #365).
  75. * Defining tasks did not work properly when using the Django
  76. ``shell_plus`` utility (Issue #366).
  77. * ``AsyncResult.get`` did not accept the ``interval`` and ``propagate``
  78. arguments.
  79. * celeryd: Fixed a bug where celeryd would not shutdown if a
  80. :exc:`socket.error` was raised.
  81. .. _version-2.2.5:
  82. 2.2.5
  83. =====
  84. :release-date: 2011-03-28 06:00 P.M CEST
  85. .. _v225-important:
  86. Important Notes
  87. ---------------
  88. * Now depends on Kombu 1.0.7
  89. .. _v225-news:
  90. News
  91. ----
  92. * Our documentation is now hosted by Read The Docs
  93. (http://docs.celeryproject.org), and all links have been changed to point to
  94. the new URL.
  95. * Logging: Now supports log rotation using external tools like `logrotate.d`_
  96. (Issue #321)
  97. This is accomplished by using the ``WatchedFileHandler``, which re-opens
  98. the file if it is renamed or deleted.
  99. .. _`logrotate.d`:
  100. http://www.ducea.com/2006/06/06/rotating-linux-log-files-part-2-logrotate/
  101. * :ref:`tut-otherqueues` now documents how to configure Redis/Database result
  102. backends.
  103. * gevent: Now supports ETA tasks.
  104. But gevent still needs ``CELERY_DISABLE_RATE_LIMITS=True`` to work.
  105. * TaskSet User Guide: now contains TaskSet callback recipes.
  106. * Eventlet: New signals:
  107. * ``eventlet_pool_started``
  108. * ``eventlet_pool_preshutdown``
  109. * ``eventlet_pool_postshutdown``
  110. * ``eventlet_pool_apply``
  111. See :ref:`signals` for more information.
  112. * New :setting:`BROKER_TRANSPORT_OPTIONS` setting can be used to pass
  113. additional arguments to a particular broker transport.
  114. * celeryd: ``worker_pid`` is now part of the request info as returned by
  115. broadcast commands.
  116. * TaskSet.apply/Taskset.apply_async now accepts an optional ``taskset_id``
  117. argument.
  118. * The taskset_id (if any) is now available in the Task request context.
  119. * SQLAlchemy result backend: taskset_id and taskset_id columns now have a
  120. unique constraint. (Tables need to recreated for this to take affect).
  121. * Task Userguide: Added section about choosing a result backend.
  122. * Removed unused attribute ``AsyncResult.uuid``.
  123. .. _v225-fixes:
  124. Fixes
  125. -----
  126. * multiprocessing.Pool: Fixes race condition when marking job with
  127. ``WorkerLostError`` (Issue #268).
  128. The process may have published a result before it was terminated,
  129. but we have no reliable way to detect that this is the case.
  130. So we have to wait for 10 seconds before marking the result with
  131. WorkerLostError. This gives the result handler a chance to retrieve the
  132. result.
  133. * multiprocessing.Pool: Shutdown could hang if rate limits disabled.
  134. There was a race condition when the MainThread was waiting for the pool
  135. semaphore to be released. The ResultHandler now terminates after 5
  136. seconds if there are unacked jobs, but no worker processes left to start
  137. them (it needs to timeout because there could still be an ack+result
  138. that we haven't consumed from the result queue. It
  139. is unlikely we will receive any after 5 seconds with no worker processes).
  140. * celerybeat: Now creates pidfile even if the ``--detach`` option is not set.
  141. * eventlet/gevent: The broadcast command consumer is now running in a separate
  142. greenthread.
  143. This ensures broadcast commands will take priority even if there are many
  144. active tasks.
  145. * Internal module ``celery.worker.controllers`` renamed to
  146. ``celery.worker.mediator``.
  147. * celeryd: Threads now terminates the program by calling ``os._exit``, as it
  148. is the only way to ensure exit in the case of syntax errors, or other
  149. unrecoverable errors.
  150. * Fixed typo in ``maybe_timedelta`` (Issue #352).
  151. * celeryd: Broadcast commands now logs with loglevel debug instead of warning.
  152. * AMQP Result Backend: Now resets cached channel if the connection is lost.
  153. * Polling results with the AMQP result backend was not working properly.
  154. * Rate limits: No longer sleeps if there are no tasks, but rather waits for
  155. the task received condition (Performance improvement).
  156. * ConfigurationView: ``iter(dict)`` should return keys, not items (Issue #362).
  157. * celerybeat: PersistentScheduler now automatically removes a corrupted
  158. schedule file (Issue #346).
  159. * Programs that doesn't support positional command line arguments now provides
  160. a user friendly error message.
  161. * Programs no longer tries to load the configuration file when showing
  162. ``--version`` (Issue #347).
  163. * Autoscaler: The "all processes busy" log message is now severity debug
  164. instead of error.
  165. * celeryd: If the message body can't be decoded, it is now passed through
  166. ``safe_str`` when logging.
  167. This to ensure we don't get additional decoding errors when trying to log
  168. the failure.
  169. * ``app.config_from_object``/``app.config_from_envvar`` now works for all
  170. loaders.
  171. * Now emits a user-friendly error message if the result backend name is
  172. unknown (Issue #349).
  173. * :mod:`celery.contrib.batches`: Now sets loglevel and logfile in the task
  174. request so ``task.get_logger`` works with batch tasks (Issue #357).
  175. * celeryd: An exception was raised if using the amqp transport and the prefetch
  176. count value exceeded 65535 (Issue #359).
  177. The prefetch count is incremented for every received task with an
  178. ETA/countdown defined. The prefetch count is a short, so can only support
  179. a maximum value of 65535. If the value exceeds the maximum value we now
  180. disable the prefetch count, it is re-enabled as soon as the value is below
  181. the limit again.
  182. * cursesmon: Fixed unbound local error (Issue #303).
  183. * eventlet/gevent is now imported on demand so autodoc can import the modules
  184. without having eventlet/gevent installed.
  185. * celeryd: Ack callback now properly handles ``AttributeError``.
  186. * ``Task.after_return`` is now always called *after* the result has been
  187. written.
  188. * Cassandra Result Backend: Should now work with the latest ``pycassa``
  189. version.
  190. * multiprocessing.Pool: No longer cares if the putlock semaphore is released
  191. too many times. (this can happen if one or more worker processes are
  192. killed).
  193. * SQLAlchemy Result Backend: Now returns accidentally removed ``date_done`` again
  194. (Issue #325).
  195. * Task.request contex is now always initialized to ensure calling the task
  196. function directly works even if it actively uses the request context.
  197. * Exception occuring when iterating over the result from ``TaskSet.apply``
  198. fixed.
  199. * eventlet: Now properly schedules tasks with an ETA in the past.
  200. .. _version-2.2.4:
  201. 2.2.4
  202. =====
  203. :release-date: 2011-02-19 12:00 AM CET
  204. .. _v224-fixes:
  205. Fixes
  206. -----
  207. * celeryd: 2.2.3 broke error logging, resulting in tracebacks not being logged.
  208. * AMQP result backend: Polling task states did not work properly if there were
  209. more than one result message in the queue.
  210. * ``TaskSet.apply_async()`` and ``TaskSet.apply()`` now supports an optional
  211. ``taskset_id`` keyword argument (Issue #331).
  212. * The current taskset id (if any) is now available in the task context as
  213. ``request.taskset`` (Issue #329).
  214. * SQLAlchemy result backend: `date_done` was no longer part of the results as it had
  215. been accidentally removed. It is now available again (Issue #325).
  216. * SQLAlchemy result backend: Added unique constraint on `Task.task_id` and
  217. `TaskSet.taskset_id`. Tables needs to be recreated for this to take effect.
  218. * Fixed exception raised when iterating on the result of ``TaskSet.apply()``.
  219. * Tasks Userguide: Added section on choosing a result backend.
  220. .. _version-2.2.3:
  221. 2.2.3
  222. =====
  223. :release-date: 2011-02-12 04:00 P.M CET
  224. .. _v223-fixes:
  225. Fixes
  226. -----
  227. * Now depends on Kombu 1.0.3
  228. * Task.retry now supports a ``max_retries`` argument, used to change the
  229. default value.
  230. * `multiprocessing.cpu_count` may raise :exc:`NotImplementedError` on
  231. platforms where this is not supported (Issue #320).
  232. * Coloring of log messages broke if the logged object was not a string.
  233. * Fixed several typos in the init script documentation.
  234. * A regression caused `Task.exchange` and `Task.routing_key` to no longer
  235. have any effect. This is now fixed.
  236. * Routing Userguide: Fixes typo, routers in :setting:`CELERY_ROUTES` must be
  237. instances, not classes.
  238. * :program:`celeryev` did not create pidfile even though the
  239. :option:`--pidfile` argument was set.
  240. * Task logger format was no longer used. (Issue #317).
  241. The id and name of the task is now part of the log message again.
  242. * A safe version of ``repr()`` is now used in strategic places to ensure
  243. objects with a broken ``__repr__`` does not crash the worker, or otherwise
  244. make errors hard to understand (Issue #298).
  245. * Remote control command ``active_queues``: did not account for queues added
  246. at runtime.
  247. In addition the dictionary replied by this command now has a different
  248. structure: the exchange key is now a dictionary containing the
  249. exchange declaration in full.
  250. * The :option:`-Q` option to :program:`celeryd` removed unused queue
  251. declarations, so routing of tasks could fail.
  252. Queues are no longer removed, but rather `app.amqp.queues.consume_from()`
  253. is used as the list of queues to consume from.
  254. This ensures all queues are available for routing purposes.
  255. * celeryctl: Now supports the `inspect active_queues` command.
  256. .. _version-2.2.2:
  257. 2.2.2
  258. =====
  259. :release-date: 2011-02-03 04:00 P.M CET
  260. .. _v222-fixes:
  261. Fixes
  262. -----
  263. * Celerybeat could not read the schedule properly, so entries in
  264. :setting:`CELERYBEAT_SCHEDULE` would not be scheduled.
  265. * Task error log message now includes `exc_info` again.
  266. * The `eta` argument can now be used with `task.retry`.
  267. Previously it was overwritten by the countdown argument.
  268. * celeryd-multi/celeryd_detach: Now logs errors occuring when executing
  269. the `celeryd` command.
  270. * daemonizing cookbook: Fixed typo ``--time-limit 300`` ->
  271. ``--time-limit=300``
  272. * Colors in logging broke non-string objects in log messages.
  273. * ``setup_task_logger`` no longer makes assumptions about magic task kwargs.
  274. .. _version-2.2.1:
  275. 2.2.1
  276. =====
  277. :release-date: 2011-02-02 04:00 P.M CET
  278. .. _v221-fixes:
  279. Fixes
  280. -----
  281. * Eventlet pool was leaking memory (Issue #308).
  282. * Deprecated function ``celery.execute.delay_task`` was accidentally removed,
  283. now available again.
  284. * ``BasePool.on_terminate`` stub did not exist
  285. * celeryd detach: Adds readable error messages if user/group name does not
  286. exist.
  287. * Smarter handling of unicode decod errors when logging errors.
  288. .. _version-2.2.0:
  289. 2.2.0
  290. =====
  291. :release-date: 2011-02-01 10:00 AM CET
  292. .. _v220-important:
  293. Important Notes
  294. ---------------
  295. * Carrot has been replaced with `Kombu`_
  296. Kombu is the next generation messaging framework for Python,
  297. fixing several flaws present in Carrot that was hard to fix
  298. without breaking backwards compatibility.
  299. Also it adds:
  300. * First-class support for virtual transports; Redis, Django ORM,
  301. SQLAlchemy, Beanstalk, MongoDB, CouchDB and in-memory.
  302. * Consistent error handling with introspection,
  303. * The ability to ensure that an operation is performed by gracefully
  304. handling connection and channel errors,
  305. * Message compression (zlib, bzip2, or custom compression schemes).
  306. This means that `ghettoq` is no longer needed as the
  307. functionality it provided is already available in Celery by default.
  308. The virtual transports are also more feature complete with support
  309. for exchanges (direct and topic). The Redis transport even supports
  310. fanout exchanges so it is able to perform worker remote control
  311. commands.
  312. .. _`Kombu`: http://pypi.python.org/pypi/kombu
  313. * Magic keyword arguments pending deprecation.
  314. The magic keyword arguments were responsibile for many problems
  315. and quirks: notably issues with tasks and decorators, and name
  316. collisions in keyword arguments for the unaware.
  317. It wasn't easy to find a way to deprecate the magic keyword arguments,
  318. but we think this is a solution that makes sense and it will not
  319. have any adverse effects for existing code.
  320. The path to a magic keyword argument free world is:
  321. * the `celery.decorators` module is deprecated and the decorators
  322. can now be found in `celery.task`.
  323. * The decorators in `celery.task` disables keyword arguments by
  324. default
  325. * All examples in the documentation have been changed to use
  326. `celery.task`.
  327. This means that the following will have magic keyword arguments
  328. enabled (old style):
  329. .. code-block:: python
  330. from celery.decorators import task
  331. @task
  332. def add(x, y, **kwargs):
  333. print("In task %s" % kwargs["task_id"])
  334. return x + y
  335. And this will not use magic keyword arguments (new style):
  336. .. code-block:: python
  337. from celery.task import task
  338. @task
  339. def add(x, y):
  340. print("In task %s" % add.request.id)
  341. return x + y
  342. In addition, tasks can choose not to accept magic keyword arguments by
  343. setting the `task.accept_magic_kwargs` attribute.
  344. .. admonition:: Deprecation
  345. Using the decorators in :mod:`celery.decorators` emits a
  346. :class:`PendingDeprecationWarning` with a helpful message urging
  347. you to change your code, in version 2.4 this will be replaced with
  348. a :class:`DeprecationWarning`, and in version 3.0 the
  349. :mod:`celery.decorators` module will be removed and no longer exist.
  350. Similarly, the `task.accept_magic_kwargs` attribute will no
  351. longer have any effect starting from version 3.0.
  352. * The magic keyword arguments are now available as `task.request`
  353. This is called *the context*. Using thread-local storage the
  354. context contains state that is related to the current request.
  355. It is mutable and you can add custom attributes that will only be seen
  356. by the current task request.
  357. The following context attributes are always available:
  358. ===================================== ===================================
  359. **Magic Keyword Argument** **Replace with**
  360. ===================================== ===================================
  361. `kwargs["task_id"]` `self.request.id`
  362. `kwargs["delivery_info"]` `self.request.delivery_info`
  363. `kwargs["task_retries"]` `self.request.retries`
  364. `kwargs["logfile"]` `self.request.logfile`
  365. `kwargs["loglevel"]` `self.request.loglevel`
  366. `kwargs["task_is_eager` `self.request.is_eager`
  367. **NEW** `self.request.args`
  368. **NEW** `self.request.kwargs`
  369. ===================================== ===================================
  370. In addition, the following methods now automatically uses the current
  371. context, so you don't have to pass `kwargs` manually anymore:
  372. * `task.retry`
  373. * `task.get_logger`
  374. * `task.update_state`
  375. * `Eventlet`_ support.
  376. This is great news for I/O-bound tasks!
  377. To change pool implementations you use the :option:`-P|--pool` argument
  378. to :program:`celeryd`, or globally using the
  379. :setting:`CELERYD_POOL` setting. This can be the full name of a class,
  380. or one of the following aliases: `processes`, `eventlet`, `gevent`.
  381. For more information please see the :ref:`concurrency-eventlet` section
  382. in the User Guide.
  383. .. admonition:: Why not gevent?
  384. For our first alternative concurrency implementation we have focused
  385. on `Eventlet`_, but there is also an experimental `gevent`_ pool
  386. available. This is missing some features, notably the ability to
  387. schedule ETA tasks.
  388. Hopefully the `gevent`_ support will be feature complete by
  389. version 2.3, but this depends on user demand (and contributions).
  390. .. _`Eventlet`: http://eventlet.net
  391. .. _`gevent`: http://gevent.org
  392. * Python 2.4 support deprecated!
  393. We're happy^H^H^H^H^Hsad to announce that this is the last version
  394. to support Python 2.4.
  395. You are urged to make some noise if you're currently stuck with
  396. Python 2.4. Complain to your package maintainers, sysadmins and bosses:
  397. tell them it's time to move on!
  398. Apart from wanting to take advantage of with-statements, coroutines,
  399. conditional expressions and enhanced try blocks, the code base
  400. now contains so many 2.4 related hacks and workarounds it's no longer
  401. just a compromise, but a sacrifice.
  402. If it really isn't your choice, and you don't have the option to upgrade
  403. to a newer version of Python, you can just continue to use Celery 2.2.
  404. Important fixes can be backported for as long as there is interest.
  405. * `celeryd`: Now supports Autoscaling of child worker processes.
  406. The :option:`--autoscale` option can be used to configure the minimum
  407. and maximum number of child worker processes::
  408. --autoscale=AUTOSCALE
  409. Enable autoscaling by providing
  410. max_concurrency,min_concurrency. Example:
  411. --autoscale=10,3 (always keep 3 processes, but grow to
  412. 10 if necessary).
  413. * Remote Debugging of Tasks
  414. ``celery.contrib.rdb`` is an extended version of :mod:`pdb` that
  415. enables remote debugging of processes that does not have terminal
  416. access.
  417. Example usage:
  418. .. code-block:: python
  419. from celery.contrib import rdb
  420. from celery.task import task
  421. @task
  422. def add(x, y):
  423. result = x + y
  424. rdb.set_trace() # <- set breakpoint
  425. return result
  426. :func:`~celery.contrib.rdb.set_trace` sets a breakpoint at the current
  427. location and creates a socket you can telnet into to remotely debug
  428. your task.
  429. The debugger may be started by multiple processes at the same time,
  430. so rather than using a fixed port the debugger will search for an
  431. available port, starting from the base port (6900 by default).
  432. The base port can be changed using the environment variable
  433. :envvar:`CELERY_RDB_PORT`.
  434. By default the debugger will only be available from the local host,
  435. to enable access from the outside you have to set the environment
  436. variable :envvar:`CELERY_RDB_HOST`.
  437. When `celeryd` encounters your breakpoint it will log the following
  438. information::
  439. [INFO/MainProcess] Got task from broker:
  440. tasks.add[d7261c71-4962-47e5-b342-2448bedd20e8]
  441. [WARNING/PoolWorker-1] Remote Debugger:6900:
  442. Please telnet 127.0.0.1 6900. Type `exit` in session to continue.
  443. [2011-01-18 14:25:44,119: WARNING/PoolWorker-1] Remote Debugger:6900:
  444. Waiting for client...
  445. If you telnet the port specified you will be presented
  446. with a ``pdb`` shell::
  447. $ telnet localhost 6900
  448. Connected to localhost.
  449. Escape character is '^]'.
  450. > /opt/devel/demoapp/tasks.py(128)add()
  451. -> return result
  452. (Pdb)
  453. Enter ``help`` to get a list of available commands,
  454. It may be a good idea to read the `Python Debugger Manual`_ if
  455. you have never used `pdb` before.
  456. .. _`Python Debugger Manual`: http://docs.python.org/library/pdb.html
  457. * Events are now transient and is using a topic exchange (instead of direct).
  458. The `CELERYD_EVENT_EXCHANGE`, `CELERYD_EVENT_ROUTING_KEY`,
  459. `CELERYD_EVENT_EXCHANGE_TYPE` settings are no longer in use.
  460. This means events will not be stored until there is a consumer, and the
  461. events will be gone as soon as the consumer stops. Also it means there
  462. can be multiple monitors running at the same time.
  463. The routing key of an event is the type of event (e.g. `worker.started`,
  464. `worker.heartbeat`, `task.succeeded`, etc. This means a consumer can
  465. filter on specific types, to only be alerted of the events it cares about.
  466. Each consumer will create a unique queue, meaning it is in effect a
  467. broadcast exchange.
  468. This opens up a lot of possibilities, for example the workers could listen
  469. for worker events to know what workers are in the neighborhood, and even
  470. restart workers when they go down (or use this information to optimize
  471. tasks/autoscaling).
  472. .. note::
  473. The event exchange has been renamed from "celeryevent" to "celeryev"
  474. so it does not collide with older versions.
  475. If you would like to remove the old exchange you can do so
  476. by executing the following command::
  477. $ camqadm exchange.delete celeryevent
  478. * `celeryd` now starts without configuration, and configuration can be
  479. specified directly on the command line.
  480. Configuration options must appear after the last argument, separated
  481. by two dashes::
  482. $ celeryd -l info -I tasks -- broker.host=localhost broker.vhost=/app
  483. * Configuration is now an alias to the original configuration, so changes
  484. to the original will reflect Celery at runtime.
  485. * `celery.conf` has been deprecated, and modifying `celery.conf.ALWAYS_EAGER`
  486. will no longer have any effect.
  487. The default configuration is now available in the
  488. :mod:`celery.app.defaults` module. The available configuration options
  489. and their types can now be introspected.
  490. * Remote control commands are now provided by `kombu.pidbox`, the generic
  491. process mailbox.
  492. * Internal module `celery.worker.listener` has been renamed to
  493. `celery.worker.consumer`, and `.CarrotListener` is now `.Consumer`.
  494. * Previously deprecated modules `celery.models` and
  495. `celery.management.commands` have now been removed as per the deprecation
  496. timeline.
  497. * [Security: Low severity] Removed `celery.task.RemoteExecuteTask` and
  498. accompanying functions: `dmap`, `dmap_async`, and `execute_remote`.
  499. Executing arbitrary code using pickle is a potential security issue if
  500. someone gains unrestricted access to the message broker.
  501. If you really need this functionality, then you would have to add
  502. this to your own project.
  503. * [Security: Low severity] The `stats` command no longer transmits the
  504. broker password.
  505. One would have needed an authenticated broker connection to receive
  506. this password in the first place, but sniffing the password at the
  507. wire level would have been possible if using unencrypted communication.
  508. .. _v220-news:
  509. News
  510. ----
  511. * The internal module `celery.task.builtins` has been removed.
  512. * The module `celery.task.schedules` is deprecated, and
  513. `celery.schedules` should be used instead.
  514. For example if you have::
  515. from celery.task.schedules import crontab
  516. You should replace that with::
  517. from celery.schedules import crontab
  518. The module needs to be renamed because it must be possible
  519. to import schedules without importing the `celery.task` module.
  520. * The following functions have been deprecated and is scheduled for
  521. removal in version 2.3:
  522. * `celery.execute.apply_async`
  523. Use `task.apply_async()` instead.
  524. * `celery.execute.apply`
  525. Use `task.apply()` instead.
  526. * `celery.execute.delay_task`
  527. Use `registry.tasks[name].delay()` instead.
  528. * Importing `TaskSet` from `celery.task.base` is now deprecated.
  529. You should use::
  530. >>> from celery.task import TaskSet
  531. instead.
  532. * New remote control commands:
  533. * `active_queues`
  534. Returns the queue declarations a worker is currently consuming from.
  535. * Added the ability to retry publishing the task message in
  536. the event of connection loss or failure.
  537. This is disabled by default but can be enabled using the
  538. :setting:`CELERY_TASK_PUBLISH_RETRY` setting, and tweaked by
  539. the :setting:`CELERY_TASK_PUBLISH_RETRY_POLICY` setting.
  540. In addition `retry`, and `retry_policy` keyword arguments have
  541. been added to `Task.apply_async`.
  542. .. note::
  543. Using the `retry` argument to `apply_async` requires you to
  544. handle the publisher/connection manually.
  545. * Periodic Task classes (`@periodic_task`/`PeriodicTask`) will *not* be
  546. deprecated as previously indicated in the source code.
  547. But you are encouraged to use the more flexible
  548. :setting:`CELERYBEAT_SCHEDULE` setting.
  549. * Built-in daemonization support of celeryd using `celeryd-multi`
  550. is no longer experimental and is considered production quality.
  551. See :ref:`daemon-generic` if you want to use the new generic init
  552. scripts.
  553. * Added support for message compression using the
  554. :setting:`CELERY_MESSAGE_COMPRESSION` setting, or the `compression` argument
  555. to `apply_async`. This can also be set using routers.
  556. * `celeryd`: Now logs stacktrace of all threads when receiving the
  557. `SIGUSR1` signal. (Does not work on cPython 2.4, Windows or Jython).
  558. Inspired by https://gist.github.com/737056
  559. * Can now remotely terminate/kill the worker process currently processing
  560. a task.
  561. The `revoke` remote control command now supports a `terminate` argument
  562. Default signal is `TERM`, but can be specified using the `signal`
  563. argument. Signal can be the uppercase name of any signal defined
  564. in the :mod:`signal` module in the Python Standard Library.
  565. Terminating a task also revokes it.
  566. Example::
  567. >>> from celery.task.control import revoke
  568. >>> revoke(task_id, terminate=True)
  569. >>> revoke(task_id, terminate=True, signal="KILL")
  570. >>> revoke(task_id, terminate=True, signal="SIGKILL")
  571. * `TaskSetResult.join_native`: Backend-optimized version of `join()`.
  572. If available, this version uses the backends ability to retrieve
  573. multiple results at once, unlike `join()` which fetches the results
  574. one by one.
  575. So far only supported by the AMQP result backend. Support for memcached
  576. and Redis may be added later.
  577. * Improved implementations of `TaskSetResult.join` and `AsyncResult.wait`.
  578. An `interval` keyword argument have been added to both so the
  579. polling interval can be specified (default interval is 0.5 seconds).
  580. A `propagate` keyword argument have been added to `result.wait()`,
  581. errors will be returned instead of raised if this is set to False.
  582. .. warning::
  583. You should decrease the polling interval when using the database
  584. result backend, as frequent polling can result in high database load.
  585. * The PID of the child worker process accepting a task is now sent as a field
  586. with the `task-started` event.
  587. * The following fields have been added to all events in the worker class:
  588. * `sw_ident`: Name of worker software (e.g. celeryd).
  589. * `sw_ver`: Software version (e.g. 2.2.0).
  590. * `sw_sys`: Operating System (e.g. Linux, Windows, Darwin).
  591. * For better accuracy the start time reported by the multiprocessing worker
  592. process is used when calculating task duration.
  593. Previously the time reported by the accept callback was used.
  594. * `celerybeat`: New built-in daemonization support using the `--detach`
  595. option.
  596. * `celeryev`: New built-in daemonization support using the `--detach`
  597. option.
  598. * `TaskSet.apply_async`: Now supports custom publishers by using the
  599. `publisher` argument.
  600. * Added :setting:`CELERY_SEND_TASK_SENT_EVENT` setting.
  601. If enabled an event will be sent with every task, so monitors can
  602. track tasks before the workers receive them.
  603. * `celerybeat`: Now reuses the broker connection when applying
  604. scheduled tasks.
  605. * The configuration module and loader to use can now be specified on
  606. the command line.
  607. For example::
  608. $ celeryd --config=celeryconfig.py --loader=myloader.Loader
  609. * Added signals: `beat_init` and `beat_embedded_init`
  610. * :signal:`celery.signals.beat_init`
  611. Dispatched when :program:`celerybeat` starts (either standalone or
  612. embedded). Sender is the :class:`celery.beat.Service` instance.
  613. * :signal:`celery.signals.beat_embedded_init`
  614. Dispatched in addition to the :signal:`beat_init` signal when
  615. :program:`celerybeat` is started as an embedded process. Sender
  616. is the :class:`celery.beat.Service` instance.
  617. * Redis result backend: Removed deprecated settings `REDIS_TIMEOUT` and
  618. `REDIS_CONNECT_RETRY`.
  619. * CentOS init script for :program:`celeryd` now available in `contrib/centos`.
  620. * Now depends on `pyparsing` version 1.5.0 or higher.
  621. There have been reported issues using Celery with pyparsing 1.4.x,
  622. so please upgrade to the latest version.
  623. * Lots of new unit tests written, now with a total coverage of 95%.
  624. .. _v220-fixes:
  625. Fixes
  626. -----
  627. * `celeryev` Curses Monitor: Improved resize handling and UI layout
  628. (Issue #274 + Issue #276)
  629. * AMQP Backend: Exceptions occurring while sending task results are now
  630. propagated instead of silenced.
  631. `celeryd` will then show the full traceback of these errors in the log.
  632. * AMQP Backend: No longer deletes the result queue after successful
  633. poll, as this should be handled by the
  634. :setting:`CELERY_AMQP_TASK_RESULT_EXPIRES` setting instead.
  635. * AMQP Backend: Now ensures queues are declared before polling results.
  636. * Windows: celeryd: Show error if running with `-B` option.
  637. Running celerybeat embedded is known not to work on Windows, so
  638. users are encouraged to run celerybeat as a separate service instead.
  639. * Windows: Utilities no longer output ANSI color codes on Windows
  640. * camqadm: Now properly handles Ctrl+C by simply exiting instead of showing
  641. confusing traceback.
  642. * Windows: All tests are now passing on Windows.
  643. * Remove bin/ directory, and `scripts` section from setup.py.
  644. This means we now rely completely on setuptools entrypoints.
  645. .. _v220-experimental:
  646. Experimental
  647. ------------
  648. * Jython: celeryd now runs on Jython using the threaded pool.
  649. All tests pass, but there may still be bugs lurking around the corners.
  650. * PyPy: celeryd now runs on PyPy.
  651. It runs without any pool, so to get parallel execution you must start
  652. multiple instances (e.g. using :program:`celeryd-multi`).
  653. Sadly an initial benchmark seems to show a 30% performance decrease on
  654. pypy-1.4.1 + JIT. We would like to find out why this is, so stay tuned.
  655. * :class:`PublisherPool`: Experimental pool of task publishers and
  656. connections to be used with the `retry` argument to `apply_async`.
  657. The example code below will re-use connections and channels, and
  658. retry sending of the task message if the connection is lost.
  659. .. code-block:: python
  660. from celery import current_app
  661. # Global pool
  662. pool = current_app().amqp.PublisherPool(limit=10)
  663. def my_view(request):
  664. with pool.acquire() as publisher:
  665. add.apply_async((2, 2), publisher=publisher, retry=True)
  666. .. _version-2.1.4:
  667. 2.1.4
  668. =====
  669. :release-date: 2010-12-03 12:00 P.M CEST
  670. .. _v214-fixes:
  671. Fixes
  672. -----
  673. * Execution options to `apply_async` now takes precedence over options
  674. returned by active routers. This was a regression introduced recently
  675. (Issue #244).
  676. * `celeryev` curses monitor: Long arguments are now truncated so curses
  677. doesn't crash with out of bounds errors. (Issue #235).
  678. * `celeryd`: Channel errors occurring while handling control commands no
  679. longer crash the worker but are instead logged with severity error.
  680. * SQLAlchemy database backend: Fixed a race condition occurring when
  681. the client wrote the pending state. Just like the Django database backend,
  682. it does no longer save the pending state (Issue #261 + Issue #262).
  683. * Error email body now uses `repr(exception)` instead of `str(exception)`,
  684. as the latter could result in Unicode decode errors (Issue #245).
  685. * Error e-mail timeout value is now configurable by using the
  686. :setting:`EMAIL_TIMEOUT` setting.
  687. * `celeryev`: Now works on Windows (but the curses monitor won't work without
  688. having curses).
  689. * Unit test output no longer emits non-standard characters.
  690. * `celeryd`: The broadcast consumer is now closed if the connection is reset.
  691. * `celeryd`: Now properly handles errors occurring while trying to acknowledge
  692. the message.
  693. * `TaskRequest.on_failure` now encodes traceback using the current filesystem
  694. encoding. (Issue #286).
  695. * `EagerResult` can now be pickled (Issue #288).
  696. .. _v214-documentation:
  697. Documentation
  698. -------------
  699. * Adding :ref:`contributing`.
  700. * Added :ref:`guide-optimizing`.
  701. * Added :ref:`faq-security` section to the FAQ.
  702. .. _version-2.1.3:
  703. 2.1.3
  704. =====
  705. :release-date: 2010-11-09 05:00 P.M CEST
  706. .. _v213-fixes:
  707. * Fixed deadlocks in `timer2` which could lead to `djcelerymon`/`celeryev -c`
  708. hanging.
  709. * `EventReceiver`: now sends heartbeat request to find workers.
  710. This means :program:`celeryev` and friends finds workers immediately
  711. at startup.
  712. * celeryev cursesmon: Set screen_delay to 10ms, so the screen refreshes more
  713. often.
  714. * Fixed pickling errors when pickling :class:`AsyncResult` on older Python
  715. versions.
  716. * celeryd: prefetch count was decremented by eta tasks even if there
  717. were no active prefetch limits.
  718. .. _version-2.1.2:
  719. 2.1.2
  720. =====
  721. :release-data: TBA
  722. .. _v212-fixes:
  723. Fixes
  724. -----
  725. * celeryd: Now sends the `task-retried` event for retried tasks.
  726. * celeryd: Now honors ignore result for
  727. :exc:`~celery.exceptions.WorkerLostError` and timeout errors.
  728. * celerybeat: Fixed :exc:`UnboundLocalError` in celerybeat logging
  729. when using logging setup signals.
  730. * celeryd: All log messages now includes `exc_info`.
  731. .. _version-2.1.1:
  732. 2.1.1
  733. =====
  734. :release-date: 2010-10-14 02:00 P.M CEST
  735. .. _v211-fixes:
  736. Fixes
  737. -----
  738. * Now working on Windows again.
  739. Removed dependency on the pwd/grp modules.
  740. * snapshots: Fixed race condition leading to loss of events.
  741. * celeryd: Reject tasks with an eta that cannot be converted to a time stamp.
  742. See issue #209
  743. * concurrency.processes.pool: The semaphore was released twice for each task
  744. (both at ACK and result ready).
  745. This has been fixed, and it is now released only once per task.
  746. * docs/configuration: Fixed typo `CELERYD_SOFT_TASK_TIME_LIMIT` ->
  747. :setting:`CELERYD_TASK_SOFT_TIME_LIMIT`.
  748. See issue #214
  749. * control command `dump_scheduled`: was using old .info attribute
  750. * :program:`celeryd-multi`: Fixed `set changed size during iteration` bug
  751. occurring in the restart command.
  752. * celeryd: Accidentally tried to use additional command line arguments.
  753. This would lead to an error like:
  754. `got multiple values for keyword argument 'concurrency'`.
  755. Additional command line arguments are now ignored, and does not
  756. produce this error. However -- we do reserve the right to use
  757. positional arguments in the future, so please do not depend on this
  758. behavior.
  759. * celerybeat: Now respects routers and task execution options again.
  760. * celerybeat: Now reuses the publisher instead of the connection.
  761. * Cache result backend: Using :class:`float` as the expires argument
  762. to `cache.set` is deprecated by the memcached libraries,
  763. so we now automatically cast to :class:`int`.
  764. * unit tests: No longer emits logging and warnings in test output.
  765. .. _v211-news:
  766. News
  767. ----
  768. * Now depends on carrot version 0.10.7.
  769. * Added :setting:`CELERY_REDIRECT_STDOUTS`, and
  770. :setting:`CELERYD_REDIRECT_STDOUTS_LEVEL` settings.
  771. :setting:`CELERY_REDIRECT_STDOUTS` is used by :program:`celeryd` and
  772. :program:`celerybeat`. All output to `stdout` and `stderr` will be
  773. redirected to the current logger if enabled.
  774. :setting:`CELERY_REDIRECT_STDOUTS_LEVEL` decides the log level used and is
  775. :const:`WARNING` by default.
  776. * Added :setting:`CELERYBEAT_SCHEDULER` setting.
  777. This setting is used to define the default for the -S option to
  778. :program:`celerybeat`.
  779. Example:
  780. .. code-block:: python
  781. CELERYBEAT_SCHEDULER = "djcelery.schedulers.DatabaseScheduler"
  782. * Added Task.expires: Used to set default expiry time for tasks.
  783. * New remote control commands: `add_consumer` and `cancel_consumer`.
  784. .. method:: add_consumer(queue, exchange, exchange_type, routing_key,
  785. **options)
  786. :module:
  787. Tells the worker to declare and consume from the specified
  788. declaration.
  789. .. method:: cancel_consumer(queue_name)
  790. :module:
  791. Tells the worker to stop consuming from queue (by queue name).
  792. Commands also added to :program:`celeryctl` and
  793. :class:`~celery.task.control.inspect`.
  794. Example using celeryctl to start consuming from queue "queue", in
  795. exchange "exchange", of type "direct" using binding key "key"::
  796. $ celeryctl inspect add_consumer queue exchange direct key
  797. $ celeryctl inspect cancel_consumer queue
  798. See :ref:`monitoring-celeryctl` for more information about the
  799. :program:`celeryctl` program.
  800. Another example using :class:`~celery.task.control.inspect`:
  801. .. code-block:: python
  802. >>> from celery.task.control import inspect
  803. >>> inspect.add_consumer(queue="queue", exchange="exchange",
  804. ... exchange_type="direct",
  805. ... routing_key="key",
  806. ... durable=False,
  807. ... auto_delete=True)
  808. >>> inspect.cancel_consumer("queue")
  809. * celerybeat: Now logs the traceback if a message can't be sent.
  810. * celerybeat: Now enables a default socket timeout of 30 seconds.
  811. * README/introduction/homepage: Added link to `Flask-Celery`_.
  812. .. _`Flask-Celery`: http://github.com/ask/flask-celery
  813. .. _version-2.1.0:
  814. 2.1.0
  815. =====
  816. :release-date: 2010-10-08 12:00 P.M CEST
  817. .. _v210-important:
  818. Important Notes
  819. ---------------
  820. * Celery is now following the versioning semantics defined by `semver`_.
  821. This means we are no longer allowed to use odd/even versioning semantics
  822. By our previous versioning scheme this stable release should have
  823. been version 2.2.
  824. .. _`semver`: http://semver.org
  825. * Now depends on Carrot 0.10.7.
  826. * No longer depends on SQLAlchemy, this needs to be installed separately
  827. if the database result backend is used.
  828. * django-celery now comes with a monitor for the Django Admin interface.
  829. This can also be used if you're not a Django user. See
  830. :ref:`monitoring-django-admin` and :ref:`monitoring-nodjango` for more information.
  831. * If you get an error after upgrading saying:
  832. `AttributeError: 'module' object has no attribute 'system'`,
  833. Then this is because the `celery.platform` module has been
  834. renamed to `celery.platforms` to not collide with the built-in
  835. :mod:`platform` module.
  836. You have to remove the old :file:`platform.py` (and maybe
  837. :file:`platform.pyc`) file from your previous Celery installation.
  838. To do this use :program:`python` to find the location
  839. of this module::
  840. $ python
  841. >>> import celery.platform
  842. >>> celery.platform
  843. <module 'celery.platform' from '/opt/devel/celery/celery/platform.pyc'>
  844. Here the compiled module is in :file:`/opt/devel/celery/celery/`,
  845. to remove the offending files do::
  846. $ rm -f /opt/devel/celery/celery/platform.py*
  847. .. _v210-news:
  848. News
  849. ----
  850. * Added support for expiration of AMQP results (requires RabbitMQ 2.1.0)
  851. The new configuration option :setting:`CELERY_AMQP_TASK_RESULT_EXPIRES`
  852. sets the expiry time in seconds (can be int or float):
  853. .. code-block:: python
  854. CELERY_AMQP_TASK_RESULT_EXPIRES = 30 * 60 # 30 minutes.
  855. CELERY_AMQP_TASK_RESULT_EXPIRES = 0.80 # 800 ms.
  856. * celeryev: Event Snapshots
  857. If enabled, :program:`celeryd` sends messages about what the worker is doing.
  858. These messages are called "events".
  859. The events are used by real-time monitors to show what the
  860. cluster is doing, but they are not very useful for monitoring
  861. over a longer period of time. Snapshots
  862. lets you take "pictures" of the clusters state at regular intervals.
  863. This can then be stored in a database to generate statistics
  864. with, or even monitoring over longer time periods.
  865. django-celery now comes with a Celery monitor for the Django
  866. Admin interface. To use this you need to run the django-celery
  867. snapshot camera, which stores snapshots to the database at configurable
  868. intervals. See :ref:`monitoring-nodjango` for information about using
  869. this monitor if you're not using Django.
  870. To use the Django admin monitor you need to do the following:
  871. 1. Create the new database tables.
  872. $ python manage.py syncdb
  873. 2. Start the django-celery snapshot camera::
  874. $ python manage.py celerycam
  875. 3. Open up the django admin to monitor your cluster.
  876. The admin interface shows tasks, worker nodes, and even
  877. lets you perform some actions, like revoking and rate limiting tasks,
  878. and shutting down worker nodes.
  879. There's also a Debian init.d script for :mod:`~celery.bin.celeryev` available,
  880. see :doc:`cookbook/daemonizing` for more information.
  881. New command line arguments to celeryev:
  882. * :option:`-c|--camera`: Snapshot camera class to use.
  883. * :option:`--logfile|-f`: Log file
  884. * :option:`--loglevel|-l`: Log level
  885. * :option:`--maxrate|-r`: Shutter rate limit.
  886. * :option:`--freq|-F`: Shutter frequency
  887. The :option:`--camera` argument is the name of a class used to take
  888. snapshots with. It must support the interface defined by
  889. :class:`celery.events.snapshot.Polaroid`.
  890. Shutter frequency controls how often the camera thread wakes up,
  891. while the rate limit controls how often it will actually take
  892. a snapshot.
  893. The rate limit can be an integer (snapshots/s), or a rate limit string
  894. which has the same syntax as the task rate limit strings (`"200/m"`,
  895. `"10/s"`, `"1/h",` etc).
  896. For the Django camera case, this rate limit can be used to control
  897. how often the snapshots are written to the database, and the frequency
  898. used to control how often the thread wakes up to check if there's
  899. anything new.
  900. The rate limit is off by default, which means it will take a snapshot
  901. for every :option:`--frequency` seconds.
  902. .. seealso::
  903. :ref:`monitoring-django-admin` and :ref:`monitoring-snapshots`.
  904. * :func:`~celery.task.control.broadcast`: Added callback argument, this can be
  905. used to process replies immediately as they arrive.
  906. * celeryctl: New command-line utility to manage and inspect worker nodes,
  907. apply tasks and inspect the results of tasks.
  908. .. seealso::
  909. The :ref:`monitoring-celeryctl` section in the :ref:`guide`.
  910. Some examples::
  911. $ celeryctl apply tasks.add -a '[2, 2]' --countdown=10
  912. $ celeryctl inspect active
  913. $ celeryctl inspect registered_tasks
  914. $ celeryctl inspect scheduled
  915. $ celeryctl inspect --help
  916. $ celeryctl apply --help
  917. * Added the ability to set an expiry date and time for tasks.
  918. Example::
  919. >>> # Task expires after one minute from now.
  920. >>> task.apply_async(args, kwargs, expires=60)
  921. >>> # Also supports datetime
  922. >>> task.apply_async(args, kwargs,
  923. ... expires=datetime.now() + timedelta(days=1)
  924. When a worker receives a task that has been expired it will be
  925. marked as revoked (:exc:`celery.exceptions.TaskRevokedError`).
  926. * Changed the way logging is configured.
  927. We now configure the root logger instead of only configuring
  928. our custom logger. In addition we don't hijack
  929. the multiprocessing logger anymore, but instead use a custom logger name
  930. for different applications:
  931. ===================================== =====================================
  932. **Application** **Logger Name**
  933. ===================================== =====================================
  934. `celeryd` "celery"
  935. `celerybeat` "celery.beat"
  936. `celeryev` "celery.ev"
  937. ===================================== =====================================
  938. This means that the `loglevel` and `logfile` arguments will
  939. affect all registered loggers (even those from 3rd party libraries).
  940. Unless you configure the loggers manually as shown below, that is.
  941. *Users can choose to configure logging by subscribing to the
  942. :signal:`~celery.signals.setup_logging` signal:*
  943. .. code-block:: python
  944. from logging.config import fileConfig
  945. from celery import signals
  946. def setup_logging(**kwargs):
  947. fileConfig("logging.conf")
  948. signals.setup_logging.connect(setup_logging)
  949. If there are no receivers for this signal, the logging subsystem
  950. will be configured using the :option:`--loglevel`/:option:`--logfile`
  951. argument, this will be used for *all defined loggers*.
  952. Remember that celeryd also redirects stdout and stderr
  953. to the celery logger, if manually configure logging
  954. you also need to redirect the stdouts manually:
  955. .. code-block:: python
  956. from logging.config import fileConfig
  957. from celery import log
  958. def setup_logging(**kwargs):
  959. import logging
  960. fileConfig("logging.conf")
  961. stdouts = logging.getLogger("mystdoutslogger")
  962. log.redirect_stdouts_to_logger(stdouts, loglevel=logging.WARNING)
  963. * celeryd: Added command-line option :option:`-I`/:option:`--include`:
  964. A comma separated list of (task) modules to be imported.
  965. Example::
  966. $ celeryd -I app1.tasks,app2.tasks
  967. * celeryd: now emits a warning if running as the root user (euid is 0).
  968. * :func:`celery.messaging.establish_connection`: Ability to override defaults
  969. used using keyword argument "defaults".
  970. * celeryd: Now uses `multiprocessing.freeze_support()` so that it should work
  971. with **py2exe**, **PyInstaller**, **cx_Freeze**, etc.
  972. * celeryd: Now includes more metadata for the :state:`STARTED` state: PID and
  973. host name of the worker that started the task.
  974. See issue #181
  975. * subtask: Merge additional keyword arguments to `subtask()` into task keyword
  976. arguments.
  977. e.g.:
  978. >>> s = subtask((1, 2), {"foo": "bar"}, baz=1)
  979. >>> s.args
  980. (1, 2)
  981. >>> s.kwargs
  982. {"foo": "bar", "baz": 1}
  983. See issue #182.
  984. * celeryd: Now emits a warning if there is already a worker node using the same
  985. name running on the same virtual host.
  986. * AMQP result backend: Sending of results are now retried if the connection
  987. is down.
  988. * AMQP result backend: `result.get()`: Wait for next state if state is not
  989. in :data:`~celery.states.READY_STATES`.
  990. * TaskSetResult now supports subscription.
  991. ::
  992. >>> res = TaskSet(tasks).apply_async()
  993. >>> res[0].get()
  994. * Added `Task.send_error_emails` + `Task.error_whitelist`, so these can
  995. be configured per task instead of just by the global setting.
  996. * Added `Task.store_errors_even_if_ignored`, so it can be changed per Task,
  997. not just by the global setting.
  998. * The crontab scheduler no longer wakes up every second, but implements
  999. `remaining_estimate` (*Optimization*).
  1000. * celeryd: Store :state:`FAILURE` result if the
  1001. :exc:`~celery.exceptions.WorkerLostError` exception occurs (worker process
  1002. disappeared).
  1003. * celeryd: Store :state:`FAILURE` result if one of the `*TimeLimitExceeded`
  1004. exceptions occurs.
  1005. * Refactored the periodic task responsible for cleaning up results.
  1006. * The backend cleanup task is now only added to the schedule if
  1007. :setting:`CELERY_TASK_RESULT_EXPIRES` is set.
  1008. * If the schedule already contains a periodic task named
  1009. "celery.backend_cleanup" it won't change it, so the behavior of the
  1010. backend cleanup task can be easily changed.
  1011. * The task is now run every day at 4:00 AM, rather than every day since
  1012. the first time it was run (using crontab schedule instead of
  1013. `run_every`)
  1014. * Renamed `celery.task.builtins.DeleteExpiredTaskMetaTask`
  1015. -> :class:`celery.task.builtins.backend_cleanup`
  1016. * The task itself has been renamed from "celery.delete_expired_task_meta"
  1017. to "celery.backend_cleanup"
  1018. See issue #134.
  1019. * Implemented `AsyncResult.forget` for sqla/cache/redis/tyrant backends.
  1020. (Forget and remove task result).
  1021. See issue #184.
  1022. * :meth:`TaskSetResult.join <celery.result.TaskSetResult.join>`:
  1023. Added 'propagate=True' argument.
  1024. When set to :const:`False` exceptions occurring in subtasks will
  1025. not be re-raised.
  1026. * Added `Task.update_state(task_id, state, meta)`
  1027. as a shortcut to `task.backend.store_result(task_id, meta, state)`.
  1028. The backend interface is "private" and the terminology outdated,
  1029. so better to move this to :class:`~celery.task.base.Task` so it can be
  1030. used.
  1031. * timer2: Set `self.running=False` in
  1032. :meth:`~celery.utils.timer2.Timer.stop` so it won't try to join again on
  1033. subsequent calls to `stop()`.
  1034. * Log colors are now disabled by default on Windows.
  1035. * `celery.platform` renamed to :mod:`celery.platforms`, so it doesn't
  1036. collide with the built-in :mod:`platform` module.
  1037. * Exceptions occurring in Mediator+Pool callbacks are now caught and logged
  1038. instead of taking down the worker.
  1039. * Redis result backend: Now supports result expiration using the Redis
  1040. `EXPIRE` command.
  1041. * unit tests: Don't leave threads running at tear down.
  1042. * celeryd: Task results shown in logs are now truncated to 46 chars.
  1043. * `Task.__name__` is now an alias to `self.__class__.__name__`.
  1044. This way tasks introspects more like regular functions.
  1045. * `Task.retry`: Now raises :exc:`TypeError` if kwargs argument is empty.
  1046. See issue #164.
  1047. * timedelta_seconds: Use `timedelta.total_seconds` if running on Python 2.7
  1048. * :class:`~celery.datastructures.TokenBucket`: Generic Token Bucket algorithm
  1049. * :mod:`celery.events.state`: Recording of cluster state can now
  1050. be paused and resumed, including support for buffering.
  1051. .. method:: State.freeze(buffer=True)
  1052. Pauses recording of the stream.
  1053. If `buffer` is true, events received while being frozen will be
  1054. buffered, and may be replayed later.
  1055. .. method:: State.thaw(replay=True)
  1056. Resumes recording of the stream.
  1057. If `replay` is true, then the recorded buffer will be applied.
  1058. .. method:: State.freeze_while(fun)
  1059. With a function to apply, freezes the stream before,
  1060. and replays the buffer after the function returns.
  1061. * :meth:`EventReceiver.capture <celery.events.EventReceiver.capture>`
  1062. Now supports a timeout keyword argument.
  1063. * celeryd: The mediator thread is now disabled if
  1064. :setting:`CELERY_RATE_LIMITS` is enabled, and tasks are directly sent to the
  1065. pool without going through the ready queue (*Optimization*).
  1066. .. _v210-fixes:
  1067. Fixes
  1068. -----
  1069. * Pool: Process timed out by `TimeoutHandler` must be joined by the Supervisor,
  1070. so don't remove it from the internal process list.
  1071. See issue #192.
  1072. * `TaskPublisher.delay_task` now supports exchange argument, so exchange can be
  1073. overridden when sending tasks in bulk using the same publisher
  1074. See issue #187.
  1075. * celeryd no longer marks tasks as revoked if :setting:`CELERY_IGNORE_RESULT`
  1076. is enabled.
  1077. See issue #207.
  1078. * AMQP Result backend: Fixed bug with `result.get()` if
  1079. :setting:`CELERY_TRACK_STARTED` enabled.
  1080. `result.get()` would stop consuming after receiving the
  1081. :state:`STARTED` state.
  1082. * Fixed bug where new processes created by the pool supervisor becomes stuck
  1083. while reading from the task Queue.
  1084. See http://bugs.python.org/issue10037
  1085. * Fixed timing issue when declaring the remote control command reply queue
  1086. This issue could result in replies being lost, but have now been fixed.
  1087. * Backward compatible `LoggerAdapter` implementation: Now works for Python 2.4.
  1088. Also added support for several new methods:
  1089. `fatal`, `makeRecord`, `_log`, `log`, `isEnabledFor`,
  1090. `addHandler`, `removeHandler`.
  1091. .. _v210-experimental:
  1092. Experimental
  1093. ------------
  1094. * celeryd-multi: Added daemonization support.
  1095. celeryd-multi can now be used to start, stop and restart worker nodes.
  1096. $ celeryd-multi start jerry elaine george kramer
  1097. This also creates PID files and log files (:file:`celeryd@jerry.pid`,
  1098. ..., :file:`celeryd@jerry.log`. To specify a location for these files
  1099. use the `--pidfile` and `--logfile` arguments with the `%n`
  1100. format::
  1101. $ celeryd-multi start jerry elaine george kramer \
  1102. --logfile=/var/log/celeryd@%n.log \
  1103. --pidfile=/var/run/celeryd@%n.pid
  1104. Stopping::
  1105. $ celeryd-multi stop jerry elaine george kramer
  1106. Restarting. The nodes will be restarted one by one as the old ones
  1107. are shutdown::
  1108. $ celeryd-multi restart jerry elaine george kramer
  1109. Killing the nodes (**WARNING**: Will discard currently executing tasks)::
  1110. $ celeryd-multi kill jerry elaine george kramer
  1111. See `celeryd-multi help` for help.
  1112. * celeryd-multi: `start` command renamed to `show`.
  1113. `celeryd-multi start` will now actually start and detach worker nodes.
  1114. To just generate the commands you have to use `celeryd-multi show`.
  1115. * celeryd: Added `--pidfile` argument.
  1116. The worker will write its pid when it starts. The worker will
  1117. not be started if this file exists and the pid contained is still alive.
  1118. * Added generic init.d script using `celeryd-multi`
  1119. http://github.com/ask/celery/tree/master/contrib/generic-init.d/celeryd
  1120. .. _v210-documentation:
  1121. Documentation
  1122. -------------
  1123. * Added User guide section: Monitoring
  1124. * Added user guide section: Periodic Tasks
  1125. Moved from `getting-started/periodic-tasks` and updated.
  1126. * tutorials/external moved to new section: "community".
  1127. * References has been added to all sections in the documentation.
  1128. This makes it easier to link between documents.
  1129. .. _version-2.0.3:
  1130. 2.0.3
  1131. =====
  1132. :release-date: 2010-08-27 12:00 P.M CEST
  1133. .. _v203-fixes:
  1134. Fixes
  1135. -----
  1136. * celeryd: Properly handle connection errors happening while
  1137. closing consumers.
  1138. * celeryd: Events are now buffered if the connection is down,
  1139. then sent when the connection is re-established.
  1140. * No longer depends on the :mod:`mailer` package.
  1141. This package had a name space collision with `django-mailer`,
  1142. so its functionality was replaced.
  1143. * Redis result backend: Documentation typos: Redis doesn't have
  1144. database names, but database numbers. The default database is now 0.
  1145. * :class:`~celery.task.control.inspect`:
  1146. `registered_tasks` was requesting an invalid command because of a typo.
  1147. See issue #170.
  1148. * :setting:`CELERY_ROUTES`: Values defined in the route should now have
  1149. precedence over values defined in :setting:`CELERY_QUEUES` when merging
  1150. the two.
  1151. With the follow settings::
  1152. CELERY_QUEUES = {"cpubound": {"exchange": "cpubound",
  1153. "routing_key": "cpubound"}}
  1154. CELERY_ROUTES = {"tasks.add": {"queue": "cpubound",
  1155. "routing_key": "tasks.add",
  1156. "serializer": "json"}}
  1157. The final routing options for `tasks.add` will become::
  1158. {"exchange": "cpubound",
  1159. "routing_key": "tasks.add",
  1160. "serializer": "json"}
  1161. This was not the case before: the values
  1162. in :setting:`CELERY_QUEUES` would take precedence.
  1163. * Worker crashed if the value of :setting:`CELERY_TASK_ERROR_WHITELIST` was
  1164. not an iterable
  1165. * :func:`~celery.execute.apply`: Make sure `kwargs["task_id"]` is
  1166. always set.
  1167. * `AsyncResult.traceback`: Now returns :const:`None`, instead of raising
  1168. :exc:`KeyError` if traceback is missing.
  1169. * :class:`~celery.task.control.inspect`: Replies did not work correctly
  1170. if no destination was specified.
  1171. * Can now store result/metadata for custom states.
  1172. * celeryd: A warning is now emitted if the sending of task error
  1173. e-mails fails.
  1174. * celeryev: Curses monitor no longer crashes if the terminal window
  1175. is resized.
  1176. See issue #160.
  1177. * celeryd: On OS X it is not possible to run `os.exec*` in a process
  1178. that is threaded.
  1179. This breaks the SIGHUP restart handler,
  1180. and is now disabled on OS X, emitting a warning instead.
  1181. See issue #152.
  1182. * :mod:`celery.execute.trace`: Properly handle `raise(str)`,
  1183. which is still allowed in Python 2.4.
  1184. See issue #175.
  1185. * Using urllib2 in a periodic task on OS X crashed because
  1186. of the proxy auto detection used in OS X.
  1187. This is now fixed by using a workaround.
  1188. See issue #143.
  1189. * Debian init scripts: Commands should not run in a sub shell
  1190. See issue #163.
  1191. * Debian init scripts: Use the absolute path of celeryd to allow stat
  1192. See issue #162.
  1193. .. _v203-documentation:
  1194. Documentation
  1195. -------------
  1196. * getting-started/broker-installation: Fixed typo
  1197. `set_permissions ""` -> `set_permissions ".*"`.
  1198. * Tasks User Guide: Added section on database transactions.
  1199. See issue #169.
  1200. * Routing User Guide: Fixed typo `"feed": -> {"queue": "feeds"}`.
  1201. See issue #169.
  1202. * Documented the default values for the :setting:`CELERYD_CONCURRENCY`
  1203. and :setting:`CELERYD_PREFETCH_MULTIPLIER` settings.
  1204. * Tasks User Guide: Fixed typos in the subtask example
  1205. * celery.signals: Documented worker_process_init.
  1206. * Daemonization cookbook: Need to export DJANGO_SETTINGS_MODULE in
  1207. `/etc/default/celeryd`.
  1208. * Added some more FAQs from stack overflow
  1209. * Daemonization cookbook: Fixed typo `CELERYD_LOGFILE/CELERYD_PIDFILE`
  1210. to `CELERYD_LOG_FILE` / `CELERYD_PID_FILE`
  1211. Also added troubleshooting section for the init scripts.
  1212. .. _version-2.0.2:
  1213. 2.0.2
  1214. =====
  1215. :release-date: 2010-07-22 11:31 A.M CEST
  1216. * Routes: When using the dict route syntax, the exchange for a task
  1217. could disappear making the task unroutable.
  1218. See issue #158.
  1219. * Test suite now passing on Python 2.4
  1220. * No longer have to type `PYTHONPATH=.` to use celeryconfig in the current
  1221. directory.
  1222. This is accomplished by the default loader ensuring that the current
  1223. directory is in `sys.path` when loading the config module.
  1224. `sys.path` is reset to its original state after loading.
  1225. Adding the current working directory to `sys.path` without the user
  1226. knowing may be a security issue, as this means someone can drop a Python module in the users
  1227. directory that executes arbitrary commands. This was the original reason
  1228. not to do this, but if done *only when loading the config module*, this
  1229. means that the behavior will only apply to the modules imported in the
  1230. config module, which I think is a good compromise (certainly better than
  1231. just explicitly setting `PYTHONPATH=.` anyway)
  1232. * Experimental Cassandra backend added.
  1233. * celeryd: SIGHUP handler accidentally propagated to worker pool processes.
  1234. In combination with 7a7c44e39344789f11b5346e9cc8340f5fe4846c
  1235. this would make each child process start a new celeryd when
  1236. the terminal window was closed :/
  1237. * celeryd: Do not install SIGHUP handler if running from a terminal.
  1238. This fixes the problem where celeryd is launched in the background
  1239. when closing the terminal.
  1240. * celeryd: Now joins threads at shutdown.
  1241. See issue #152.
  1242. * Test tear down: Don't use `atexit` but nose's `teardown()` functionality
  1243. instead.
  1244. See issue #154.
  1245. * Debian init script for celeryd: Stop now works correctly.
  1246. * Task logger: `warn` method added (synonym for `warning`)
  1247. * Can now define a white list of errors to send error e-mails for.
  1248. Example::
  1249. CELERY_TASK_ERROR_WHITELIST = ('myapp.MalformedInputError')
  1250. See issue #153.
  1251. * celeryd: Now handles overflow exceptions in `time.mktime` while parsing
  1252. the ETA field.
  1253. * LoggerWrapper: Try to detect loggers logging back to stderr/stdout making
  1254. an infinite loop.
  1255. * Added :class:`celery.task.control.inspect`: Inspects a running worker.
  1256. Examples::
  1257. # Inspect a single worker
  1258. >>> i = inspect("myworker.example.com")
  1259. # Inspect several workers
  1260. >>> i = inspect(["myworker.example.com", "myworker2.example.com"])
  1261. # Inspect all workers consuming on this vhost.
  1262. >>> i = inspect()
  1263. ### Methods
  1264. # Get currently executing tasks
  1265. >>> i.active()
  1266. # Get currently reserved tasks
  1267. >>> i.reserved()
  1268. # Get the current eta schedule
  1269. >>> i.scheduled()
  1270. # Worker statistics and info
  1271. >>> i.stats()
  1272. # List of currently revoked tasks
  1273. >>> i.revoked()
  1274. # List of registered tasks
  1275. >>> i.registered_tasks()
  1276. * Remote control commands `dump_active`/`dump_reserved`/`dump_schedule`
  1277. now replies with detailed task requests.
  1278. Containing the original arguments and fields of the task requested.
  1279. In addition the remote control command `set_loglevel` has been added,
  1280. this only changes the log level for the main process.
  1281. * Worker control command execution now catches errors and returns their
  1282. string representation in the reply.
  1283. * Functional test suite added
  1284. :mod:`celery.tests.functional.case` contains utilities to start
  1285. and stop an embedded celeryd process, for use in functional testing.
  1286. .. _version-2.0.1:
  1287. 2.0.1
  1288. =====
  1289. :release-date: 2010-07-09 03:02 P.M CEST
  1290. * multiprocessing.pool: Now handles encoding errors, so that pickling errors
  1291. doesn't crash the worker processes.
  1292. * The remote control command replies was not working with RabbitMQ 1.8.0's
  1293. stricter equivalence checks.
  1294. If you've already hit this problem you may have to delete the
  1295. declaration::
  1296. $ camqadm exchange.delete celerycrq
  1297. or::
  1298. $ python manage.py camqadm exchange.delete celerycrq
  1299. * A bug sneaked in the ETA scheduler that made it only able to execute
  1300. one task per second(!)
  1301. The scheduler sleeps between iterations so it doesn't consume too much CPU.
  1302. It keeps a list of the scheduled items sorted by time, at each iteration
  1303. it sleeps for the remaining time of the item with the nearest deadline.
  1304. If there are no eta tasks it will sleep for a minimum amount of time, one
  1305. second by default.
  1306. A bug sneaked in here, making it sleep for one second for every task
  1307. that was scheduled. This has been fixed, so now it should move
  1308. tasks like hot knife through butter.
  1309. In addition a new setting has been added to control the minimum sleep
  1310. interval; :setting:`CELERYD_ETA_SCHEDULER_PRECISION`. A good
  1311. value for this would be a float between 0 and 1, depending
  1312. on the needed precision. A value of 0.8 means that when the ETA of a task
  1313. is met, it will take at most 0.8 seconds for the task to be moved to the
  1314. ready queue.
  1315. * Pool: Supervisor did not release the semaphore.
  1316. This would lead to a deadlock if all workers terminated prematurely.
  1317. * Added Python version trove classifiers: 2.4, 2.5, 2.6 and 2.7
  1318. * Tests now passing on Python 2.7.
  1319. * Task.__reduce__: Tasks created using the task decorator can now be pickled.
  1320. * setup.py: nose added to `tests_require`.
  1321. * Pickle should now work with SQLAlchemy 0.5.x
  1322. * New homepage design by Jan Henrik Helmers: http://celeryproject.org
  1323. * New Sphinx theme by Armin Ronacher: http://docs.celeryproject.org/
  1324. * Fixed "pending_xref" errors shown in the HTML rendering of the
  1325. documentation. Apparently this was caused by new changes in Sphinx 1.0b2.
  1326. * Router classes in :setting:`CELERY_ROUTES` are now imported lazily.
  1327. Importing a router class in a module that also loads the Celery
  1328. environment would cause a circular dependency. This is solved
  1329. by importing it when needed after the environment is set up.
  1330. * :setting:`CELERY_ROUTES` was broken if set to a single dict.
  1331. This example in the docs should now work again::
  1332. CELERY_ROUTES = {"feed.tasks.import_feed": "feeds"}
  1333. * `CREATE_MISSING_QUEUES` was not honored by apply_async.
  1334. * New remote control command: `stats`
  1335. Dumps information about the worker, like pool process ids, and
  1336. total number of tasks executed by type.
  1337. Example reply::
  1338. [{'worker.local':
  1339. 'total': {'tasks.sleeptask': 6},
  1340. 'pool': {'timeouts': [None, None],
  1341. 'processes': [60376, 60377],
  1342. 'max-concurrency': 2,
  1343. 'max-tasks-per-child': None,
  1344. 'put-guarded-by-semaphore': True}}]
  1345. * New remote control command: `dump_active`
  1346. Gives a list of tasks currently being executed by the worker.
  1347. By default arguments are passed through repr in case there
  1348. are arguments that is not JSON encodable. If you know
  1349. the arguments are JSON safe, you can pass the argument `safe=True`.
  1350. Example reply::
  1351. >>> broadcast("dump_active", arguments={"safe": False}, reply=True)
  1352. [{'worker.local': [
  1353. {'args': '(1,)',
  1354. 'time_start': 1278580542.6300001,
  1355. 'name': 'tasks.sleeptask',
  1356. 'delivery_info': {
  1357. 'consumer_tag': '30',
  1358. 'routing_key': 'celery',
  1359. 'exchange': 'celery'},
  1360. 'hostname': 'casper.local',
  1361. 'acknowledged': True,
  1362. 'kwargs': '{}',
  1363. 'id': '802e93e9-e470-47ed-b913-06de8510aca2',
  1364. }
  1365. ]}]
  1366. * Added experimental support for persistent revokes.
  1367. Use the `-S|--statedb` argument to celeryd to enable it::
  1368. $ celeryd --statedb=/var/run/celeryd
  1369. This will use the file: `/var/run/celeryd.db`,
  1370. as the `shelve` module automatically adds the `.db` suffix.
  1371. .. _version-2.0.0:
  1372. 2.0.0
  1373. =====
  1374. :release-date: 2010-07-02 02:30 P.M CEST
  1375. Foreword
  1376. --------
  1377. Celery 2.0 contains backward incompatible changes, the most important
  1378. being that the Django dependency has been removed so Celery no longer
  1379. supports Django out of the box, but instead as an add-on package
  1380. called `django-celery`_.
  1381. We're very sorry for breaking backwards compatibility, but there's
  1382. also many new and exciting features to make up for the time you lose
  1383. upgrading, so be sure to read the :ref:`News <v200-news>` section.
  1384. Quite a lot of potential users have been upset about the Django dependency,
  1385. so maybe this is a chance to get wider adoption by the Python community as
  1386. well.
  1387. Big thanks to all contributors, testers and users!
  1388. .. _v200-django-upgrade:
  1389. Upgrading for Django-users
  1390. --------------------------
  1391. Django integration has been moved to a separate package: `django-celery`_.
  1392. * To upgrade you need to install the `django-celery`_ module and change::
  1393. INSTALLED_APPS = "celery"
  1394. to::
  1395. INSTALLED_APPS = "djcelery"
  1396. * If you use `mod_wsgi` you need to add the following line to your `.wsgi`
  1397. file::
  1398. import os
  1399. os.environ["CELERY_LOADER"] = "django"
  1400. * The following modules has been moved to `django-celery`_:
  1401. ===================================== =====================================
  1402. **Module name** **Replace with**
  1403. ===================================== =====================================
  1404. `celery.models` `djcelery.models`
  1405. `celery.managers` `djcelery.managers`
  1406. `celery.views` `djcelery.views`
  1407. `celery.urls` `djcelery.urls`
  1408. `celery.management` `djcelery.management`
  1409. `celery.loaders.djangoapp` `djcelery.loaders`
  1410. `celery.backends.database` `djcelery.backends.database`
  1411. `celery.backends.cache` `djcelery.backends.cache`
  1412. ===================================== =====================================
  1413. Importing :mod:`djcelery` will automatically setup Celery to use Django loader.
  1414. loader. It does this by setting the :envvar:`CELERY_LOADER` environment variable to
  1415. `"django"` (it won't change it if a loader is already set.)
  1416. When the Django loader is used, the "database" and "cache" result backend
  1417. aliases will point to the :mod:`djcelery` backends instead of the built-in backends,
  1418. and configuration will be read from the Django settings.
  1419. .. _`django-celery`: http://pypi.python.org/pypi/django-celery
  1420. .. _v200-upgrade:
  1421. Upgrading for others
  1422. --------------------
  1423. .. _v200-upgrade-database:
  1424. Database result backend
  1425. ~~~~~~~~~~~~~~~~~~~~~~~
  1426. The database result backend is now using `SQLAlchemy`_ instead of the
  1427. Django ORM, see `Supported Databases`_ for a table of supported databases.
  1428. The `DATABASE_*` settings has been replaced by a single setting:
  1429. :setting:`CELERY_RESULT_DBURI`. The value here should be an
  1430. `SQLAlchemy Connection String`_, some examples include:
  1431. .. code-block:: python
  1432. # sqlite (filename)
  1433. CELERY_RESULT_DBURI = "sqlite:///celerydb.sqlite"
  1434. # mysql
  1435. CELERY_RESULT_DBURI = "mysql://scott:tiger@localhost/foo"
  1436. # postgresql
  1437. CELERY_RESULT_DBURI = "postgresql://scott:tiger@localhost/mydatabase"
  1438. # oracle
  1439. CELERY_RESULT_DBURI = "oracle://scott:tiger@127.0.0.1:1521/sidname"
  1440. See `SQLAlchemy Connection Strings`_ for more information about connection
  1441. strings.
  1442. To specify additional SQLAlchemy database engine options you can use
  1443. the :setting:`CELERY_RESULT_ENGINE_OPTIONS` setting::
  1444. # echo enables verbose logging from SQLAlchemy.
  1445. CELERY_RESULT_ENGINE_OPTIONS = {"echo": True}
  1446. .. _`SQLAlchemy`:
  1447. http://www.sqlalchemy.org
  1448. .. _`Supported Databases`:
  1449. http://www.sqlalchemy.org/docs/core/engines.html#supported-databases
  1450. .. _`SQLAlchemy Connection String`:
  1451. http://www.sqlalchemy.org/docs/core/engines.html#database-urls
  1452. .. _`SQLAlchemy Connection Strings`:
  1453. http://www.sqlalchemy.org/docs/core/engines.html#database-urls
  1454. .. _v200-upgrade-cache:
  1455. Cache result backend
  1456. ~~~~~~~~~~~~~~~~~~~~
  1457. The cache result backend is no longer using the Django cache framework,
  1458. but it supports mostly the same configuration syntax::
  1459. CELERY_CACHE_BACKEND = "memcached://A.example.com:11211;B.example.com"
  1460. To use the cache backend you must either have the `pylibmc`_ or
  1461. `python-memcached`_ library installed, of which the former is regarded
  1462. as the best choice.
  1463. .. _`pylibmc`: http://pypi.python.org/pypi/pylibmc
  1464. .. _`python-memcached`: http://pypi.python.org/pypi/python-memcached
  1465. The support backend types are `memcached://` and `memory://`,
  1466. we haven't felt the need to support any of the other backends
  1467. provided by Django.
  1468. .. _v200-incompatible:
  1469. Backward incompatible changes
  1470. -----------------------------
  1471. * Default (python) loader now prints warning on missing `celeryconfig.py`
  1472. instead of raising :exc:`ImportError`.
  1473. celeryd raises :exc:`~celery.exceptions.ImproperlyConfigured` if the configuration
  1474. is not set up. This makes it possible to use `--help` etc., without having a
  1475. working configuration.
  1476. Also this makes it possible to use the client side of celery without being
  1477. configured::
  1478. >>> from carrot.connection import BrokerConnection
  1479. >>> conn = BrokerConnection("localhost", "guest", "guest", "/")
  1480. >>> from celery.execute import send_task
  1481. >>> r = send_task("celery.ping", args=(), kwargs={}, connection=conn)
  1482. >>> from celery.backends.amqp import AMQPBackend
  1483. >>> r.backend = AMQPBackend(connection=conn)
  1484. >>> r.get()
  1485. 'pong'
  1486. * The following deprecated settings has been removed (as scheduled by
  1487. the `deprecation timeline`_):
  1488. ===================================== =====================================
  1489. **Setting name** **Replace with**
  1490. ===================================== =====================================
  1491. `CELERY_AMQP_CONSUMER_QUEUES` `CELERY_QUEUES`
  1492. `CELERY_AMQP_EXCHANGE` `CELERY_DEFAULT_EXCHANGE`
  1493. `CELERY_AMQP_EXCHANGE_TYPE` `CELERY_DEFAULT_EXCHANGE_TYPE`
  1494. `CELERY_AMQP_CONSUMER_ROUTING_KEY` `CELERY_QUEUES`
  1495. `CELERY_AMQP_PUBLISHER_ROUTING_KEY` `CELERY_DEFAULT_ROUTING_KEY`
  1496. ===================================== =====================================
  1497. .. _`deprecation timeline`:
  1498. http://ask.github.com/celery/internals/deprecation.html
  1499. * The `celery.task.rest` module has been removed, use :mod:`celery.task.http`
  1500. instead (as scheduled by the `deprecation timeline`_).
  1501. * It's no longer allowed to skip the class name in loader names.
  1502. (as scheduled by the `deprecation timeline`_):
  1503. Assuming the implicit `Loader` class name is no longer supported,
  1504. if you use e.g.::
  1505. CELERY_LOADER = "myapp.loaders"
  1506. You need to include the loader class name, like this::
  1507. CELERY_LOADER = "myapp.loaders.Loader"
  1508. * :setting:`CELERY_TASK_RESULT_EXPIRES` now defaults to 1 day.
  1509. Previous default setting was to expire in 5 days.
  1510. * AMQP backend: Don't use different values for `auto_delete`.
  1511. This bug became visible with RabbitMQ 1.8.0, which no longer
  1512. allows conflicting declarations for the auto_delete and durable settings.
  1513. If you've already used celery with this backend chances are you
  1514. have to delete the previous declaration::
  1515. $ camqadm exchange.delete celeryresults
  1516. * Now uses pickle instead of cPickle on Python versions <= 2.5
  1517. cPickle is broken in Python <= 2.5.
  1518. It unsafely and incorrectly uses relative instead of absolute imports,
  1519. so e.g.::
  1520. exceptions.KeyError
  1521. becomes::
  1522. celery.exceptions.KeyError
  1523. Your best choice is to upgrade to Python 2.6,
  1524. as while the pure pickle version has worse performance,
  1525. it is the only safe option for older Python versions.
  1526. .. _v200-news:
  1527. News
  1528. ----
  1529. * **celeryev**: Curses Celery Monitor and Event Viewer.
  1530. This is a simple monitor allowing you to see what tasks are
  1531. executing in real-time and investigate tracebacks and results of ready
  1532. tasks. It also enables you to set new rate limits and revoke tasks.
  1533. Screenshot:
  1534. .. figure:: images/celeryevshotsm.jpg
  1535. If you run `celeryev` with the `-d` switch it will act as an event
  1536. dumper, simply dumping the events it receives to standard out::
  1537. $ celeryev -d
  1538. -> celeryev: starting capture...
  1539. casper.local [2010-06-04 10:42:07.020000] heartbeat
  1540. casper.local [2010-06-04 10:42:14.750000] task received:
  1541. tasks.add(61a68756-27f4-4879-b816-3cf815672b0e) args=[2, 2] kwargs={}
  1542. eta=2010-06-04T10:42:16.669290, retries=0
  1543. casper.local [2010-06-04 10:42:17.230000] task started
  1544. tasks.add(61a68756-27f4-4879-b816-3cf815672b0e) args=[2, 2] kwargs={}
  1545. casper.local [2010-06-04 10:42:17.960000] task succeeded:
  1546. tasks.add(61a68756-27f4-4879-b816-3cf815672b0e)
  1547. args=[2, 2] kwargs={} result=4, runtime=0.782663106918
  1548. The fields here are, in order: *sender hostname*, *timestamp*, *event type* and
  1549. *additional event fields*.
  1550. * AMQP result backend: Now supports `.ready()`, `.successful()`,
  1551. `.result`, `.status`, and even responds to changes in task state
  1552. * New user guides:
  1553. * :doc:`userguide/workers`
  1554. * :doc:`userguide/tasksets`
  1555. * :doc:`userguide/routing`
  1556. * celeryd: Standard out/error is now being redirected to the log file.
  1557. * :mod:`billiard` has been moved back to the celery repository.
  1558. ===================================== =====================================
  1559. **Module name** **celery equivalent**
  1560. ===================================== =====================================
  1561. `billiard.pool` `celery.concurrency.processes.pool`
  1562. `billiard.serialization` `celery.serialization`
  1563. `billiard.utils.functional` `celery.utils.functional`
  1564. ===================================== =====================================
  1565. The :mod:`billiard` distribution may be maintained, depending on interest.
  1566. * now depends on :mod:`carrot` >= 0.10.5
  1567. * now depends on :mod:`pyparsing`
  1568. * celeryd: Added `--purge` as an alias to `--discard`.
  1569. * celeryd: Ctrl+C (SIGINT) once does warm shutdown, hitting Ctrl+C twice
  1570. forces termination.
  1571. * Added support for using complex crontab-expressions in periodic tasks. For
  1572. example, you can now use::
  1573. >>> crontab(minute="*/15")
  1574. or even::
  1575. >>> crontab(minute="*/30", hour="8-17,1-2", day_of_week="thu-fri")
  1576. See :doc:`userguide/periodic-tasks`.
  1577. * celeryd: Now waits for available pool processes before applying new
  1578. tasks to the pool.
  1579. This means it doesn't have to wait for dozens of tasks to finish at shutdown
  1580. because it has applied prefetched tasks without having any pool
  1581. processes available to immediately accept them.
  1582. See issue #122.
  1583. * New built-in way to do task callbacks using
  1584. :class:`~celery.task.sets.subtask`.
  1585. See :doc:`userguide/tasksets` for more information.
  1586. * TaskSets can now contain several types of tasks.
  1587. :class:`~celery.task.sets.TaskSet` has been refactored to use
  1588. a new syntax, please see :doc:`userguide/tasksets` for more information.
  1589. The previous syntax is still supported, but will be deprecated in
  1590. version 1.4.
  1591. * TaskSet failed() result was incorrect.
  1592. See issue #132.
  1593. * Now creates different loggers per task class.
  1594. See issue #129.
  1595. * Missing queue definitions are now created automatically.
  1596. You can disable this using the :setting:`CELERY_CREATE_MISSING_QUEUES`
  1597. setting.
  1598. The missing queues are created with the following options::
  1599. CELERY_QUEUES[name] = {"exchange": name,
  1600. "exchange_type": "direct",
  1601. "routing_key": "name}
  1602. This feature is added for easily setting up routing using the `-Q`
  1603. option to `celeryd`::
  1604. $ celeryd -Q video, image
  1605. See the new routing section of the User Guide for more information:
  1606. :doc:`userguide/routing`.
  1607. * New Task option: `Task.queue`
  1608. If set, message options will be taken from the corresponding entry
  1609. in :setting:`CELERY_QUEUES`. `exchange`, `exchange_type` and `routing_key`
  1610. will be ignored
  1611. * Added support for task soft and hard time limits.
  1612. New settings added:
  1613. * :setting:`CELERYD_TASK_TIME_LIMIT`
  1614. Hard time limit. The worker processing the task will be killed and
  1615. replaced with a new one when this is exceeded.
  1616. * :setting:`CELERYD_SOFT_TASK_TIME_LIMIT`
  1617. Soft time limit. The :exc:`celery.exceptions.SoftTimeLimitExceeded`
  1618. exception will be raised when this is exceeded. The task can catch
  1619. this to e.g. clean up before the hard time limit comes.
  1620. New command line arguments to celeryd added:
  1621. `--time-limit` and `--soft-time-limit`.
  1622. What's left?
  1623. This won't work on platforms not supporting signals (and specifically
  1624. the `SIGUSR1` signal) yet. So an alternative the ability to disable
  1625. the feature all together on nonconforming platforms must be implemented.
  1626. Also when the hard time limit is exceeded, the task result should
  1627. be a `TimeLimitExceeded` exception.
  1628. * Test suite is now passing without a running broker, using the carrot
  1629. in-memory backend.
  1630. * Log output is now available in colors.
  1631. ===================================== =====================================
  1632. **Log level** **Color**
  1633. ===================================== =====================================
  1634. `DEBUG` Blue
  1635. `WARNING` Yellow
  1636. `CRITICAL` Magenta
  1637. `ERROR` Red
  1638. ===================================== =====================================
  1639. This is only enabled when the log output is a tty.
  1640. You can explicitly enable/disable this feature using the
  1641. :setting:`CELERYD_LOG_COLOR` setting.
  1642. * Added support for task router classes (like the django multi-db routers)
  1643. * New setting: :setting:`CELERY_ROUTES`
  1644. This is a single, or a list of routers to traverse when
  1645. sending tasks. Dictionaries in this list converts to a
  1646. :class:`celery.routes.MapRoute` instance.
  1647. Examples:
  1648. >>> CELERY_ROUTES = {"celery.ping": "default",
  1649. "mytasks.add": "cpu-bound",
  1650. "video.encode": {
  1651. "queue": "video",
  1652. "exchange": "media"
  1653. "routing_key": "media.video.encode"}}
  1654. >>> CELERY_ROUTES = ("myapp.tasks.Router",
  1655. {"celery.ping": "default})
  1656. Where `myapp.tasks.Router` could be:
  1657. .. code-block:: python
  1658. class Router(object):
  1659. def route_for_task(self, task, args=None, kwargs=None):
  1660. if task == "celery.ping":
  1661. return "default"
  1662. route_for_task may return a string or a dict. A string then means
  1663. it's a queue name in :setting:`CELERY_QUEUES`, a dict means it's a custom route.
  1664. When sending tasks, the routers are consulted in order. The first
  1665. router that doesn't return `None` is the route to use. The message options
  1666. is then merged with the found route settings, where the routers settings
  1667. have priority.
  1668. Example if :func:`~celery.execute.apply_async` has these arguments::
  1669. >>> Task.apply_async(immediate=False, exchange="video",
  1670. ... routing_key="video.compress")
  1671. and a router returns::
  1672. {"immediate": True,
  1673. "exchange": "urgent"}
  1674. the final message options will be::
  1675. immediate=True, exchange="urgent", routing_key="video.compress"
  1676. (and any default message options defined in the
  1677. :class:`~celery.task.base.Task` class)
  1678. * New Task handler called after the task returns:
  1679. :meth:`~celery.task.base.Task.after_return`.
  1680. * :class:`~celery.datastructures.ExceptionInfo` now passed to
  1681. :meth:`~celery.task.base.Task.on_retry`/
  1682. :meth:`~celery.task.base.Task.on_failure` as einfo keyword argument.
  1683. * celeryd: Added :setting:`CELERYD_MAX_TASKS_PER_CHILD` /
  1684. :option:`--maxtasksperchild`
  1685. Defines the maximum number of tasks a pool worker can process before
  1686. the process is terminated and replaced by a new one.
  1687. * Revoked tasks now marked with state :state:`REVOKED`, and `result.get()`
  1688. will now raise :exc:`~celery.exceptions.TaskRevokedError`.
  1689. * :func:`celery.task.control.ping` now works as expected.
  1690. * `apply(throw=True)` / :setting:`CELERY_EAGER_PROPAGATES_EXCEPTIONS`:
  1691. Makes eager execution re-raise task errors.
  1692. * New signal: :signal:`~celery.signals.worker_process_init`: Sent inside the
  1693. pool worker process at init.
  1694. * celeryd :option:`-Q` option: Ability to specify list of queues to use,
  1695. disabling other configured queues.
  1696. For example, if :setting:`CELERY_QUEUES` defines four
  1697. queues: `image`, `video`, `data` and `default`, the following
  1698. command would make celeryd only consume from the `image` and `video`
  1699. queues::
  1700. $ celeryd -Q image,video
  1701. * celeryd: New return value for the `revoke` control command:
  1702. Now returns::
  1703. {"ok": "task $id revoked"}
  1704. instead of `True`.
  1705. * celeryd: Can now enable/disable events using remote control
  1706. Example usage:
  1707. >>> from celery.task.control import broadcast
  1708. >>> broadcast("enable_events")
  1709. >>> broadcast("disable_events")
  1710. * Removed top-level tests directory. Test config now in celery.tests.config
  1711. This means running the unit tests doesn't require any special setup.
  1712. `celery/tests/__init__` now configures the :envvar:`CELERY_CONFIG_MODULE`
  1713. and :envvar:`CELERY_LOADER` environment variables, so when `nosetests`
  1714. imports that, the unit test environment is all set up.
  1715. Before you run the tests you need to install the test requirements::
  1716. $ pip install -r contrib/requirements/test.txt
  1717. Running all tests::
  1718. $ nosetests
  1719. Specifying the tests to run::
  1720. $ nosetests celery.tests.test_task
  1721. Producing HTML coverage::
  1722. $ nosetests --with-coverage3
  1723. The coverage output is then located in `celery/tests/cover/index.html`.
  1724. * celeryd: New option `--version`: Dump version info and exit.
  1725. * :mod:`celeryd-multi <celeryd.bin.celeryd_multi>`: Tool for shell scripts
  1726. to start multiple workers.
  1727. Some examples::
  1728. # Advanced example with 10 workers:
  1729. # * Three of the workers processes the images and video queue
  1730. # * Two of the workers processes the data queue with loglevel DEBUG
  1731. # * the rest processes the default' queue.
  1732. $ celeryd-multi start 10 -l INFO -Q:1-3 images,video -Q:4,5:data
  1733. -Q default -L:4,5 DEBUG
  1734. # get commands to start 10 workers, with 3 processes each
  1735. $ celeryd-multi start 3 -c 3
  1736. celeryd -n celeryd1.myhost -c 3
  1737. celeryd -n celeryd2.myhost -c 3
  1738. celeryd- n celeryd3.myhost -c 3
  1739. # start 3 named workers
  1740. $ celeryd-multi start image video data -c 3
  1741. celeryd -n image.myhost -c 3
  1742. celeryd -n video.myhost -c 3
  1743. celeryd -n data.myhost -c 3
  1744. # specify custom hostname
  1745. $ celeryd-multi start 2 -n worker.example.com -c 3
  1746. celeryd -n celeryd1.worker.example.com -c 3
  1747. celeryd -n celeryd2.worker.example.com -c 3
  1748. # Additionl options are added to each celeryd',
  1749. # but you can also modify the options for ranges of or single workers
  1750. # 3 workers: Two with 3 processes, and one with 10 processes.
  1751. $ celeryd-multi start 3 -c 3 -c:1 10
  1752. celeryd -n celeryd1.myhost -c 10
  1753. celeryd -n celeryd2.myhost -c 3
  1754. celeryd -n celeryd3.myhost -c 3
  1755. # can also specify options for named workers
  1756. $ celeryd-multi start image video data -c 3 -c:image 10
  1757. celeryd -n image.myhost -c 10
  1758. celeryd -n video.myhost -c 3
  1759. celeryd -n data.myhost -c 3
  1760. # ranges and lists of workers in options is also allowed:
  1761. # (-c:1-3 can also be written as -c:1,2,3)
  1762. $ celeryd-multi start 5 -c 3 -c:1-3 10
  1763. celeryd-multi -n celeryd1.myhost -c 10
  1764. celeryd-multi -n celeryd2.myhost -c 10
  1765. celeryd-multi -n celeryd3.myhost -c 10
  1766. celeryd-multi -n celeryd4.myhost -c 3
  1767. celeryd-multi -n celeryd5.myhost -c 3
  1768. # lists also works with named workers
  1769. $ celeryd-multi start foo bar baz xuzzy -c 3 -c:foo,bar,baz 10
  1770. celeryd-multi -n foo.myhost -c 10
  1771. celeryd-multi -n bar.myhost -c 10
  1772. celeryd-multi -n baz.myhost -c 10
  1773. celeryd-multi -n xuzzy.myhost -c 3
  1774. * The worker now calls the result backends `process_cleanup` method
  1775. *after* task execution instead of before.
  1776. * AMQP result backend now supports Pika.
  1777. .. _version-1.0.6:
  1778. 1.0.6
  1779. =====
  1780. :release-date: 2010-06-30 09:57 A.M CEST
  1781. * RabbitMQ 1.8.0 has extended their exchange equivalence tests to
  1782. include `auto_delete` and `durable`. This broke the AMQP backend.
  1783. If you've already used the AMQP backend this means you have to
  1784. delete the previous definitions::
  1785. $ camqadm exchange.delete celeryresults
  1786. or::
  1787. $ python manage.py camqadm exchange.delete celeryresults
  1788. .. _version-1.0.5:
  1789. 1.0.5
  1790. =====
  1791. :release-date: 2010-06-01 02:36 P.M CEST
  1792. .. _v105-critical:
  1793. Critical
  1794. --------
  1795. * SIGINT/Ctrl+C killed the pool, abruptly terminating the currently executing
  1796. tasks.
  1797. Fixed by making the pool worker processes ignore :const:`SIGINT`.
  1798. * Should not close the consumers before the pool is terminated, just cancel
  1799. the consumers.
  1800. See issue #122.
  1801. * Now depends on :mod:`billiard` >= 0.3.1
  1802. * celeryd: Previously exceptions raised by worker components could stall startup,
  1803. now it correctly logs the exceptions and shuts down.
  1804. * celeryd: Prefetch counts was set too late. QoS is now set as early as possible,
  1805. so celeryd can't slurp in all the messages at start-up.
  1806. .. _v105-changes:
  1807. Changes
  1808. -------
  1809. * :mod:`celery.contrib.abortable`: Abortable tasks.
  1810. Tasks that defines steps of execution, the task can then
  1811. be aborted after each step has completed.
  1812. * :class:`~celery.events.EventDispatcher`: No longer creates AMQP channel
  1813. if events are disabled
  1814. * Added required RPM package names under `[bdist_rpm]` section, to support building RPMs
  1815. from the sources using setup.py
  1816. * Running unit tests: :envvar:`NOSE_VERBOSE` environment var now enables verbose output from Nose.
  1817. * :func:`celery.execute.apply`: Pass log file/log level arguments as task kwargs.
  1818. See issue #110.
  1819. * celery.execute.apply: Should return exception, not :class:`~celery.datastructures.ExceptionInfo`
  1820. on error.
  1821. See issue #111.
  1822. * Added new entries to the :doc:`FAQs <faq>`:
  1823. * Should I use retry or acks_late?
  1824. * Can I execute a task by name?
  1825. .. _version-1.0.4:
  1826. 1.0.4
  1827. =====
  1828. :release-date: 2010-05-31 09:54 A.M CEST
  1829. * Changelog merged with 1.0.5 as the release was never announced.
  1830. .. _version-1.0.3:
  1831. 1.0.3
  1832. =====
  1833. :release-date: 2010-05-15 03:00 P.M CEST
  1834. .. _v103-important:
  1835. Important notes
  1836. ---------------
  1837. * Messages are now acknowledged *just before* the task function is executed.
  1838. This is the behavior we've wanted all along, but couldn't have because of
  1839. limitations in the multiprocessing module.
  1840. The previous behavior was not good, and the situation worsened with the
  1841. release of 1.0.1, so this change will definitely improve
  1842. reliability, performance and operations in general.
  1843. For more information please see http://bit.ly/9hom6T
  1844. * Database result backend: result now explicitly sets `null=True` as
  1845. `django-picklefield` version 0.1.5 changed the default behavior
  1846. right under our noses :(
  1847. See: http://bit.ly/d5OwMr
  1848. This means those who created their celery tables (via syncdb or
  1849. celeryinit) with picklefield versions >= 0.1.5 has to alter their tables to
  1850. allow the result field to be `NULL` manually.
  1851. MySQL::
  1852. ALTER TABLE celery_taskmeta MODIFY result TEXT NULL
  1853. PostgreSQL::
  1854. ALTER TABLE celery_taskmeta ALTER COLUMN result DROP NOT NULL
  1855. * Removed `Task.rate_limit_queue_type`, as it was not really useful
  1856. and made it harder to refactor some parts.
  1857. * Now depends on carrot >= 0.10.4
  1858. * Now depends on billiard >= 0.3.0
  1859. .. _v103-news:
  1860. News
  1861. ----
  1862. * AMQP backend: Added timeout support for `result.get()` /
  1863. `result.wait()`.
  1864. * New task option: `Task.acks_late` (default: :setting:`CELERY_ACKS_LATE`)
  1865. Late ack means the task messages will be acknowledged **after** the task
  1866. has been executed, not *just before*, which is the default behavior.
  1867. .. note::
  1868. This means the tasks may be executed twice if the worker
  1869. crashes in mid-execution. Not acceptable for most
  1870. applications, but desirable for others.
  1871. * Added crontab-like scheduling to periodic tasks.
  1872. Like a cron job, you can specify units of time of when
  1873. you would like the task to execute. While not a full implementation
  1874. of cron's features, it should provide a fair degree of common scheduling
  1875. needs.
  1876. You can specify a minute (0-59), an hour (0-23), and/or a day of the
  1877. week (0-6 where 0 is Sunday, or by names: sun, mon, tue, wed, thu, fri,
  1878. sat).
  1879. Examples:
  1880. .. code-block:: python
  1881. from celery.schedules import crontab
  1882. from celery.decorators import periodic_task
  1883. @periodic_task(run_every=crontab(hour=7, minute=30))
  1884. def every_morning():
  1885. print("Runs every morning at 7:30a.m")
  1886. @periodic_task(run_every=crontab(hour=7, minute=30, day_of_week="mon"))
  1887. def every_monday_morning():
  1888. print("Run every monday morning at 7:30a.m")
  1889. @periodic_task(run_every=crontab(minutes=30))
  1890. def every_hour():
  1891. print("Runs every hour on the clock. e.g. 1:30, 2:30, 3:30 etc.")
  1892. .. note::
  1893. This a late addition. While we have unittests, due to the
  1894. nature of this feature we haven't been able to completely test this
  1895. in practice, so consider this experimental.
  1896. * `TaskPool.apply_async`: Now supports the `accept_callback` argument.
  1897. * `apply_async`: Now raises :exc:`ValueError` if task args is not a list,
  1898. or kwargs is not a tuple (Issue #95).
  1899. * `Task.max_retries` can now be `None`, which means it will retry forever.
  1900. * Celerybeat: Now reuses the same connection when publishing large
  1901. sets of tasks.
  1902. * Modified the task locking example in the documentation to use
  1903. `cache.add` for atomic locking.
  1904. * Added experimental support for a *started* status on tasks.
  1905. If `Task.track_started` is enabled the task will report its status
  1906. as "started" when the task is executed by a worker.
  1907. The default value is `False` as the normal behaviour is to not
  1908. report that level of granularity. Tasks are either pending, finished,
  1909. or waiting to be retried. Having a "started" status can be useful for
  1910. when there are long running tasks and there is a need to report which
  1911. task is currently running.
  1912. The global default can be overridden by the :setting:`CELERY_TRACK_STARTED`
  1913. setting.
  1914. * User Guide: New section `Tips and Best Practices`.
  1915. Contributions welcome!
  1916. .. _v103-remote-control:
  1917. Remote control commands
  1918. -----------------------
  1919. * Remote control commands can now send replies back to the caller.
  1920. Existing commands has been improved to send replies, and the client
  1921. interface in `celery.task.control` has new keyword arguments: `reply`,
  1922. `timeout` and `limit`. Where reply means it will wait for replies,
  1923. timeout is the time in seconds to stop waiting for replies, and limit
  1924. is the maximum number of replies to get.
  1925. By default, it will wait for as many replies as possible for one second.
  1926. * rate_limit(task_name, destination=all, reply=False, timeout=1, limit=0)
  1927. Worker returns `{"ok": message}` on success,
  1928. or `{"failure": message}` on failure.
  1929. >>> from celery.task.control import rate_limit
  1930. >>> rate_limit("tasks.add", "10/s", reply=True)
  1931. [{'worker1': {'ok': 'new rate limit set successfully'}},
  1932. {'worker2': {'ok': 'new rate limit set successfully'}}]
  1933. * ping(destination=all, reply=False, timeout=1, limit=0)
  1934. Worker returns the simple message `"pong"`.
  1935. >>> from celery.task.control import ping
  1936. >>> ping(reply=True)
  1937. [{'worker1': 'pong'},
  1938. {'worker2': 'pong'},
  1939. * revoke(destination=all, reply=False, timeout=1, limit=0)
  1940. Worker simply returns `True`.
  1941. >>> from celery.task.control import revoke
  1942. >>> revoke("419e46eb-cf6a-4271-86a8-442b7124132c", reply=True)
  1943. [{'worker1': True},
  1944. {'worker2'; True}]
  1945. * You can now add your own remote control commands!
  1946. Remote control commands are functions registered in the command
  1947. registry. Registering a command is done using
  1948. :meth:`celery.worker.control.Panel.register`:
  1949. .. code-block:: python
  1950. from celery.task.control import Panel
  1951. @Panel.register
  1952. def reset_broker_connection(panel, **kwargs):
  1953. panel.consumer.reset_connection()
  1954. return {"ok": "connection re-established"}
  1955. With this module imported in the worker, you can launch the command
  1956. using `celery.task.control.broadcast`::
  1957. >>> from celery.task.control import broadcast
  1958. >>> broadcast("reset_broker_connection", reply=True)
  1959. [{'worker1': {'ok': 'connection re-established'},
  1960. {'worker2': {'ok': 'connection re-established'}}]
  1961. **TIP** You can choose the worker(s) to receive the command
  1962. by using the `destination` argument::
  1963. >>> broadcast("reset_broker_connection", destination=["worker1"])
  1964. [{'worker1': {'ok': 'connection re-established'}]
  1965. * New remote control command: `dump_reserved`
  1966. Dumps tasks reserved by the worker, waiting to be executed::
  1967. >>> from celery.task.control import broadcast
  1968. >>> broadcast("dump_reserved", reply=True)
  1969. [{'myworker1': [<TaskRequest ....>]}]
  1970. * New remote control command: `dump_schedule`
  1971. Dumps the workers currently registered ETA schedule.
  1972. These are tasks with an `eta` (or `countdown`) argument
  1973. waiting to be executed by the worker.
  1974. >>> from celery.task.control import broadcast
  1975. >>> broadcast("dump_schedule", reply=True)
  1976. [{'w1': []},
  1977. {'w3': []},
  1978. {'w2': ['0. 2010-05-12 11:06:00 pri0 <TaskRequest
  1979. {name:"opalfeeds.tasks.refresh_feed_slice",
  1980. id:"95b45760-4e73-4ce8-8eac-f100aa80273a",
  1981. args:"(<Feeds freq_max:3600 freq_min:60
  1982. start:2184.0 stop:3276.0>,)",
  1983. kwargs:"{'page': 2}"}>']},
  1984. {'w4': ['0. 2010-05-12 11:00:00 pri0 <TaskRequest
  1985. {name:"opalfeeds.tasks.refresh_feed_slice",
  1986. id:"c053480b-58fb-422f-ae68-8d30a464edfe",
  1987. args:"(<Feeds freq_max:3600 freq_min:60
  1988. start:1092.0 stop:2184.0>,)",
  1989. kwargs:"{\'page\': 1}"}>',
  1990. '1. 2010-05-12 11:12:00 pri0 <TaskRequest
  1991. {name:"opalfeeds.tasks.refresh_feed_slice",
  1992. id:"ab8bc59e-6cf8-44b8-88d0-f1af57789758",
  1993. args:"(<Feeds freq_max:3600 freq_min:60
  1994. start:3276.0 stop:4365>,)",
  1995. kwargs:"{\'page\': 3}"}>']}]
  1996. .. _v103-fixes:
  1997. Fixes
  1998. -----
  1999. * Mediator thread no longer blocks for more than 1 second.
  2000. With rate limits enabled and when there was a lot of remaining time,
  2001. the mediator thread could block shutdown (and potentially block other
  2002. jobs from coming in).
  2003. * Remote rate limits was not properly applied (Issue #98).
  2004. * Now handles exceptions with Unicode messages correctly in
  2005. `TaskRequest.on_failure`.
  2006. * Database backend: `TaskMeta.result`: default value should be `None`
  2007. not empty string.
  2008. .. _version-1.0.2:
  2009. 1.0.2
  2010. =====
  2011. :release-date: 2010-03-31 12:50 P.M CET
  2012. * Deprecated: :setting:`CELERY_BACKEND`, please use
  2013. :setting:`CELERY_RESULT_BACKEND` instead.
  2014. * We now use a custom logger in tasks. This logger supports task magic
  2015. keyword arguments in formats.
  2016. The default format for tasks (:setting:`CELERYD_TASK_LOG_FORMAT`) now
  2017. includes the id and the name of tasks so the origin of task log messages
  2018. can easily be traced.
  2019. Example output::
  2020. [2010-03-25 13:11:20,317: INFO/PoolWorker-1]
  2021. [tasks.add(a6e1c5ad-60d9-42a0-8b24-9e39363125a4)] Hello from add
  2022. To revert to the previous behavior you can set::
  2023. CELERYD_TASK_LOG_FORMAT = """
  2024. [%(asctime)s: %(levelname)s/%(processName)s] %(message)s
  2025. """.strip()
  2026. * Unit tests: Don't disable the django test database tear down,
  2027. instead fixed the underlying issue which was caused by modifications
  2028. to the `DATABASE_NAME` setting (Issue #82).
  2029. * Django Loader: New config :setting:`CELERY_DB_REUSE_MAX` (max number of
  2030. tasks to reuse the same database connection)
  2031. The default is to use a new connection for every task.
  2032. We would very much like to reuse the connection, but a safe number of
  2033. reuses is not known, and we don't have any way to handle the errors
  2034. that might happen, which may even be database dependent.
  2035. See: http://bit.ly/94fwdd
  2036. * celeryd: The worker components are now configurable: :setting:`CELERYD_POOL`,
  2037. :setting:`CELERYD_CONSUMER`, :setting:`CELERYD_MEDIATOR`, and
  2038. :setting:`CELERYD_ETA_SCHEDULER`.
  2039. The default configuration is as follows:
  2040. .. code-block:: python
  2041. CELERYD_POOL = "celery.concurrency.processes.TaskPool"
  2042. CELERYD_MEDIATOR = "celery.worker.controllers.Mediator"
  2043. CELERYD_ETA_SCHEDULER = "celery.worker.controllers.ScheduleController"
  2044. CELERYD_CONSUMER = "celery.worker.consumer.Consumer"
  2045. The :setting:`CELERYD_POOL` setting makes it easy to swap out the
  2046. multiprocessing pool with a threaded pool, or how about a
  2047. twisted/eventlet pool?
  2048. Consider the competition for the first pool plug-in started!
  2049. * Debian init scripts: Use `-a` not `&&` (Issue #82).
  2050. * Debian init scripts: Now always preserves `$CELERYD_OPTS` from the
  2051. `/etc/default/celeryd` and `/etc/default/celerybeat`.
  2052. * celery.beat.Scheduler: Fixed a bug where the schedule was not properly
  2053. flushed to disk if the schedule had not been properly initialized.
  2054. * celerybeat: Now syncs the schedule to disk when receiving the :sig:`SIGTERM`
  2055. and :sig:`SIGINT` signals.
  2056. * Control commands: Make sure keywords arguments are not in Unicode.
  2057. * ETA scheduler: Was missing a logger object, so the scheduler crashed
  2058. when trying to log that a task had been revoked.
  2059. * management.commands.camqadm: Fixed typo `camqpadm` -> `camqadm`
  2060. (Issue #83).
  2061. * PeriodicTask.delta_resolution: Was not working for days and hours, now fixed
  2062. by rounding to the nearest day/hour.
  2063. * Fixed a potential infinite loop in `BaseAsyncResult.__eq__`, although
  2064. there is no evidence that it has ever been triggered.
  2065. * celeryd: Now handles messages with encoding problems by acking them and
  2066. emitting an error message.
  2067. .. _version-1.0.1:
  2068. 1.0.1
  2069. =====
  2070. :release-date: 2010-02-24 07:05 P.M CET
  2071. * Tasks are now acknowledged early instead of late.
  2072. This is done because messages can only be acknowledged within the same
  2073. connection channel, so if the connection is lost we would have to refetch
  2074. the message again to acknowledge it.
  2075. This might or might not affect you, but mostly those running tasks with a
  2076. really long execution time are affected, as all tasks that has made it
  2077. all the way into the pool needs to be executed before the worker can
  2078. safely terminate (this is at most the number of pool workers, multiplied
  2079. by the :setting:`CELERYD_PREFETCH_MULTIPLIER` setting.)
  2080. We multiply the prefetch count by default to increase the performance at
  2081. times with bursts of tasks with a short execution time. If this doesn't
  2082. apply to your use case, you should be able to set the prefetch multiplier
  2083. to zero, without sacrificing performance.
  2084. .. note::
  2085. A patch to :mod:`multiprocessing` is currently being
  2086. worked on, this patch would enable us to use a better solution, and is
  2087. scheduled for inclusion in the `2.0.0` release.
  2088. * celeryd now shutdowns cleanly when receiving the :sig:`SIGTERM` signal.
  2089. * celeryd now does a cold shutdown if the :sig:`SIGINT` signal is received (Ctrl+C),
  2090. this means it tries to terminate as soon as possible.
  2091. * Caching of results now moved to the base backend classes, so no need
  2092. to implement this functionality in the base classes.
  2093. * Caches are now also limited in size, so their memory usage doesn't grow
  2094. out of control.
  2095. You can set the maximum number of results the cache
  2096. can hold using the :setting:`CELERY_MAX_CACHED_RESULTS` setting (the
  2097. default is five thousand results). In addition, you can refetch already
  2098. retrieved results using `backend.reload_task_result` +
  2099. `backend.reload_taskset_result` (that's for those who want to send
  2100. results incrementally).
  2101. * `celeryd` now works on Windows again.
  2102. .. warning::
  2103. If you're using Celery with Django, you can't use `project.settings`
  2104. as the settings module name, but the following should work::
  2105. $ python manage.py celeryd --settings=settings
  2106. * Execution: `.messaging.TaskPublisher.send_task` now
  2107. incorporates all the functionality apply_async previously did.
  2108. Like converting countdowns to eta, so :func:`celery.execute.apply_async` is
  2109. now simply a convenient front-end to
  2110. :meth:`celery.messaging.TaskPublisher.send_task`, using
  2111. the task classes default options.
  2112. Also :func:`celery.execute.send_task` has been
  2113. introduced, which can apply tasks using just the task name (useful
  2114. if the client does not have the destination task in its task registry).
  2115. Example:
  2116. >>> from celery.execute import send_task
  2117. >>> result = send_task("celery.ping", args=[], kwargs={})
  2118. >>> result.get()
  2119. 'pong'
  2120. * `camqadm`: This is a new utility for command line access to the AMQP API.
  2121. Excellent for deleting queues/bindings/exchanges, experimentation and
  2122. testing::
  2123. $ camqadm
  2124. 1> help
  2125. Gives an interactive shell, type `help` for a list of commands.
  2126. When using Django, use the management command instead::
  2127. $ python manage.py camqadm
  2128. 1> help
  2129. * Redis result backend: To conform to recent Redis API changes, the following
  2130. settings has been deprecated:
  2131. * `REDIS_TIMEOUT`
  2132. * `REDIS_CONNECT_RETRY`
  2133. These will emit a `DeprecationWarning` if used.
  2134. A `REDIS_PASSWORD` setting has been added, so you can use the new
  2135. simple authentication mechanism in Redis.
  2136. * The redis result backend no longer calls `SAVE` when disconnecting,
  2137. as this is apparently better handled by Redis itself.
  2138. * If `settings.DEBUG` is on, celeryd now warns about the possible
  2139. memory leak it can result in.
  2140. * The ETA scheduler now sleeps at most two seconds between iterations.
  2141. * The ETA scheduler now deletes any revoked tasks it might encounter.
  2142. As revokes are not yet persistent, this is done to make sure the task
  2143. is revoked even though it's currently being hold because its eta is e.g.
  2144. a week into the future.
  2145. * The `task_id` argument is now respected even if the task is executed
  2146. eagerly (either using apply, or :setting:`CELERY_ALWAYS_EAGER`).
  2147. * The internal queues are now cleared if the connection is reset.
  2148. * New magic keyword argument: `delivery_info`.
  2149. Used by retry() to resend the task to its original destination using the same
  2150. exchange/routing_key.
  2151. * Events: Fields was not passed by `.send()` (fixes the UUID key errors
  2152. in celerymon)
  2153. * Added `--schedule`/`-s` option to celeryd, so it is possible to
  2154. specify a custom schedule filename when using an embedded celerybeat
  2155. server (the `-B`/`--beat`) option.
  2156. * Better Python 2.4 compatibility. The test suite now passes.
  2157. * task decorators: Now preserve docstring as `cls.__doc__`, (was previously
  2158. copied to `cls.run.__doc__`)
  2159. * The `testproj` directory has been renamed to `tests` and we're now using
  2160. `nose` + `django-nose` for test discovery, and `unittest2` for test
  2161. cases.
  2162. * New pip requirements files available in `contrib/requirements`.
  2163. * TaskPublisher: Declarations are now done once (per process).
  2164. * Added `Task.delivery_mode` and the :setting:`CELERY_DEFAULT_DELIVERY_MODE`
  2165. setting.
  2166. These can be used to mark messages non-persistent (i.e. so they are
  2167. lost if the broker is restarted).
  2168. * Now have our own `ImproperlyConfigured` exception, instead of using the
  2169. Django one.
  2170. * Improvements to the Debian init scripts: Shows an error if the program is
  2171. not executable. Does not modify `CELERYD` when using django with
  2172. virtualenv.
  2173. .. _version-1.0.0:
  2174. 1.0.0
  2175. =====
  2176. :release-date: 2010-02-10 04:00 P.M CET
  2177. .. _v100-incompatible:
  2178. Backward incompatible changes
  2179. -----------------------------
  2180. * Celery does not support detaching anymore, so you have to use the tools
  2181. available on your platform, or something like Supervisord to make
  2182. celeryd/celerybeat/celerymon into background processes.
  2183. We've had too many problems with celeryd daemonizing itself, so it was
  2184. decided it has to be removed. Example startup scripts has been added to
  2185. `contrib/`:
  2186. * Debian, Ubuntu, (start-stop-daemon)
  2187. `contrib/debian/init.d/celeryd`
  2188. `contrib/debian/init.d/celerybeat`
  2189. * Mac OS X launchd
  2190. `contrib/mac/org.celeryq.celeryd.plist`
  2191. `contrib/mac/org.celeryq.celerybeat.plist`
  2192. `contrib/mac/org.celeryq.celerymon.plist`
  2193. * Supervisord (http://supervisord.org)
  2194. `contrib/supervisord/supervisord.conf`
  2195. In addition to `--detach`, the following program arguments has been
  2196. removed: `--uid`, `--gid`, `--workdir`, `--chroot`, `--pidfile`,
  2197. `--umask`. All good daemonization tools should support equivalent
  2198. functionality, so don't worry.
  2199. Also the following configuration keys has been removed:
  2200. `CELERYD_PID_FILE`, `CELERYBEAT_PID_FILE`, `CELERYMON_PID_FILE`.
  2201. * Default celeryd loglevel is now `WARN`, to enable the previous log level
  2202. start celeryd with `--loglevel=INFO`.
  2203. * Tasks are automatically registered.
  2204. This means you no longer have to register your tasks manually.
  2205. You don't have to change your old code right away, as it doesn't matter if
  2206. a task is registered twice.
  2207. If you don't want your task to be automatically registered you can set
  2208. the `abstract` attribute
  2209. .. code-block:: python
  2210. class MyTask(Task):
  2211. abstract = True
  2212. By using `abstract` only tasks subclassing this task will be automatically
  2213. registered (this works like the Django ORM).
  2214. If you don't want subclasses to be registered either, you can set the
  2215. `autoregister` attribute to `False`.
  2216. Incidentally, this change also fixes the problems with automatic name
  2217. assignment and relative imports. So you also don't have to specify a task name
  2218. anymore if you use relative imports.
  2219. * You can no longer use regular functions as tasks.
  2220. This change was added
  2221. because it makes the internals a lot more clean and simple. However, you can
  2222. now turn functions into tasks by using the `@task` decorator:
  2223. .. code-block:: python
  2224. from celery.decorators import task
  2225. @task
  2226. def add(x, y):
  2227. return x + y
  2228. .. seealso::
  2229. :ref:`guide-tasks` for more information about the task decorators.
  2230. * The periodic task system has been rewritten to a centralized solution.
  2231. This means `celeryd` no longer schedules periodic tasks by default,
  2232. but a new daemon has been introduced: `celerybeat`.
  2233. To launch the periodic task scheduler you have to run celerybeat::
  2234. $ celerybeat
  2235. Make sure this is running on one server only, if you run it twice, all
  2236. periodic tasks will also be executed twice.
  2237. If you only have one worker server you can embed it into celeryd like this::
  2238. $ celeryd --beat # Embed celerybeat in celeryd.
  2239. * The supervisor has been removed.
  2240. This means the `-S` and `--supervised` options to `celeryd` is
  2241. no longer supported. Please use something like http://supervisord.org
  2242. instead.
  2243. * `TaskSet.join` has been removed, use `TaskSetResult.join` instead.
  2244. * The task status `"DONE"` has been renamed to `"SUCCESS"`.
  2245. * `AsyncResult.is_done` has been removed, use `AsyncResult.successful`
  2246. instead.
  2247. * The worker no longer stores errors if `Task.ignore_result` is set, to
  2248. revert to the previous behaviour set
  2249. :setting:`CELERY_STORE_ERRORS_EVEN_IF_IGNORED` to `True`.
  2250. * The statistics functionality has been removed in favor of events,
  2251. so the `-S` and --statistics` switches has been removed.
  2252. * The module `celery.task.strategy` has been removed.
  2253. * `celery.discovery` has been removed, and it's `autodiscover` function is
  2254. now in `celery.loaders.djangoapp`. Reason: Internal API.
  2255. * The :envvar:`CELERY_LOADER` environment variable now needs loader class name
  2256. in addition to module name,
  2257. E.g. where you previously had: `"celery.loaders.default"`, you now need
  2258. `"celery.loaders.default.Loader"`, using the previous syntax will result
  2259. in a `DeprecationWarning`.
  2260. * Detecting the loader is now lazy, and so is not done when importing
  2261. `celery.loaders`.
  2262. To make this happen `celery.loaders.settings` has
  2263. been renamed to `load_settings` and is now a function returning the
  2264. settings object. `celery.loaders.current_loader` is now also
  2265. a function, returning the current loader.
  2266. So::
  2267. loader = current_loader
  2268. needs to be changed to::
  2269. loader = current_loader()
  2270. .. _v100-deprecations:
  2271. Deprecations
  2272. ------------
  2273. * The following configuration variables has been renamed and will be
  2274. deprecated in v2.0:
  2275. * CELERYD_DAEMON_LOG_FORMAT -> CELERYD_LOG_FORMAT
  2276. * CELERYD_DAEMON_LOG_LEVEL -> CELERYD_LOG_LEVEL
  2277. * CELERY_AMQP_CONNECTION_TIMEOUT -> CELERY_BROKER_CONNECTION_TIMEOUT
  2278. * CELERY_AMQP_CONNECTION_RETRY -> CELERY_BROKER_CONNECTION_RETRY
  2279. * CELERY_AMQP_CONNECTION_MAX_RETRIES -> CELERY_BROKER_CONNECTION_MAX_RETRIES
  2280. * SEND_CELERY_TASK_ERROR_EMAILS -> CELERY_SEND_TASK_ERROR_EMAILS
  2281. * The public API names in celery.conf has also changed to a consistent naming
  2282. scheme.
  2283. * We now support consuming from an arbitrary number of queues.
  2284. To do this we had to rename the configuration syntax. If you use any of
  2285. the custom AMQP routing options (queue/exchange/routing_key, etc.), you
  2286. should read the new FAQ entry: http://bit.ly/aiWoH.
  2287. The previous syntax is deprecated and scheduled for removal in v2.0.
  2288. * `TaskSet.run` has been renamed to `TaskSet.apply_async`.
  2289. `TaskSet.run` has now been deprecated, and is scheduled for
  2290. removal in v2.0.
  2291. .. v100-news:
  2292. News
  2293. ----
  2294. * Rate limiting support (per task type, or globally).
  2295. * New periodic task system.
  2296. * Automatic registration.
  2297. * New cool task decorator syntax.
  2298. * celeryd now sends events if enabled with the `-E` argument.
  2299. Excellent for monitoring tools, one is already in the making
  2300. (http://github.com/ask/celerymon).
  2301. Current events include: worker-heartbeat,
  2302. task-[received/succeeded/failed/retried],
  2303. worker-online, worker-offline.
  2304. * You can now delete (revoke) tasks that has already been applied.
  2305. * You can now set the hostname celeryd identifies as using the `--hostname`
  2306. argument.
  2307. * Cache backend now respects the :setting:`CELERY_TASK_RESULT_EXPIRES` setting.
  2308. * Message format has been standardized and now uses ISO-8601 format
  2309. for dates instead of datetime.
  2310. * `celeryd` now responds to the :sig:`SIGHUP` signal by restarting itself.
  2311. * Periodic tasks are now scheduled on the clock.
  2312. I.e. `timedelta(hours=1)` means every hour at :00 minutes, not every
  2313. hour from the server starts. To revert to the previous behaviour you
  2314. can set `PeriodicTask.relative = True`.
  2315. * Now supports passing execute options to a TaskSets list of args, e.g.:
  2316. >>> ts = TaskSet(add, [([2, 2], {}, {"countdown": 1}),
  2317. ... ([4, 4], {}, {"countdown": 2}),
  2318. ... ([8, 8], {}, {"countdown": 3})])
  2319. >>> ts.run()
  2320. * Got a 3x performance gain by setting the prefetch count to four times the
  2321. concurrency, (from an average task round-trip of 0.1s to 0.03s!).
  2322. A new setting has been added: :setting:`CELERYD_PREFETCH_MULTIPLIER`, which
  2323. is set to `4` by default.
  2324. * Improved support for webhook tasks.
  2325. `celery.task.rest` is now deprecated, replaced with the new and shiny
  2326. :mod:`celery.task.http`. With more reflective names, sensible interface,
  2327. and it's possible to override the methods used to perform HTTP requests.
  2328. * The results of task sets are now cached by storing it in the result
  2329. backend.
  2330. .. _v100-changes:
  2331. Changes
  2332. -------
  2333. * Now depends on carrot >= 0.8.1
  2334. * New dependencies: billiard, python-dateutil, django-picklefield
  2335. * No longer depends on python-daemon
  2336. * The `uuid` distribution is added as a dependency when running Python 2.4.
  2337. * Now remembers the previously detected loader by keeping it in
  2338. the :envvar:`CELERY_LOADER` environment variable.
  2339. This may help on windows where fork emulation is used.
  2340. * ETA no longer sends datetime objects, but uses ISO 8601 date format in a
  2341. string for better compatibility with other platforms.
  2342. * No longer sends error mails for retried tasks.
  2343. * Task can now override the backend used to store results.
  2344. * Refactored the ExecuteWrapper, `apply` and :setting:`CELERY_ALWAYS_EAGER`
  2345. now also executes the task callbacks and signals.
  2346. * Now using a proper scheduler for the tasks with an ETA.
  2347. This means waiting eta tasks are sorted by time, so we don't have
  2348. to poll the whole list all the time.
  2349. * Now also imports modules listed in :setting:`CELERY_IMPORTS` when running
  2350. with django (as documented).
  2351. * Log level for stdout/stderr changed from INFO to ERROR
  2352. * ImportErrors are now properly propagated when autodiscovering tasks.
  2353. * You can now use `celery.messaging.establish_connection` to establish a
  2354. connection to the broker.
  2355. * When running as a separate service the periodic task scheduler does some
  2356. smart moves to not poll too regularly.
  2357. If you need faster poll times you can lower the value
  2358. of :setting:`CELERYBEAT_MAX_LOOP_INTERVAL`.
  2359. * You can now change periodic task intervals at runtime, by making
  2360. `run_every` a property, or subclassing `PeriodicTask.is_due`.
  2361. * The worker now supports control commands enabled through the use of a
  2362. broadcast queue, you can remotely revoke tasks or set the rate limit for
  2363. a task type. See :mod:`celery.task.control`.
  2364. * The services now sets informative process names (as shown in `ps`
  2365. listings) if the :mod:`setproctitle` module is installed.
  2366. * :exc:`celery.exceptions.NotRegistered` now inherits from :exc:`KeyError`,
  2367. and `TaskRegistry.__getitem__`+`pop` raises `NotRegistered` instead
  2368. * You can set the loader via the :envvar:`CELERY_LOADER` environment variable.
  2369. * You can now set :setting:`CELERY_IGNORE_RESULT` to ignore task results by
  2370. default (if enabled, tasks doesn't save results or errors to the backend used).
  2371. * celeryd now correctly handles malformed messages by throwing away and
  2372. acknowledging the message, instead of crashing.
  2373. .. _v100-bugs:
  2374. Bugs
  2375. ----
  2376. * Fixed a race condition that could happen while storing task results in the
  2377. database.
  2378. .. _v100-documentation:
  2379. Documentation
  2380. -------------
  2381. * Reference now split into two sections; API reference and internal module
  2382. reference.
  2383. .. _version-0.8.4:
  2384. 0.8.4
  2385. =====
  2386. :release-date: 2010-02-05 01:52 P.M CEST
  2387. * Now emits a warning if the --detach argument is used.
  2388. --detach should not be used anymore, as it has several not easily fixed
  2389. bugs related to it. Instead, use something like start-stop-daemon,
  2390. Supervisord or launchd (os x).
  2391. * Make sure logger class is process aware, even if running Python >= 2.6.
  2392. * Error e-mails are not sent anymore when the task is retried.
  2393. .. _version-0.8.3:
  2394. 0.8.3
  2395. =====
  2396. :release-date: 2009-12-22 09:43 A.M CEST
  2397. * Fixed a possible race condition that could happen when storing/querying
  2398. task results using the database backend.
  2399. * Now has console script entry points in the setup.py file, so tools like
  2400. Buildout will correctly install the programs celeryd and celeryinit.
  2401. .. _version-0.8.2:
  2402. 0.8.2
  2403. =====
  2404. :release-date: 2009-11-20 03:40 P.M CEST
  2405. * QOS Prefetch count was not applied properly, as it was set for every message
  2406. received (which apparently behaves like, "receive one more"), instead of only
  2407. set when our wanted value changed.
  2408. .. _version-0.8.1:
  2409. 0.8.1
  2410. =================================
  2411. :release-date: 2009-11-16 05:21 P.M CEST
  2412. .. _v081-very-important:
  2413. Very important note
  2414. -------------------
  2415. This release (with carrot 0.8.0) enables AMQP QoS (quality of service), which
  2416. means the workers will only receive as many messages as it can handle at a
  2417. time. As with any release, you should test this version upgrade on your
  2418. development servers before rolling it out to production!
  2419. .. _v081-important:
  2420. Important changes
  2421. -----------------
  2422. * If you're using Python < 2.6 and you use the multiprocessing backport, then
  2423. multiprocessing version 2.6.2.1 is required.
  2424. * All AMQP_* settings has been renamed to BROKER_*, and in addition
  2425. AMQP_SERVER has been renamed to BROKER_HOST, so before where you had::
  2426. AMQP_SERVER = "localhost"
  2427. AMQP_PORT = 5678
  2428. AMQP_USER = "myuser"
  2429. AMQP_PASSWORD = "mypassword"
  2430. AMQP_VHOST = "celery"
  2431. You need to change that to::
  2432. BROKER_HOST = "localhost"
  2433. BROKER_PORT = 5678
  2434. BROKER_USER = "myuser"
  2435. BROKER_PASSWORD = "mypassword"
  2436. BROKER_VHOST = "celery"
  2437. * Custom carrot backends now need to include the backend class name, so before
  2438. where you had::
  2439. CARROT_BACKEND = "mycustom.backend.module"
  2440. you need to change it to::
  2441. CARROT_BACKEND = "mycustom.backend.module.Backend"
  2442. where `Backend` is the class name. This is probably `"Backend"`, as
  2443. that was the previously implied name.
  2444. * New version requirement for carrot: 0.8.0
  2445. .. _v081-changes:
  2446. Changes
  2447. -------
  2448. * Incorporated the multiprocessing backport patch that fixes the
  2449. `processName` error.
  2450. * Ignore the result of PeriodicTask's by default.
  2451. * Added a Redis result store backend
  2452. * Allow /etc/default/celeryd to define additional options for the celeryd init
  2453. script.
  2454. * MongoDB periodic tasks issue when using different time than UTC fixed.
  2455. * Windows specific: Negate test for available os.fork (thanks miracle2k)
  2456. * Now tried to handle broken PID files.
  2457. * Added a Django test runner to contrib that sets
  2458. `CELERY_ALWAYS_EAGER = True` for testing with the database backend.
  2459. * Added a :setting:`CELERY_CACHE_BACKEND` setting for using something other
  2460. than the django-global cache backend.
  2461. * Use custom implementation of functools.partial (curry) for Python 2.4 support
  2462. (Probably still problems with running on 2.4, but it will eventually be
  2463. supported)
  2464. * Prepare exception to pickle when saving :state:`RETRY` status for all backends.
  2465. * SQLite no concurrency limit should only be effective if the database backend
  2466. is used.
  2467. .. _version-0.8.0:
  2468. 0.8.0
  2469. =====
  2470. :release-date: 2009-09-22 03:06 P.M CEST
  2471. .. _v080-incompatible:
  2472. Backward incompatible changes
  2473. -----------------------------
  2474. * Add traceback to result value on failure.
  2475. .. note::
  2476. If you use the database backend you have to re-create the
  2477. database table `celery_taskmeta`.
  2478. Contact the :ref:`mailing-list` or :ref:`irc-channel` channel
  2479. for help doing this.
  2480. * Database tables are now only created if the database backend is used,
  2481. so if you change back to the database backend at some point,
  2482. be sure to initialize tables (django: `syncdb`, python: `celeryinit`).
  2483. .. note::
  2484. This is only applies if using Django version 1.1 or higher.
  2485. * Now depends on `carrot` version 0.6.0.
  2486. * Now depends on python-daemon 1.4.8
  2487. .. _v080-important:
  2488. Important changes
  2489. -----------------
  2490. * Celery can now be used in pure Python (outside of a Django project).
  2491. This means celery is no longer Django specific.
  2492. For more information see the FAQ entry
  2493. :ref:`faq-is-celery-for-django-only`.
  2494. * Celery now supports task retries.
  2495. See `Cookbook: Retrying Tasks`_ for more information.
  2496. .. _`Cookbook: Retrying Tasks`:
  2497. http://ask.github.com/celery/cookbook/task-retries.html
  2498. * We now have an AMQP result store backend.
  2499. It uses messages to publish task return value and status. And it's
  2500. incredibly fast!
  2501. See issue #6 for more info!
  2502. * AMQP QoS (prefetch count) implemented:
  2503. This to not receive more messages than we can handle.
  2504. * Now redirects stdout/stderr to the celeryd log file when detached
  2505. * Now uses `inspect.getargspec` to only pass default arguments
  2506. the task supports.
  2507. * Add Task.on_success, .on_retry, .on_failure handlers
  2508. See :meth:`celery.task.base.Task.on_success`,
  2509. :meth:`celery.task.base.Task.on_retry`,
  2510. :meth:`celery.task.base.Task.on_failure`,
  2511. * `celery.utils.gen_unique_id`: Workaround for
  2512. http://bugs.python.org/issue4607
  2513. * You can now customize what happens at worker start, at process init, etc.,
  2514. by creating your own loaders. (see :mod:`celery.loaders.default`,
  2515. :mod:`celery.loaders.djangoapp`, :mod:`celery.loaders`.)
  2516. * Support for multiple AMQP exchanges and queues.
  2517. This feature misses documentation and tests, so anyone interested
  2518. is encouraged to improve this situation.
  2519. * celeryd now survives a restart of the AMQP server!
  2520. Automatically re-establish AMQP broker connection if it's lost.
  2521. New settings:
  2522. * AMQP_CONNECTION_RETRY
  2523. Set to `True` to enable connection retries.
  2524. * AMQP_CONNECTION_MAX_RETRIES.
  2525. Maximum number of restarts before we give up. Default: `100`.
  2526. .. _v080-news:
  2527. News
  2528. ----
  2529. * Fix an incompatibility between python-daemon and multiprocessing,
  2530. which resulted in the `[Errno 10] No child processes` problem when
  2531. detaching.
  2532. * Fixed a possible DjangoUnicodeDecodeError being raised when saving pickled
  2533. data to Django`s memcached cache backend.
  2534. * Better Windows compatibility.
  2535. * New version of the pickled field (taken from
  2536. http://www.djangosnippets.org/snippets/513/)
  2537. * New signals introduced: `task_sent`, `task_prerun` and
  2538. `task_postrun`, see :mod:`celery.signals` for more information.
  2539. * `TaskSetResult.join` caused `TypeError` when `timeout=None`.
  2540. Thanks Jerzy Kozera. Closes #31
  2541. * `views.apply` should return `HttpResponse` instance.
  2542. Thanks to Jerzy Kozera. Closes #32
  2543. * `PeriodicTask`: Save conversion of `run_every` from `int`
  2544. to `timedelta` to the class attribute instead of on the instance.
  2545. * Exceptions has been moved to `celery.exceptions`, but are still
  2546. available in the previous module.
  2547. * Try to rollback transaction and retry saving result if an error happens
  2548. while setting task status with the database backend.
  2549. * jail() refactored into :class:`celery.execute.ExecuteWrapper`.
  2550. * `views.apply` now correctly sets mime-type to "application/json"
  2551. * `views.task_status` now returns exception if state is :state:`RETRY`
  2552. * `views.task_status` now returns traceback if state is :state:`FAILURE`
  2553. or :state:`RETRY`
  2554. * Documented default task arguments.
  2555. * Add a sensible __repr__ to ExceptionInfo for easier debugging
  2556. * Fix documentation typo `.. import map` -> `.. import dmap`.
  2557. Thanks to mikedizon
  2558. .. _version-0.6.0:
  2559. 0.6.0
  2560. =====
  2561. :release-date: 2009-08-07 06:54 A.M CET
  2562. .. _v060-important:
  2563. Important changes
  2564. -----------------
  2565. * Fixed a bug where tasks raising unpickleable exceptions crashed pool
  2566. workers. So if you've had pool workers mysteriously disappearing, or
  2567. problems with celeryd stopping working, this has been fixed in this
  2568. version.
  2569. * Fixed a race condition with periodic tasks.
  2570. * The task pool is now supervised, so if a pool worker crashes,
  2571. goes away or stops responding, it is automatically replaced with
  2572. a new one.
  2573. * Task.name is now automatically generated out of class module+name, e.g.
  2574. `"djangotwitter.tasks.UpdateStatusesTask"`. Very convenient. No idea why
  2575. we didn't do this before. Some documentation is updated to not manually
  2576. specify a task name.
  2577. .. _v060-news:
  2578. News
  2579. ----
  2580. * Tested with Django 1.1
  2581. * New Tutorial: Creating a click counter using carrot and celery
  2582. * Database entries for periodic tasks are now created at `celeryd`
  2583. startup instead of for each check (which has been a forgotten TODO/XXX
  2584. in the code for a long time)
  2585. * New settings variable: :setting:`CELERY_TASK_RESULT_EXPIRES`
  2586. Time (in seconds, or a `datetime.timedelta` object) for when after
  2587. stored task results are deleted. For the moment this only works for the
  2588. database backend.
  2589. * `celeryd` now emits a debug log message for which periodic tasks
  2590. has been launched.
  2591. * The periodic task table is now locked for reading while getting
  2592. periodic task status. (MySQL only so far, seeking patches for other
  2593. engines)
  2594. * A lot more debugging information is now available by turning on the
  2595. `DEBUG` log level (`--loglevel=DEBUG`).
  2596. * Functions/methods with a timeout argument now works correctly.
  2597. * New: `celery.strategy.even_time_distribution`:
  2598. With an iterator yielding task args, kwargs tuples, evenly distribute
  2599. the processing of its tasks throughout the time window available.
  2600. * Log message `Unknown task ignored...` now has log level `ERROR`
  2601. * Log message `"Got task from broker"` is now emitted for all tasks, even if
  2602. the task has an ETA (estimated time of arrival). Also the message now
  2603. includes the ETA for the task (if any).
  2604. * Acknowledgement now happens in the pool callback. Can't do ack in the job
  2605. target, as it's not pickleable (can't share AMQP connection, etc.)).
  2606. * Added note about .delay hanging in README
  2607. * Tests now passing in Django 1.1
  2608. * Fixed discovery to make sure app is in INSTALLED_APPS
  2609. * Previously overridden pool behavior (process reap, wait until pool worker
  2610. available, etc.) is now handled by `multiprocessing.Pool` itself.
  2611. * Convert statistics data to Unicode for use as kwargs. Thanks Lucy!
  2612. .. _version-0.4.1:
  2613. 0.4.1
  2614. =====
  2615. :release-date: 2009-07-02 01:42 P.M CET
  2616. * Fixed a bug with parsing the message options (`mandatory`,
  2617. `routing_key`, `priority`, `immediate`)
  2618. .. _version-0.4.0:
  2619. 0.4.0
  2620. =====
  2621. :release-date: 2009-07-01 07:29 P.M CET
  2622. * Adds eager execution. `celery.execute.apply`|`Task.apply` executes the
  2623. function blocking until the task is done, for API compatibility it
  2624. returns an `celery.result.EagerResult` instance. You can configure
  2625. celery to always run tasks locally by setting the
  2626. :setting:`CELERY_ALWAYS_EAGER` setting to `True`.
  2627. * Now depends on `anyjson`.
  2628. * 99% coverage using python `coverage` 3.0.
  2629. .. _version-0.3.20:
  2630. 0.3.20
  2631. ======
  2632. :release-date: 2009-06-25 08:42 P.M CET
  2633. * New arguments to `apply_async` (the advanced version of
  2634. `delay_task`), `countdown` and `eta`;
  2635. >>> # Run 10 seconds into the future.
  2636. >>> res = apply_async(MyTask, countdown=10);
  2637. >>> # Run 1 day from now
  2638. >>> res = apply_async(MyTask,
  2639. ... eta=datetime.now() + timedelta(days=1))
  2640. * Now unlinks stale PID files
  2641. * Lots of more tests.
  2642. * Now compatible with carrot >= 0.5.0.
  2643. * **IMPORTANT** The `subtask_ids` attribute on the `TaskSetResult`
  2644. instance has been removed. To get this information instead use:
  2645. >>> subtask_ids = [subtask.task_id for subtask in ts_res.subtasks]
  2646. * `Taskset.run()` now respects extra message options from the task class.
  2647. * Task: Add attribute `ignore_result`: Don't store the status and
  2648. return value. This means you can't use the
  2649. `celery.result.AsyncResult` to check if the task is
  2650. done, or get its return value. Only use if you need the performance
  2651. and is able live without these features. Any exceptions raised will
  2652. store the return value/status as usual.
  2653. * Task: Add attribute `disable_error_emails` to disable sending error
  2654. emails for that task.
  2655. * Should now work on Windows (although running in the background won't
  2656. work, so using the `--detach` argument results in an exception
  2657. being raised.)
  2658. * Added support for statistics for profiling and monitoring.
  2659. To start sending statistics start `celeryd` with the
  2660. `--statistics option. Then after a while you can dump the results
  2661. by running `python manage.py celerystats`. See
  2662. `celery.monitoring` for more information.
  2663. * The celery daemon can now be supervised (i.e. it is automatically
  2664. restarted if it crashes). To use this start celeryd with the
  2665. --supervised` option (or alternatively `-S`).
  2666. * views.apply: View applying a task. Example
  2667. ::
  2668. http://e.com/celery/apply/task_name/arg1/arg2//?kwarg1=a&kwarg2=b
  2669. .. warning::
  2670. Use with caution! Do not expose this URL to the public
  2671. without first ensuring that your code is safe!
  2672. * Refactored `celery.task`. It's now split into three modules:
  2673. * celery.task
  2674. Contains `apply_async`, `delay_task`, `discard_all`, and task
  2675. shortcuts, plus imports objects from `celery.task.base` and
  2676. `celery.task.builtins`
  2677. * celery.task.base
  2678. Contains task base classes: `Task`, `PeriodicTask`,
  2679. `TaskSet`, `AsynchronousMapTask`, `ExecuteRemoteTask`.
  2680. * celery.task.builtins
  2681. Built-in tasks: `PingTask`, `DeleteExpiredTaskMetaTask`.
  2682. .. _version-0.3.7:
  2683. 0.3.7
  2684. =====
  2685. :release-date: 2008-06-16 11:41 P.M CET
  2686. * **IMPORTANT** Now uses AMQP`s `basic.consume` instead of
  2687. `basic.get`. This means we're no longer polling the broker for
  2688. new messages.
  2689. * **IMPORTANT** Default concurrency limit is now set to the number of CPUs
  2690. available on the system.
  2691. * **IMPORTANT** `tasks.register`: Renamed `task_name` argument to
  2692. `name`, so
  2693. >>> tasks.register(func, task_name="mytask")
  2694. has to be replaced with:
  2695. >>> tasks.register(func, name="mytask")
  2696. * The daemon now correctly runs if the pidlock is stale.
  2697. * Now compatible with carrot 0.4.5
  2698. * Default AMQP connection timeout is now 4 seconds.
  2699. * `AsyncResult.read()` was always returning `True`.
  2700. * Only use README as long_description if the file exists so easy_install
  2701. doesn't break.
  2702. * `celery.view`: JSON responses now properly set its mime-type.
  2703. * `apply_async` now has a `connection` keyword argument so you
  2704. can re-use the same AMQP connection if you want to execute
  2705. more than one task.
  2706. * Handle failures in task_status view such that it won't throw 500s.
  2707. * Fixed typo `AMQP_SERVER` in documentation to `AMQP_HOST`.
  2708. * Worker exception e-mails sent to administrators now works properly.
  2709. * No longer depends on `django`, so installing `celery` won't affect
  2710. the preferred Django version installed.
  2711. * Now works with PostgreSQL (psycopg2) again by registering the
  2712. `PickledObject` field.
  2713. * `celeryd`: Added `--detach` option as an alias to `--daemon`, and
  2714. it's the term used in the documentation from now on.
  2715. * Make sure the pool and periodic task worker thread is terminated
  2716. properly at exit. (So `Ctrl-C` works again).
  2717. * Now depends on `python-daemon`.
  2718. * Removed dependency to `simplejson`
  2719. * Cache Backend: Re-establishes connection for every task process
  2720. if the Django cache backend is memcached/libmemcached.
  2721. * Tyrant Backend: Now re-establishes the connection for every task
  2722. executed.
  2723. .. _version-0.3.3:
  2724. 0.3.3
  2725. =====
  2726. :release-date: 2009-06-08 01:07 P.M CET
  2727. * The `PeriodicWorkController` now sleeps for 1 second between checking
  2728. for periodic tasks to execute.
  2729. .. _version-0.3.2:
  2730. 0.3.2
  2731. =====
  2732. :release-date: 2009-06-08 01:07 P.M CET
  2733. * celeryd: Added option `--discard`: Discard (delete!) all waiting
  2734. messages in the queue.
  2735. * celeryd: The `--wakeup-after` option was not handled as a float.
  2736. .. _version-0.3.1:
  2737. 0.3.1
  2738. =====
  2739. :release-date: 2009-06-08 01:07 P.M CET
  2740. * The `PeriodicTask` worker is now running in its own thread instead
  2741. of blocking the `TaskController` loop.
  2742. * Default `QUEUE_WAKEUP_AFTER` has been lowered to `0.1` (was `0.3`)
  2743. .. _version-0.3.0:
  2744. 0.3.0
  2745. =====
  2746. :release-date: 2009-06-08 12:41 P.M CET
  2747. .. warning::
  2748. This is a development version, for the stable release, please
  2749. see versions 0.2.x.
  2750. **VERY IMPORTANT:** Pickle is now the encoder used for serializing task
  2751. arguments, so be sure to flush your task queue before you upgrade.
  2752. * **IMPORTANT** TaskSet.run() now returns a celery.result.TaskSetResult
  2753. instance, which lets you inspect the status and return values of a
  2754. taskset as it was a single entity.
  2755. * **IMPORTANT** Celery now depends on carrot >= 0.4.1.
  2756. * The celery daemon now sends task errors to the registered admin e-mails.
  2757. To turn off this feature, set `SEND_CELERY_TASK_ERROR_EMAILS` to
  2758. `False` in your `settings.py`. Thanks to Grégoire Cachet.
  2759. * You can now run the celery daemon by using `manage.py`::
  2760. $ python manage.py celeryd
  2761. Thanks to Grégoire Cachet.
  2762. * Added support for message priorities, topic exchanges, custom routing
  2763. keys for tasks. This means we have introduced
  2764. `celery.task.apply_async`, a new way of executing tasks.
  2765. You can use `celery.task.delay` and `celery.Task.delay` like usual, but
  2766. if you want greater control over the message sent, you want
  2767. `celery.task.apply_async` and `celery.Task.apply_async`.
  2768. This also means the AMQP configuration has changed. Some settings has
  2769. been renamed, while others are new::
  2770. CELERY_AMQP_EXCHANGE
  2771. CELERY_AMQP_PUBLISHER_ROUTING_KEY
  2772. CELERY_AMQP_CONSUMER_ROUTING_KEY
  2773. CELERY_AMQP_CONSUMER_QUEUE
  2774. CELERY_AMQP_EXCHANGE_TYPE
  2775. See the entry `Can I send some tasks to only some servers?`_ in the
  2776. `FAQ`_ for more information.
  2777. .. _`Can I send some tasks to only some servers?`:
  2778. http://bit.ly/celery_AMQP_routing
  2779. .. _`FAQ`: http://ask.github.com/celery/faq.html
  2780. * Task errors are now logged using log level `ERROR` instead of `INFO`,
  2781. and stacktraces are dumped. Thanks to Grégoire Cachet.
  2782. * Make every new worker process re-establish it's Django DB connection,
  2783. this solving the "MySQL connection died?" exceptions.
  2784. Thanks to Vitaly Babiy and Jirka Vejrazka.
  2785. * **IMPORTANT** Now using pickle to encode task arguments. This means you
  2786. now can pass complex python objects to tasks as arguments.
  2787. * Removed dependency to `yadayada`.
  2788. * Added a FAQ, see `docs/faq.rst`.
  2789. * Now converts any Unicode keys in task `kwargs` to regular strings.
  2790. Thanks Vitaly Babiy.
  2791. * Renamed the `TaskDaemon` to `WorkController`.
  2792. * `celery.datastructures.TaskProcessQueue` is now renamed to
  2793. `celery.pool.TaskPool`.
  2794. * The pool algorithm has been refactored for greater performance and
  2795. stability.
  2796. .. _version-0.2.0:
  2797. 0.2.0
  2798. =====
  2799. :release-date: 2009-05-20 05:14 P.M CET
  2800. * Final release of 0.2.0
  2801. * Compatible with carrot version 0.4.0.
  2802. * Fixes some syntax errors related to fetching results
  2803. from the database backend.
  2804. .. _version-0.2.0-pre3:
  2805. 0.2.0-pre3
  2806. ==========
  2807. :release-date: 2009-05-20 05:14 P.M CET
  2808. * *Internal release*. Improved handling of unpickleable exceptions,
  2809. `get_result` now tries to recreate something looking like the
  2810. original exception.
  2811. .. _version-0.2.0-pre2:
  2812. 0.2.0-pre2
  2813. ==========
  2814. :release-date: 2009-05-20 01:56 P.M CET
  2815. * Now handles unpickleable exceptions (like the dynamically generated
  2816. subclasses of `django.core.exception.MultipleObjectsReturned`).
  2817. .. _version-0.2.0-pre1:
  2818. 0.2.0-pre1
  2819. ==========
  2820. :release-date: 2009-05-20 12:33 P.M CET
  2821. * It's getting quite stable, with a lot of new features, so bump
  2822. version to 0.2. This is a pre-release.
  2823. * `celery.task.mark_as_read()` and `celery.task.mark_as_failure()` has
  2824. been removed. Use `celery.backends.default_backend.mark_as_read()`,
  2825. and `celery.backends.default_backend.mark_as_failure()` instead.
  2826. .. _version-0.1.15:
  2827. 0.1.15
  2828. ======
  2829. :release-date: 2009-05-19 04:13 P.M CET
  2830. * The celery daemon was leaking AMQP connections, this should be fixed,
  2831. if you have any problems with too many files open (like `emfile`
  2832. errors in `rabbit.log`, please contact us!
  2833. .. _version-0.1.14:
  2834. 0.1.14
  2835. ======
  2836. :release-date: 2009-05-19 01:08 P.M CET
  2837. * Fixed a syntax error in the `TaskSet` class. (No such variable
  2838. `TimeOutError`).
  2839. .. _version-0.1.13:
  2840. 0.1.13
  2841. ======
  2842. :release-date: 2009-05-19 12:36 P.M CET
  2843. * Forgot to add `yadayada` to install requirements.
  2844. * Now deletes all expired task results, not just those marked as done.
  2845. * Able to load the Tokyo Tyrant backend class without django
  2846. configuration, can specify tyrant settings directly in the class
  2847. constructor.
  2848. * Improved API documentation
  2849. * Now using the Sphinx documentation system, you can build
  2850. the html documentation by doing ::
  2851. $ cd docs
  2852. $ make html
  2853. and the result will be in `docs/.build/html`.
  2854. .. _version-0.1.12:
  2855. 0.1.12
  2856. ======
  2857. :release-date: 2009-05-18 04:38 P.M CET
  2858. * `delay_task()` etc. now returns `celery.task.AsyncResult` object,
  2859. which lets you check the result and any failure that might have
  2860. happened. It kind of works like the `multiprocessing.AsyncResult`
  2861. class returned by `multiprocessing.Pool.map_async`.
  2862. * Added dmap() and dmap_async(). This works like the
  2863. `multiprocessing.Pool` versions except they are tasks
  2864. distributed to the celery server. Example:
  2865. >>> from celery.task import dmap
  2866. >>> import operator
  2867. >>> dmap(operator.add, [[2, 2], [4, 4], [8, 8]])
  2868. >>> [4, 8, 16]
  2869. >>> from celery.task import dmap_async
  2870. >>> import operator
  2871. >>> result = dmap_async(operator.add, [[2, 2], [4, 4], [8, 8]])
  2872. >>> result.ready()
  2873. False
  2874. >>> time.sleep(1)
  2875. >>> result.ready()
  2876. True
  2877. >>> result.result
  2878. [4, 8, 16]
  2879. * Refactored the task metadata cache and database backends, and added
  2880. a new backend for Tokyo Tyrant. You can set the backend in your django
  2881. settings file. E.g.::
  2882. CELERY_RESULT_BACKEND = "database"; # Uses the database
  2883. CELERY_RESULT_BACKEND = "cache"; # Uses the django cache framework
  2884. CELERY_RESULT_BACKEND = "tyrant"; # Uses Tokyo Tyrant
  2885. TT_HOST = "localhost"; # Hostname for the Tokyo Tyrant server.
  2886. TT_PORT = 6657; # Port of the Tokyo Tyrant server.
  2887. .. _version-0.1.11:
  2888. 0.1.11
  2889. ======
  2890. :release-date: 2009-05-12 02:08 P.M CET
  2891. * The logging system was leaking file descriptors, resulting in
  2892. servers stopping with the EMFILES (too many open files) error. (fixed)
  2893. .. _version-0.1.10:
  2894. 0.1.10
  2895. ======
  2896. :release-date: 2009-05-11 12:46 P.M CET
  2897. * Tasks now supports both positional arguments and keyword arguments.
  2898. * Requires carrot 0.3.8.
  2899. * The daemon now tries to reconnect if the connection is lost.
  2900. .. _version-0.1.8:
  2901. 0.1.8
  2902. =====
  2903. :release-date: 2009-05-07 12:27 P.M CET
  2904. * Better test coverage
  2905. * More documentation
  2906. * celeryd doesn't emit `Queue is empty` message if
  2907. `settings.CELERYD_EMPTY_MSG_EMIT_EVERY` is 0.
  2908. .. _version-0.1.7:
  2909. 0.1.7
  2910. =====
  2911. :release-date: 2009-04-30 01:50 P.M CET
  2912. * Added some unit tests
  2913. * Can now use the database for task metadata (like if the task has
  2914. been executed or not). Set `settings.CELERY_TASK_META`
  2915. * Can now run `python setup.py test` to run the unit tests from
  2916. within the `tests` project.
  2917. * Can set the AMQP exchange/routing key/queue using
  2918. `settings.CELERY_AMQP_EXCHANGE`, `settings.CELERY_AMQP_ROUTING_KEY`,
  2919. and `settings.CELERY_AMQP_CONSUMER_QUEUE`.
  2920. .. _version-0.1.6:
  2921. 0.1.6
  2922. =====
  2923. :release-date: 2009-04-28 02:13 P.M CET
  2924. * Introducing `TaskSet`. A set of subtasks is executed and you can
  2925. find out how many, or if all them, are done (excellent for progress
  2926. bars and such)
  2927. * Now catches all exceptions when running `Task.__call__`, so the
  2928. daemon doesn't die. This doesn't happen for pure functions yet, only
  2929. `Task` classes.
  2930. * `autodiscover()` now works with zipped eggs.
  2931. * celeryd: Now adds current working directory to `sys.path` for
  2932. convenience.
  2933. * The `run_every` attribute of `PeriodicTask` classes can now be a
  2934. `datetime.timedelta()` object.
  2935. * celeryd: You can now set the `DJANGO_PROJECT_DIR` variable
  2936. for `celeryd` and it will add that to `sys.path` for easy launching.
  2937. * Can now check if a task has been executed or not via HTTP.
  2938. * You can do this by including the celery `urls.py` into your project,
  2939. >>> url(r'^celery/$', include("celery.urls"))
  2940. then visiting the following url,::
  2941. http://mysite/celery/$task_id/done/
  2942. this will return a JSON dictionary like e.g:
  2943. >>> {"task": {"id": $task_id, "executed": true}}
  2944. * `delay_task` now returns string id, not `uuid.UUID` instance.
  2945. * Now has `PeriodicTasks`, to have `cron` like functionality.
  2946. * Project changed name from `crunchy` to `celery`. The details of
  2947. the name change request is in `docs/name_change_request.txt`.
  2948. .. _version-0.1.0:
  2949. 0.1.0
  2950. =====
  2951. :release-date: 2009-04-24 11:28 A.M CET
  2952. * Initial release