Changelog 91 KB

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