Changelog 110 KB

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