Changelog 109 KB

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