Changelog 160 KB

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