Changelog 109 KB

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