Changelog 93 KB

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