Changelog 82 KB

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