Changelog 57 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677
  1. ================
  2. Change history
  3. ================
  4. 1.2.0 [xxxx-xx-xx xx:xx x.x xxxx]
  5. =================================
  6. Upgrading for Django-users
  7. --------------------------
  8. Django integration has been moved to a separate package: `django-celery`_.
  9. * To upgrade you need to install the `django-celery`_ module and change::
  10. INSTALLED_APPS = "celery"
  11. to::
  12. INSTALLED_APPS = "djcelery"
  13. * The following modules has been moved to `django-celery`_:
  14. ===================================== =====================================
  15. **Module name** **Replace with**
  16. ===================================== =====================================
  17. ``celery.models`` ``djcelery.models``
  18. ``celery.managers`` ``djcelery.managers``
  19. ``celery.views`` ``djcelery.views``
  20. ``celery.urls`` ``djcelery.url``
  21. ``celery.management`` ``djcelery.management``
  22. ``celery.loaders.djangoapp`` ``djcelery.loaders``
  23. ``celery.backends.database`` ``djcelery.backends.database``
  24. ``celery.backends.cache`` ``djcelery.backends.cache``
  25. ===================================== =====================================
  26. Importing ``djcelery`` will automatically setup celery to use the Django
  27. loader by setting the :envvar:`CELERY_LOADER`` environment variable (it won't
  28. change it if it's already defined).
  29. When the Django loader is used, the "database" and "cache" backend aliases
  30. will point to the ``djcelery`` backends instead of the built-in backends.
  31. .. _`django-celery`: http://pypi.python.org/pypi/django-celery
  32. Upgrading for others
  33. --------------------
  34. The database backend is now using `SQLAlchemy`_ instead of the Django ORM,
  35. see `Supported Databases`_ for a table of supported databases.
  36. The ``DATABASE_*`` settings has been replaced by a single setting:
  37. ``CELERY_RESULT_DBURI``. The value here should be an `SQLAlchemy Connection
  38. String`_, some examples include:
  39. .. code-block:: python
  40. # sqlite (filename)
  41. CELERY_RESULT_DBURI = "sqlite:///celerydb.sqlite"
  42. # mysql
  43. CELERY_RESULT_DBURI = "mysql://scott:tiger@localhost/foo"
  44. # postgresql
  45. CELERY_RESULT_DBURI = "postgresql://scott:tiger@localhost/mydatabase"
  46. # oracle
  47. CELERY_RESULT_DBURI = "oracle://scott:tiger@127.0.0.1:1521/sidname"
  48. See `SQLAlchemy Connection Strings`_ for more information about connection
  49. strings.
  50. To specify additional SQLAlchemy database engine options you can use
  51. the ``CELERY_RESULT_ENGINE_OPTIONS`` setting::
  52. # echo enables verbose logging from SQLAlchemy.
  53. CELERY_RESULT_ENGINE_OPTIONS = {"echo": True}
  54. .. _`SQLAlchemy`:
  55. http://www.sqlalchemy.org
  56. .. _`Supported Databases`:
  57. http://www.sqlalchemy.org/docs/dbengine.html#supported-databases
  58. .. _`SQLAlchemy Connection String`:
  59. http://www.sqlalchemy.org/docs/dbengine.html#create-engine-url-arguments
  60. .. _`SQLAlchemy Connection Strings`:
  61. http://www.sqlalchemy.org/docs/dbengine.html#create-engine-url-arguments
  62. Backward incompatible changes
  63. -----------------------------
  64. * The following deprecated settings has been removed (as scheduled by
  65. the `deprecation timeline`_):
  66. ===================================== =====================================
  67. **Setting name** **Replace with**
  68. ===================================== =====================================
  69. ``CELERY_AMQP_CONSUMER_QUEUES`` ``CELERY_QUEUES``
  70. ``CELERY_AMQP_CONSUMER_QUEUES`` ``CELERY_QUEUES``
  71. ``CELERY_AMQP_EXCHANGE`` ``CELERY_DEFAULT_EXCHANGE``
  72. ``CELERY_AMQP_EXCHANGE_TYPE`` ``CELERY_DEFAULT_AMQP_EXCHANGE_TYPE``
  73. ``CELERY_AMQP_CONSUMER_ROUTING_KEY`` ``CELERY_QUEUES``
  74. ``CELERY_AMQP_PUBLISHER_ROUTING_KEY`` ``CELERY_DEFAULT_ROUTING_KEY``
  75. ===================================== =====================================
  76. .. _`deprecation timeline`:
  77. http://ask.github.com/celery/internals/deprecation.html
  78. * The ``celery.task.rest`` module has been removed, use ``celery.task.http``
  79. instead (as scheduled by the `deprecation timeline`_).
  80. * It's no longer allowed to skip the class name in loader names.
  81. (as scheduled by the `deprecation timeline`_):
  82. Assuming the implicit ``Loader`` class name is no longer supported,
  83. if you use e.g.::
  84. CELERY_LOADER = "myapp.loaders"
  85. You need to include the loader class name, like this::
  86. CELERY_LOADER = "myapp.loaders.Loader"
  87. 1.0.3 [2010-05-15 03:00 P.M CEST]
  88. =================================
  89. Important notes
  90. ---------------
  91. * Messages are now acked *just before* the task function is executed.
  92. This is the behavior we've wanted all along, but couldn't have because of
  93. limitations in the multiprocessing module.
  94. The previous behavior was not good, and the situation worsened with the
  95. release of 1.0.1, so this change will definitely improve
  96. reliability, performance and operations in general.
  97. For more information please see http://bit.ly/9hom6T
  98. * Database result backend: result now explicitly sets ``null=True`` as
  99. ``django-picklefield`` version 0.1.5 changed the default behavior
  100. right under our noses :(
  101. See: http://bit.ly/d5OwMr
  102. This means those who created their celery tables (via syncdb or
  103. celeryinit) with picklefield versions >= 0.1.5 has to alter their tables to
  104. allow the result field to be ``NULL`` manually.
  105. MySQL::
  106. ALTER TABLE celery_taskmeta MODIFY result TEXT NULL
  107. * Removed ``Task.rate_limit_queue_type``, as it was not really useful
  108. and made it harder to refactor some parts.
  109. * Now depends on carrot >= 0.10.4
  110. * Now depends on billiard >= 0.3.0
  111. News
  112. ----
  113. * AMQP backend: Added timeout support for ``result.get()`` /
  114. ``result.wait()``.
  115. * New task option: ``Task.acks_late`` (default: ``CELERY_ACKS_LATE``)
  116. Late ack means the task messages will be acknowledged **after** the task
  117. has been executed, not *just before*, which is the default behavior.
  118. Note that this means the tasks may be executed twice if the worker
  119. crashes in the middle of their execution. Not acceptable for most
  120. applications, but desirable for others.
  121. * Added crontab-like scheduling to periodic tasks.
  122. Like a cron job, you can specify units of time of when
  123. you would like the task to execute. While not a full implementation
  124. of cron's features, it should provide a fair degree of common scheduling
  125. needs.
  126. You can specify a minute (0-59), an hour (0-23), and/or a day of the
  127. week (0-6 where 0 is Sunday, or by names: sun, mon, tue, wed, thu, fri,
  128. sat).
  129. Examples:
  130. .. code-block:: python
  131. from celery.task.schedules import crontab
  132. from celery.decorators import periodic_task
  133. @periodic_task(run_every=crontab(hour=7, minute=30))
  134. def every_morning():
  135. print("Runs every morning at 7:30a.m")
  136. @periodic_task(run_every=crontab(hour=7, minute=30, day_of_week="mon"))
  137. def every_monday_morning():
  138. print("Run every monday morning at 7:30a.m")
  139. @periodic_task(run_every=crontab(minutes=30))
  140. def every_hour():
  141. print("Runs every hour on the clock. e.g. 1:30, 2:30, 3:30 etc.")
  142. Note that this a late addition. While we have unittests, due to the
  143. nature of this feature we haven't been able to completely test this
  144. in practice, so consider this experimental.
  145. * ``TaskPool.apply_async``: Now supports the ``accept_callback`` argument.
  146. * ``apply_async``: Now raises :exc:`ValueError` if task args is not a list,
  147. or kwargs is not a tuple (http://github.com/ask/celery/issues/issue/95).
  148. * ``Task.max_retries`` can now be ``None``, which means it will retry forever.
  149. * Celerybeat: Now reuses the same connection when publishing large
  150. sets of tasks.
  151. * Modified the task locking example in the documentation to use
  152. ``cache.add`` for atomic locking.
  153. * Added experimental support for a *started* status on tasks.
  154. If ``Task.track_started`` is enabled the task will report its status
  155. as "started" when the task is executed by a worker.
  156. The default value is ``False`` as the normal behaviour is to not
  157. report that level of granularity. Tasks are either pending, finished,
  158. or waiting to be retried. Having a "started" status can be useful for
  159. when there are long running tasks and there is a need to report which
  160. task is currently running.
  161. The global default can be overridden by the ``CELERY_TRACK_STARTED``
  162. setting.
  163. * User Guide: New section ``Tips and Best Practices``.
  164. Contributions welcome!
  165. Remote control commands
  166. -----------------------
  167. * Remote control commands can now send replies back to the caller.
  168. Existing commands has been improved to send replies, and the client
  169. interface in ``celery.task.control`` has new keyword arguments: ``reply``,
  170. ``timeout`` and ``limit``. Where reply means it will wait for replies,
  171. timeout is the time in seconds to stop waiting for replies, and limit
  172. is the maximum number of replies to get.
  173. By default, it will wait for as many replies as possible for one second.
  174. * rate_limit(task_name, destination=all, reply=False, timeout=1, limit=0)
  175. Worker returns ``{"ok": message}`` on success,
  176. or ``{"failure": message}`` on failure.
  177. >>> from celery.task.control import rate_limit
  178. >>> rate_limit("tasks.add", "10/s", reply=True)
  179. [{'worker1': {'ok': 'new rate limit set successfully'}},
  180. {'worker2': {'ok': 'new rate limit set successfully'}}]
  181. * ping(destination=all, reply=False, timeout=1, limit=0)
  182. Worker returns the simple message ``"pong"``.
  183. >>> from celery.task.control import ping
  184. >>> ping(reply=True)
  185. [{'worker1': 'pong'},
  186. {'worker2': 'pong'},
  187. * revoke(destination=all, reply=False, timeout=1, limit=0)
  188. Worker simply returns ``True``.
  189. >>> from celery.task.control import revoke
  190. >>> revoke("419e46eb-cf6a-4271-86a8-442b7124132c", reply=True)
  191. [{'worker1': True},
  192. {'worker2'; True}]
  193. * You can now add your own remote control commands!
  194. Remote control commands are functions registered in the command
  195. registry. Registering a command is done using
  196. :meth:`celery.worker.control.Panel.register`:
  197. .. code-block:: python
  198. from celery.task.control import Panel
  199. @Panel.register
  200. def reset_broker_connection(panel, **kwargs):
  201. panel.listener.reset_connection()
  202. return {"ok": "connection re-established"}
  203. With this module imported in the worker, you can launch the command
  204. using ``celery.task.control.broadcast``::
  205. >>> from celery.task.control import broadcast
  206. >>> broadcast("reset_broker_connection", reply=True)
  207. [{'worker1': {'ok': 'connection re-established'},
  208. {'worker2': {'ok': 'connection re-established'}}]
  209. **TIP** You can choose the worker(s) to receive the command
  210. by using the ``destination`` argument::
  211. >>> broadcast("reset_broker_connection", destination=["worker1"])
  212. [{'worker1': {'ok': 'connection re-established'}]
  213. * New remote control command: ``dump_reserved``
  214. Dumps tasks reserved by the worker, waiting to be executed::
  215. >>> from celery.task.control import broadcast
  216. >>> broadcast("dump_reserved", reply=True)
  217. [{'myworker1': [<TaskWrapper ....>]}]
  218. * New remote control command: ``dump_schedule``
  219. Dumps the workers currently registered ETA schedule.
  220. These are tasks with an ``eta`` (or ``countdown``) argument
  221. waiting to be executed by the worker.
  222. >>> from celery.task.control import broadcast
  223. >>> broadcast("dump_schedule", reply=True)
  224. [{'w1': []},
  225. {'w3': []},
  226. {'w2': ['0. 2010-05-12 11:06:00 pri0 <TaskWrapper:
  227. {name:"opalfeeds.tasks.refresh_feed_slice",
  228. id:"95b45760-4e73-4ce8-8eac-f100aa80273a",
  229. args:"(<Feeds freq_max:3600 freq_min:60
  230. start:2184.0 stop:3276.0>,)",
  231. kwargs:"{'page': 2}"}>']},
  232. {'w4': ['0. 2010-05-12 11:00:00 pri0 <TaskWrapper:
  233. {name:"opalfeeds.tasks.refresh_feed_slice",
  234. id:"c053480b-58fb-422f-ae68-8d30a464edfe",
  235. args:"(<Feeds freq_max:3600 freq_min:60
  236. start:1092.0 stop:2184.0>,)",
  237. kwargs:"{\'page\': 1}"}>',
  238. '1. 2010-05-12 11:12:00 pri0 <TaskWrapper:
  239. {name:"opalfeeds.tasks.refresh_feed_slice",
  240. id:"ab8bc59e-6cf8-44b8-88d0-f1af57789758",
  241. args:"(<Feeds freq_max:3600 freq_min:60
  242. start:3276.0 stop:4365>,)",
  243. kwargs:"{\'page\': 3}"}>']}]
  244. Fixes
  245. -----
  246. * Mediator thread no longer blocks for more than 1 second.
  247. With rate limits enabled and when there was a lot of remaining time,
  248. the mediator thread could block shutdown (and potentially block other
  249. jobs from coming in).
  250. * Remote rate limits was not properly applied
  251. (http://github.com/ask/celery/issues/issue/98)
  252. * Now handles exceptions with unicode messages correctly in
  253. ``TaskWrapper.on_failure``.
  254. * Database backend: ``TaskMeta.result``: default value should be ``None``
  255. not empty string.
  256. 1.0.2 [2010-03-31 12:50 P.M CET]
  257. ================================
  258. * Deprecated: ``CELERY_BACKEND``, please use ``CELERY_RESULT_BACKEND``
  259. instead.
  260. * We now use a custom logger in tasks. This logger supports task magic
  261. keyword arguments in formats.
  262. The default format for tasks (``CELERYD_TASK_LOG_FORMAT``) now includes
  263. the id and the name of tasks so the origin of task log messages can
  264. easily be traced.
  265. Example output::
  266. [2010-03-25 13:11:20,317: INFO/PoolWorker-1]
  267. [tasks.add(a6e1c5ad-60d9-42a0-8b24-9e39363125a4)] Hello from add
  268. To revert to the previous behavior you can set::
  269. CELERYD_TASK_LOG_FORMAT = """
  270. [%(asctime)s: %(levelname)s/%(processName)s] %(message)s
  271. """.strip()
  272. * Unittests: Don't disable the django test database teardown,
  273. instead fixed the underlying issue which was caused by modifications
  274. to the ``DATABASE_NAME`` setting (http://github.com/ask/celery/issues/82).
  275. * Django Loader: New config ``CELERY_DB_REUSE_MAX`` (max number of tasks
  276. to reuse the same database connection)
  277. The default is to use a new connection for every task.
  278. We would very much like to reuse the connection, but a safe number of
  279. reuses is not known, and we don't have any way to handle the errors
  280. that might happen, which may even be database dependent.
  281. See: http://bit.ly/94fwdd
  282. * celeryd: The worker components are now configurable: ``CELERYD_POOL``,
  283. ``CELERYD_LISTENER``, ``CELERYD_MEDIATOR``, and ``CELERYD_ETA_SCHEDULER``.
  284. The default configuration is as follows:
  285. .. code-block:: python
  286. CELERYD_POOL = "celery.worker.pool.TaskPool"
  287. CELERYD_MEDIATOR = "celery.worker.controllers.Mediator"
  288. CELERYD_ETA_SCHEDULER = "celery.worker.controllers.ScheduleController"
  289. CELERYD_LISTENER = "celery.worker.listener.CarrotListener"
  290. The ``CELERYD_POOL`` setting makes it easy to swap out the multiprocessing
  291. pool with a threaded pool, or how about a twisted/eventlet pool?
  292. Consider the competition for the first pool plug-in started!
  293. * Debian init scripts: Use ``-a`` not ``&&``
  294. (http://github.com/ask/celery/issues/82).
  295. * Debian init scripts: Now always preserves ``$CELERYD_OPTS`` from the
  296. ``/etc/default/celeryd`` and ``/etc/default/celerybeat``.
  297. * celery.beat.Scheduler: Fixed a bug where the schedule was not properly
  298. flushed to disk if the schedule had not been properly initialized.
  299. * celerybeat: Now syncs the schedule to disk when receiving the ``SIGTERM``
  300. and ``SIGINT`` signals.
  301. * Control commands: Make sure keywords arguments are not in unicode.
  302. * ETA scheduler: Was missing a logger object, so the scheduler crashed
  303. when trying to log that a task had been revoked.
  304. * management.commands.camqadm: Fixed typo ``camqpadm`` -> ``camqadm``
  305. (http://github.com/ask/celery/issues/83).
  306. * PeriodicTask.delta_resolution: Was not working for days and hours, now fixed
  307. by rounding to the nearest day/hour.
  308. * Fixed a potential infinite loop in ``BaseAsyncResult.__eq__``, although
  309. there is no evidence that it has ever been triggered.
  310. * celeryd: Now handles messages with encoding problems by acking them and
  311. emitting an error message.
  312. 1.0.1 [2010-02-24 07:05 P.M CET]
  313. ================================
  314. * Tasks are now acknowledged early instead of late.
  315. This is done because messages can only be acked within the same
  316. connection channel, so if the connection is lost we would have to refetch
  317. the message again to acknowledge it.
  318. This might or might not affect you, but mostly those running tasks with a
  319. really long execution time are affected, as all tasks that has made it
  320. all the way into the pool needs to be executed before the worker can
  321. safely terminate (this is at most the number of pool workers, multiplied
  322. by the ``CELERYD_PREFETCH_MULTIPLIER`` setting.)
  323. We multiply the prefetch count by default to increase the performance at
  324. times with bursts of tasks with a short execution time. If this doesn't
  325. apply to your use case, you should be able to set the prefetch multiplier
  326. to zero, without sacrificing performance.
  327. Please note that a patch to :mod:`multiprocessing` is currently being
  328. worked on, this patch would enable us to use a better solution, and is
  329. scheduled for inclusion in the ``1.2.0`` release.
  330. * celeryd now shutdowns cleanly when receving the ``TERM`` signal.
  331. * celeryd now does a cold shutdown if the ``INT`` signal is received (Ctrl+C),
  332. this means it tries to terminate as soon as possible.
  333. * Caching of results now moved to the base backend classes, so no need
  334. to implement this functionality in the base classes.
  335. * Caches are now also limited in size, so their memory usage doesn't grow
  336. out of control.
  337. You can set the maximum number of results the cache
  338. can hold using the ``CELERY_MAX_CACHED_RESULTS`` setting (the default
  339. is five thousand results). In addition, you can refetch already retrieved
  340. results using ``backend.reload_task_result`` +
  341. ``backend.reload_taskset_result`` (that's for those who want to send
  342. results incrementally).
  343. * ``celeryd`` now works on Windows again.
  344. Note that if running with Django,
  345. you can't use ``project.settings`` as the settings module name, but the
  346. following should work::
  347. $ python manage.py celeryd --settings=settings
  348. * Execution: ``.messaging.TaskPublisher.send_task`` now
  349. incorporates all the functionality apply_async previously did.
  350. Like converting countdowns to eta, so :func:`celery.execute.apply_async` is
  351. now simply a convenient front-end to
  352. :meth:`celery.messaging.TaskPublisher.send_task`, using
  353. the task classes default options.
  354. Also :func:`celery.execute.send_task` has been
  355. introduced, which can apply tasks using just the task name (useful
  356. if the client does not have the destination task in its task registry).
  357. Example:
  358. >>> from celery.execute import send_task
  359. >>> result = send_task("celery.ping", args=[], kwargs={})
  360. >>> result.get()
  361. 'pong'
  362. * ``camqadm``: This is a new utility for command line access to the AMQP API.
  363. Excellent for deleting queues/bindings/exchanges, experimentation and
  364. testing::
  365. $ camqadm
  366. 1> help
  367. Gives an interactive shell, type ``help`` for a list of commands.
  368. When using Django, use the management command instead::
  369. $ python manage.py camqadm
  370. 1> help
  371. * Redis result backend: To conform to recent Redis API changes, the following
  372. settings has been deprecated:
  373. * ``REDIS_TIMEOUT``
  374. * ``REDIS_CONNECT_RETRY``
  375. These will emit a ``DeprecationWarning`` if used.
  376. A ``REDIS_PASSWORD`` setting has been added, so you can use the new
  377. simple authentication mechanism in Redis.
  378. * The redis result backend no longer calls ``SAVE`` when disconnecting,
  379. as this is apparently better handled by Redis itself.
  380. * If ``settings.DEBUG`` is on, celeryd now warns about the possible
  381. memory leak it can result in.
  382. * The ETA scheduler now sleeps at most two seconds between iterations.
  383. * The ETA scheduler now deletes any revoked tasks it might encounter.
  384. As revokes are not yet persistent, this is done to make sure the task
  385. is revoked even though it's currently being hold because its eta is e.g.
  386. a week into the future.
  387. * The ``task_id`` argument is now respected even if the task is executed
  388. eagerly (either using apply, or ``CELERY_ALWAYS_EAGER``).
  389. * The internal queues are now cleared if the connection is reset.
  390. * New magic keyword argument: ``delivery_info``.
  391. Used by retry() to resend the task to its original destination using the same
  392. exchange/routing_key.
  393. * Events: Fields was not passed by ``.send()`` (fixes the uuid keyerrors
  394. in celerymon)
  395. * Added ``--schedule``/``-s`` option to celeryd, so it is possible to
  396. specify a custom schedule filename when using an embedded celerybeat
  397. server (the ``-B``/``--beat``) option.
  398. * Better Python 2.4 compatibility. The test suite now passes.
  399. * task decorators: Now preserve docstring as ``cls.__doc__``, (was previously
  400. copied to ``cls.run.__doc__``)
  401. * The ``testproj`` directory has been renamed to ``tests`` and we're now using
  402. ``nose`` + ``django-nose`` for test discovery, and ``unittest2`` for test
  403. cases.
  404. * New pip requirements files available in ``contrib/requirements``.
  405. * TaskPublisher: Declarations are now done once (per process).
  406. * Added ``Task.delivery_mode`` and the ``CELERY_DEFAULT_DELIVERY_MODE``
  407. setting.
  408. These can be used to mark messages non-persistent (i.e. so they are
  409. lost if the broker is restarted).
  410. * Now have our own ``ImproperlyConfigured`` exception, instead of using the
  411. Django one.
  412. * Improvements to the debian init scripts: Shows an error if the program is
  413. not executeable. Does not modify ``CELERYD`` when using django with
  414. virtualenv.
  415. 1.0.0 [2010-02-10 04:00 P.M CET]
  416. ================================
  417. BACKWARD INCOMPATIBLE CHANGES
  418. -----------------------------
  419. * Celery does not support detaching anymore, so you have to use the tools
  420. available on your platform, or something like supervisord to make
  421. celeryd/celerybeat/celerymon into background processes.
  422. We've had too many problems with celeryd daemonizing itself, so it was
  423. decided it has to be removed. Example startup scripts has been added to
  424. ``contrib/``:
  425. * Debian, Ubuntu, (start-stop-daemon)
  426. ``contrib/debian/init.d/celeryd``
  427. ``contrib/debian/init.d/celerybeat``
  428. * Mac OS X launchd
  429. ``contrib/mac/org.celeryq.celeryd.plist``
  430. ``contrib/mac/org.celeryq.celerybeat.plist``
  431. ``contrib/mac/org.celeryq.celerymon.plist``
  432. * Supervisord (http://supervisord.org)
  433. ``contrib/supervisord/supervisord.conf``
  434. In addition to ``--detach``, the following program arguments has been
  435. removed: ``--uid``, ``--gid``, ``--workdir``, ``--chroot``, ``--pidfile``,
  436. ``--umask``. All good daemonization tools should support equivalent
  437. functionality, so don't worry.
  438. Also the following configuration keys has been removed:
  439. ``CELERYD_PID_FILE``, ``CELERYBEAT_PID_FILE``, ``CELERYMON_PID_FILE``.
  440. * Default celeryd loglevel is now ``WARN``, to enable the previous log level
  441. start celeryd with ``--loglevel=INFO``.
  442. * Tasks are automatically registered.
  443. This means you no longer have to register your tasks manually.
  444. You don't have to change your old code right away, as it doesn't matter if
  445. a task is registered twice.
  446. If you don't want your task to be automatically registered you can set
  447. the ``abstract`` attribute
  448. .. code-block:: python
  449. class MyTask(Task):
  450. abstract = True
  451. By using ``abstract`` only tasks subclassing this task will be automatically
  452. registered (this works like the Django ORM).
  453. If you don't want subclasses to be registered either, you can set the
  454. ``autoregister`` attribute to ``False``.
  455. Incidentally, this change also fixes the problems with automatic name
  456. assignment and relative imports. So you also don't have to specify a task name
  457. anymore if you use relative imports.
  458. * You can no longer use regular functions as tasks.
  459. This change was added
  460. because it makes the internals a lot more clean and simple. However, you can
  461. now turn functions into tasks by using the ``@task`` decorator:
  462. .. code-block:: python
  463. from celery.decorators import task
  464. @task
  465. def add(x, y):
  466. return x + y
  467. See the User Guide: :doc:`userguide/tasks` for more information.
  468. * The periodic task system has been rewritten to a centralized solution.
  469. This means ``celeryd`` no longer schedules periodic tasks by default,
  470. but a new daemon has been introduced: ``celerybeat``.
  471. To launch the periodic task scheduler you have to run celerybeat::
  472. $ celerybeat
  473. Make sure this is running on one server only, if you run it twice, all
  474. periodic tasks will also be executed twice.
  475. If you only have one worker server you can embed it into celeryd like this::
  476. $ celeryd --beat # Embed celerybeat in celeryd.
  477. * The supervisor has been removed.
  478. This means the ``-S`` and ``--supervised`` options to ``celeryd`` is
  479. no longer supported. Please use something like http://supervisord.org
  480. instead.
  481. * ``TaskSet.join`` has been removed, use ``TaskSetResult.join`` instead.
  482. * The task status ``"DONE"`` has been renamed to `"SUCCESS"`.
  483. * ``AsyncResult.is_done`` has been removed, use ``AsyncResult.successful``
  484. instead.
  485. * The worker no longer stores errors if ``Task.ignore_result`` is set, to
  486. revert to the previous behaviour set
  487. ``CELERY_STORE_ERRORS_EVEN_IF_IGNORED`` to ``True``.
  488. * The staticstics functionality has been removed in favor of events,
  489. so the ``-S`` and ``--statistics`` switches has been removed.
  490. * The module ``celery.task.strategy`` has been removed.
  491. * ``celery.discovery`` has been removed, and it's ``autodiscover`` function is
  492. now in ``celery.loaders.djangoapp``. Reason: Internal API.
  493. * ``CELERY_LOADER`` now needs loader class name in addition to module name,
  494. E.g. where you previously had: ``"celery.loaders.default"``, you now need
  495. ``"celery.loaders.default.Loader"``, using the previous syntax will result
  496. in a DeprecationWarning.
  497. * Detecting the loader is now lazy, and so is not done when importing
  498. ``celery.loaders``.
  499. To make this happen ``celery.loaders.settings`` has
  500. been renamed to ``load_settings`` and is now a function returning the
  501. settings object. ``celery.loaders.current_loader`` is now also
  502. a function, returning the current loader.
  503. So::
  504. loader = current_loader
  505. needs to be changed to::
  506. loader = current_loader()
  507. DEPRECATIONS
  508. ------------
  509. * The following configuration variables has been renamed and will be
  510. deprecated in v1.2:
  511. * CELERYD_DAEMON_LOG_FORMAT -> CELERYD_LOG_FORMAT
  512. * CELERYD_DAEMON_LOG_LEVEL -> CELERYD_LOG_LEVEL
  513. * CELERY_AMQP_CONNECTION_TIMEOUT -> CELERY_BROKER_CONNECTION_TIMEOUT
  514. * CELERY_AMQP_CONNECTION_RETRY -> CELERY_BROKER_CONNECTION_RETRY
  515. * CELERY_AMQP_CONNECTION_MAX_RETRIES -> CELERY_BROKER_CONNECTION_MAX_RETRIES
  516. * SEND_CELERY_TASK_ERROR_EMAILS -> CELERY_SEND_TASK_ERROR_EMAILS
  517. * The public api names in celery.conf has also changed to a consistent naming
  518. scheme.
  519. * We now support consuming from an arbitrary number of queues.
  520. To do this we had to rename the configuration syntax. If you use any of
  521. the custom AMQP routing options (queue/exchange/routing_key, etc), you
  522. should read the new FAQ entry: http://bit.ly/aiWoH.
  523. The previous syntax is deprecated and scheduled for removal in v1.2.
  524. * ``TaskSet.run`` has been renamed to ``TaskSet.apply_async``.
  525. ``TaskSet.run`` has now been deprecated, and is scheduled for
  526. removal in v1.2.
  527. NEWS
  528. ----
  529. * Rate limiting support (per task type, or globally).
  530. * New periodic task system.
  531. * Automatic registration.
  532. * New cool task decorator syntax.
  533. * celeryd now sends events if enabled with the ``-E`` argument.
  534. Excellent for monitoring tools, one is already in the making
  535. (http://github.com/ask/celerymon).
  536. Current events include: worker-heartbeat,
  537. task-[received/succeeded/failed/retried],
  538. worker-online, worker-offline.
  539. * You can now delete (revoke) tasks that has already been applied.
  540. * You can now set the hostname celeryd identifies as using the ``--hostname``
  541. argument.
  542. * Cache backend now respects ``CELERY_TASK_RESULT_EXPIRES``.
  543. * Message format has been standardized and now uses ISO-8601 format
  544. for dates instead of datetime.
  545. * ``celeryd`` now responds to the ``HUP`` signal by restarting itself.
  546. * Periodic tasks are now scheduled on the clock.
  547. I.e. ``timedelta(hours=1)`` means every hour at :00 minutes, not every
  548. hour from the server starts. To revert to the previous behaviour you
  549. can set ``PeriodicTask.relative = True``.
  550. * Now supports passing execute options to a TaskSets list of args, e.g.:
  551. >>> ts = TaskSet(add, [([2, 2], {}, {"countdown": 1}),
  552. ... ([4, 4], {}, {"countdown": 2}),
  553. ... ([8, 8], {}, {"countdown": 3})])
  554. >>> ts.run()
  555. * Got a 3x performance gain by setting the prefetch count to four times the
  556. concurrency, (from an average task round-trip of 0.1s to 0.03s!).
  557. A new setting has been added: ``CELERYD_PREFETCH_MULTIPLIER``, which
  558. is set to ``4`` by default.
  559. * Improved support for webhook tasks.
  560. ``celery.task.rest`` is now deprecated, replaced with the new and shiny
  561. :mod:`celery.task.http`. With more reflective names, sensible interface,
  562. and it's possible to override the methods used to perform HTTP requests.
  563. * The results of tasksets are now cached by storing it in the result
  564. backend.
  565. CHANGES
  566. -------
  567. * Now depends on carrot >= 0.8.1
  568. * New dependencies: billiard, python-dateutil, django-picklefield
  569. * No longer depends on python-daemon
  570. * The ``uuid`` distribution is added as a dependency when running Python 2.4.
  571. * Now remembers the previously detected loader by keeping it in
  572. the ``CELERY_LOADER`` environment variable.
  573. This may help on windows where fork emulation is used.
  574. * ETA no longer sends datetime objects, but uses ISO 8601 date format in a
  575. string for better compatibility with other platforms.
  576. * No longer sends error mails for retried tasks.
  577. * Task can now override the backend used to store results.
  578. * Refactored the ExecuteWrapper, ``apply`` and ``CELERY_ALWAYS_EAGER`` now
  579. also executes the task callbacks and signals.
  580. * Now using a proper scheduler for the tasks with an ETA.
  581. This means waiting eta tasks are sorted by time, so we don't have
  582. to poll the whole list all the time.
  583. * Now also imports modules listed in CELERY_IMPORTS when running
  584. with django (as documented).
  585. * Loglevel for stdout/stderr changed from INFO to ERROR
  586. * ImportErrors are now properly propogated when autodiscovering tasks.
  587. * You can now use ``celery.messaging.establish_connection`` to establish a
  588. connection to the broker.
  589. * When running as a separate service the periodic task scheduler does some
  590. smart moves to not poll too regularly.
  591. If you need faster poll times you can lower the value
  592. of ``CELERYBEAT_MAX_LOOP_INTERVAL``.
  593. * You can now change periodic task intervals at runtime, by making
  594. ``run_every`` a property, or subclassing ``PeriodicTask.is_due``.
  595. * The worker now supports control commands enabled through the use of a
  596. broadcast queue, you can remotely revoke tasks or set the rate limit for
  597. a task type. See :mod:`celery.task.control`.
  598. * The services now sets informative process names (as shown in ``ps``
  599. listings) if the :mod:`setproctitle` module is installed.
  600. * :exc:`celery.exceptions.NotRegistered` now inherits from :exc:`KeyError`,
  601. and ``TaskRegistry.__getitem__``+``pop`` raises ``NotRegistered`` instead
  602. * You can set the loader via the ``CELERY_LOADER`` environment variable.
  603. * You can now set ``CELERY_IGNORE_RESULT`` to ignore task results by default
  604. (if enabled, tasks doesn't save results or errors to the backend used).
  605. * celeryd now correctly handles malformed messages by throwing away and
  606. acknowledging the message, instead of crashing.
  607. BUGS
  608. ----
  609. * Fixed a race condition that could happen while storing task results in the
  610. database.
  611. DOCUMENTATION
  612. -------------
  613. * Reference now split into two sections; API reference and internal module
  614. reference.
  615. 0.8.4 [2010-02-05 01:52 P.M CEST]
  616. ---------------------------------
  617. * Now emits a warning if the --detach argument is used.
  618. --detach should not be used anymore, as it has several not easily fixed
  619. bugs related to it. Instead, use something like start-stop-daemon,
  620. supervisord or launchd (os x).
  621. * Make sure logger class is process aware, even if running Python >= 2.6.
  622. * Error e-mails are not sent anymore when the task is retried.
  623. 0.8.3 [2009-12-22 09:43 A.M CEST]
  624. ---------------------------------
  625. * Fixed a possible race condition that could happen when storing/querying
  626. task results using the the database backend.
  627. * Now has console script entry points in the setup.py file, so tools like
  628. buildout will correctly install the programs celerybin and celeryinit.
  629. 0.8.2 [2009-11-20 03:40 P.M CEST]
  630. ---------------------------------
  631. * QOS Prefetch count was not applied properly, as it was set for every message
  632. received (which apparently behaves like, "receive one more"), instead of only
  633. set when our wanted value cahnged.
  634. 0.8.1 [2009-11-16 05:21 P.M CEST]
  635. =================================
  636. VERY IMPORTANT NOTE
  637. -------------------
  638. This release (with carrot 0.8.0) enables AMQP QoS (quality of service), which
  639. means the workers will only receive as many messages as it can handle at a
  640. time. As with any release, you should test this version upgrade on your
  641. development servers before rolling it out to production!
  642. IMPORTANT CHANGES
  643. -----------------
  644. * If you're using Python < 2.6 and you use the multiprocessing backport, then
  645. multiprocessing version 2.6.2.1 is required.
  646. * All AMQP_* settings has been renamed to BROKER_*, and in addition
  647. AMQP_SERVER has been renamed to BROKER_HOST, so before where you had::
  648. AMQP_SERVER = "localhost"
  649. AMQP_PORT = 5678
  650. AMQP_USER = "myuser"
  651. AMQP_PASSWORD = "mypassword"
  652. AMQP_VHOST = "celery"
  653. You need to change that to::
  654. BROKER_HOST = "localhost"
  655. BROKER_PORT = 5678
  656. BROKER_USER = "myuser"
  657. BROKER_PASSWORD = "mypassword"
  658. BROKER_VHOST = "celery"
  659. * Custom carrot backends now need to include the backend class name, so before
  660. where you had::
  661. CARROT_BACKEND = "mycustom.backend.module"
  662. you need to change it to::
  663. CARROT_BACKEND = "mycustom.backend.module.Backend"
  664. where ``Backend`` is the class name. This is probably ``"Backend"``, as
  665. that was the previously implied name.
  666. * New version requirement for carrot: 0.8.0
  667. CHANGES
  668. -------
  669. * Incorporated the multiprocessing backport patch that fixes the
  670. ``processName`` error.
  671. * Ignore the result of PeriodicTask's by default.
  672. * Added a Redis result store backend
  673. * Allow /etc/default/celeryd to define additional options for the celeryd init
  674. script.
  675. * MongoDB periodic tasks issue when using different time than UTC fixed.
  676. * Windows specific: Negate test for available os.fork (thanks miracle2k)
  677. * Now tried to handle broken PID files.
  678. * Added a Django test runner to contrib that sets CELERY_ALWAYS_EAGER = True for testing with the database backend
  679. * Added a CELERY_CACHE_BACKEND setting for using something other than the django-global cache backend.
  680. * Use custom implementation of functools.partial (curry) for Python 2.4 support
  681. (Probably still problems with running on 2.4, but it will eventually be
  682. supported)
  683. * Prepare exception to pickle when saving RETRY status for all backends.
  684. * SQLite no concurrency limit should only be effective if the db backend is used.
  685. 0.8.0 [2009-09-22 03:06 P.M CEST]
  686. =================================
  687. BACKWARD INCOMPATIBLE CHANGES
  688. -----------------------------
  689. * Add traceback to result value on failure.
  690. **NOTE** If you use the database backend you have to re-create the
  691. database table ``celery_taskmeta``.
  692. Contact the mailinglist or IRC channel listed in README for help
  693. doing this.
  694. * Database tables are now only created if the database backend is used,
  695. so if you change back to the database backend at some point,
  696. be sure to initialize tables (django: ``syncdb``, python: ``celeryinit``).
  697. (Note: This is only the case when using Django 1.1 or higher)
  698. * Now depends on ``carrot`` version 0.6.0.
  699. * Now depends on python-daemon 1.4.8
  700. IMPORTANT CHANGES
  701. -----------------
  702. * Celery can now be used in pure Python (outside of a Django project).
  703. This means celery is no longer Django specific.
  704. For more information see the FAQ entry
  705. `Can I use celery without Django?`_.
  706. .. _`Can I use celery without Django?`:
  707. http://ask.github.com/celery/faq.html#can-i-use-celery-without-django
  708. * Celery now supports task retries.
  709. See `Cookbook: Retrying Tasks`_ for more information.
  710. .. _`Cookbook: Retrying Tasks`:
  711. http://ask.github.com/celery/cookbook/task-retries.html
  712. * We now have an AMQP result store backend.
  713. It uses messages to publish task return value and status. And it's
  714. incredibly fast!
  715. See http://github.com/ask/celery/issues/closed#issue/6 for more info!
  716. * AMQP QoS (prefetch count) implemented:
  717. This to not receive more messages than we can handle.
  718. * Now redirects stdout/stderr to the celeryd logfile when detached
  719. * Now uses ``inspect.getargspec`` to only pass default arguments
  720. the task supports.
  721. * Add Task.on_success, .on_retry, .on_failure handlers
  722. See :meth:`celery.task.base.Task.on_success`,
  723. :meth:`celery.task.base.Task.on_retry`,
  724. :meth:`celery.task.base.Task.on_failure`,
  725. * ``celery.utils.gen_unique_id``: Workaround for
  726. http://bugs.python.org/issue4607
  727. * You can now customize what happens at worker start, at process init, etc
  728. by creating your own loaders. (see :mod:`celery.loaders.default`,
  729. :mod:`celery.loaders.djangoapp`, :mod:`celery.loaders`.)
  730. * Support for multiple AMQP exchanges and queues.
  731. This feature misses documentation and tests, so anyone interested
  732. is encouraged to improve this situation.
  733. * celeryd now survives a restart of the AMQP server!
  734. Automatically re-establish AMQP broker connection if it's lost.
  735. New settings:
  736. * AMQP_CONNECTION_RETRY
  737. Set to ``True`` to enable connection retries.
  738. * AMQP_CONNECTION_MAX_RETRIES.
  739. Maximum number of restarts before we give up. Default: ``100``.
  740. NEWS
  741. ----
  742. * Fix an incompatibility between python-daemon and multiprocessing,
  743. which resulted in the ``[Errno 10] No child processes`` problem when
  744. detaching.
  745. * Fixed a possible DjangoUnicodeDecodeError being raised when saving pickled
  746. data to Django's memcached cache backend.
  747. * Better Windows compatibility.
  748. * New version of the pickled field (taken from
  749. http://www.djangosnippets.org/snippets/513/)
  750. * New signals introduced: ``task_sent``, ``task_prerun`` and
  751. ``task_postrun``, see :mod:`celery.signals` for more information.
  752. * ``TaskSetResult.join`` caused ``TypeError`` when ``timeout=None``.
  753. Thanks Jerzy Kozera. Closes #31
  754. * ``views.apply`` should return ``HttpResponse`` instance.
  755. Thanks to Jerzy Kozera. Closes #32
  756. * ``PeriodicTask``: Save conversion of ``run_every`` from ``int``
  757. to ``timedelta`` to the class attribute instead of on the instance.
  758. * Exceptions has been moved to ``celery.exceptions``, but are still
  759. available in the previous module.
  760. * Try to rollback transaction and retry saving result if an error happens
  761. while setting task status with the database backend.
  762. * jail() refactored into :class:`celery.execute.ExecuteWrapper`.
  763. * ``views.apply`` now correctly sets mimetype to "application/json"
  764. * ``views.task_status`` now returns exception if status is RETRY
  765. * ``views.task_status`` now returns traceback if status is "FAILURE"
  766. or "RETRY"
  767. * Documented default task arguments.
  768. * Add a sensible __repr__ to ExceptionInfo for easier debugging
  769. * Fix documentation typo ``.. import map`` -> ``.. import dmap``.
  770. Thanks mikedizon
  771. 0.6.0 [2009-08-07 06:54 A.M CET]
  772. ================================
  773. IMPORTANT CHANGES
  774. -----------------
  775. * Fixed a bug where tasks raising unpickleable exceptions crashed pool
  776. workers. So if you've had pool workers mysteriously dissapearing, or
  777. problems with celeryd stopping working, this has been fixed in this
  778. version.
  779. * Fixed a race condition with periodic tasks.
  780. * The task pool is now supervised, so if a pool worker crashes,
  781. goes away or stops responding, it is automatically replaced with
  782. a new one.
  783. * Task.name is now automatically generated out of class module+name, e.g.
  784. ``"djangotwitter.tasks.UpdateStatusesTask"``. Very convenient. No idea why
  785. we didn't do this before. Some documentation is updated to not manually
  786. specify a task name.
  787. NEWS
  788. ----
  789. * Tested with Django 1.1
  790. * New Tutorial: Creating a click counter using carrot and celery
  791. * Database entries for periodic tasks are now created at ``celeryd``
  792. startup instead of for each check (which has been a forgotten TODO/XXX
  793. in the code for a long time)
  794. * New settings variable: ``CELERY_TASK_RESULT_EXPIRES``
  795. Time (in seconds, or a `datetime.timedelta` object) for when after
  796. stored task results are deleted. For the moment this only works for the
  797. database backend.
  798. * ``celeryd`` now emits a debug log message for which periodic tasks
  799. has been launched.
  800. * The periodic task table is now locked for reading while getting
  801. periodic task status. (MySQL only so far, seeking patches for other
  802. engines)
  803. * A lot more debugging information is now available by turning on the
  804. ``DEBUG`` loglevel (``--loglevel=DEBUG``).
  805. * Functions/methods with a timeout argument now works correctly.
  806. * New: ``celery.strategy.even_time_distribution``:
  807. With an iterator yielding task args, kwargs tuples, evenly distribute
  808. the processing of its tasks throughout the time window available.
  809. * Log message ``Unknown task ignored...`` now has loglevel ``ERROR``
  810. * Log message ``"Got task from broker"`` is now emitted for all tasks, even if
  811. the task has an ETA (estimated time of arrival). Also the message now
  812. includes the ETA for the task (if any).
  813. * Acknowledgement now happens in the pool callback. Can't do ack in the job
  814. target, as it's not pickleable (can't share AMQP connection, etc)).
  815. * Added note about .delay hanging in README
  816. * Tests now passing in Django 1.1
  817. * Fixed discovery to make sure app is in INSTALLED_APPS
  818. * Previously overrided pool behaviour (process reap, wait until pool worker
  819. available, etc.) is now handled by ``multiprocessing.Pool`` itself.
  820. * Convert statistics data to unicode for use as kwargs. Thanks Lucy!
  821. 0.4.1 [2009-07-02 01:42 P.M CET]
  822. ================================
  823. * Fixed a bug with parsing the message options (``mandatory``,
  824. ``routing_key``, ``priority``, ``immediate``)
  825. 0.4.0 [2009-07-01 07:29 P.M CET]
  826. ================================
  827. * Adds eager execution. ``celery.execute.apply``|``Task.apply`` executes the
  828. function blocking until the task is done, for API compatiblity it
  829. returns an ``celery.result.EagerResult`` instance. You can configure
  830. celery to always run tasks locally by setting the
  831. ``CELERY_ALWAYS_EAGER`` setting to ``True``.
  832. * Now depends on ``anyjson``.
  833. * 99% coverage using python ``coverage`` 3.0.
  834. 0.3.20 [2009-06-25 08:42 P.M CET]
  835. =================================
  836. * New arguments to ``apply_async`` (the advanced version of
  837. ``delay_task``), ``countdown`` and ``eta``;
  838. >>> # Run 10 seconds into the future.
  839. >>> res = apply_async(MyTask, countdown=10);
  840. >>> # Run 1 day from now
  841. >>> res = apply_async(MyTask, eta=datetime.now() +
  842. ... timedelta(days=1)
  843. * Now unlinks the pidfile if it's stale.
  844. * Lots of more tests.
  845. * Now compatible with carrot >= 0.5.0.
  846. * **IMPORTANT** The ``subtask_ids`` attribute on the ``TaskSetResult``
  847. instance has been removed. To get this information instead use:
  848. >>> subtask_ids = [subtask.task_id for subtask in ts_res.subtasks]
  849. * ``Taskset.run()`` now respects extra message options from the task class.
  850. * Task: Add attribute ``ignore_result``: Don't store the status and
  851. return value. This means you can't use the
  852. ``celery.result.AsyncResult`` to check if the task is
  853. done, or get its return value. Only use if you need the performance
  854. and is able live without these features. Any exceptions raised will
  855. store the return value/status as usual.
  856. * Task: Add attribute ``disable_error_emails`` to disable sending error
  857. emails for that task.
  858. * Should now work on Windows (although running in the background won't
  859. work, so using the ``--detach`` argument results in an exception
  860. being raised.)
  861. * Added support for statistics for profiling and monitoring.
  862. To start sending statistics start ``celeryd`` with the
  863. ``--statistics`` option. Then after a while you can dump the results
  864. by running ``python manage.py celerystats``. See
  865. ``celery.monitoring`` for more information.
  866. * The celery daemon can now be supervised (i.e it is automatically
  867. restarted if it crashes). To use this start celeryd with the
  868. ``--supervised`` option (or alternatively ``-S``).
  869. * views.apply: View applying a task. Example::
  870. http://e.com/celery/apply/task_name/arg1/arg2//?kwarg1=a&kwarg2=b
  871. **NOTE** Use with caution, preferably not make this publicly
  872. accessible without ensuring your code is safe!
  873. * Refactored ``celery.task``. It's now split into three modules:
  874. * celery.task
  875. Contains ``apply_async``, ``delay_task``, ``discard_all``, and task
  876. shortcuts, plus imports objects from ``celery.task.base`` and
  877. ``celery.task.builtins``
  878. * celery.task.base
  879. Contains task base classes: ``Task``, ``PeriodicTask``,
  880. ``TaskSet``, ``AsynchronousMapTask``, ``ExecuteRemoteTask``.
  881. * celery.task.builtins
  882. Built-in tasks: ``PingTask``, ``DeleteExpiredTaskMetaTask``.
  883. 0.3.7 [2008-06-16 11:41 P.M CET]
  884. --------------------------------
  885. * **IMPORTANT** Now uses AMQP's ``basic.consume`` instead of
  886. ``basic.get``. This means we're no longer polling the broker for
  887. new messages.
  888. * **IMPORTANT** Default concurrency limit is now set to the number of CPUs
  889. available on the system.
  890. * **IMPORTANT** ``tasks.register``: Renamed ``task_name`` argument to
  891. ``name``, so
  892. >>> tasks.register(func, task_name="mytask")
  893. has to be replaced with:
  894. >>> tasks.register(func, name="mytask")
  895. * The daemon now correctly runs if the pidlock is stale.
  896. * Now compatible with carrot 0.4.5
  897. * Default AMQP connnection timeout is now 4 seconds.
  898. * ``AsyncResult.read()`` was always returning ``True``.
  899. * Only use README as long_description if the file exists so easy_install
  900. doesn't break.
  901. * ``celery.view``: JSON responses now properly set its mime-type.
  902. * ``apply_async`` now has a ``connection`` keyword argument so you
  903. can re-use the same AMQP connection if you want to execute
  904. more than one task.
  905. * Handle failures in task_status view such that it won't throw 500s.
  906. * Fixed typo ``AMQP_SERVER`` in documentation to ``AMQP_HOST``.
  907. * Worker exception e-mails sent to admins now works properly.
  908. * No longer depends on ``django``, so installing ``celery`` won't affect
  909. the preferred Django version installed.
  910. * Now works with PostgreSQL (psycopg2) again by registering the
  911. ``PickledObject`` field.
  912. * ``celeryd``: Added ``--detach`` option as an alias to ``--daemon``, and
  913. it's the term used in the documentation from now on.
  914. * Make sure the pool and periodic task worker thread is terminated
  915. properly at exit. (So ``Ctrl-C`` works again).
  916. * Now depends on ``python-daemon``.
  917. * Removed dependency to ``simplejson``
  918. * Cache Backend: Re-establishes connection for every task process
  919. if the Django cache backend is memcached/libmemcached.
  920. * Tyrant Backend: Now re-establishes the connection for every task
  921. executed.
  922. 0.3.3 [2009-06-08 01:07 P.M CET]
  923. ================================
  924. * The ``PeriodicWorkController`` now sleeps for 1 second between checking
  925. for periodic tasks to execute.
  926. 0.3.2 [2009-06-08 01:07 P.M CET]
  927. ================================
  928. * celeryd: Added option ``--discard``: Discard (delete!) all waiting
  929. messages in the queue.
  930. * celeryd: The ``--wakeup-after`` option was not handled as a float.
  931. 0.3.1 [2009-06-08 01:07 P.M CET]
  932. ================================
  933. * The `PeriodicTask`` worker is now running in its own thread instead
  934. of blocking the ``TaskController`` loop.
  935. * Default ``QUEUE_WAKEUP_AFTER`` has been lowered to ``0.1`` (was ``0.3``)
  936. 0.3.0 [2009-06-08 12:41 P.M CET]
  937. ================================
  938. **NOTE** This is a development version, for the stable release, please
  939. see versions 0.2.x.
  940. **VERY IMPORTANT:** Pickle is now the encoder used for serializing task
  941. arguments, so be sure to flush your task queue before you upgrade.
  942. * **IMPORTANT** TaskSet.run() now returns a celery.result.TaskSetResult
  943. instance, which lets you inspect the status and return values of a
  944. taskset as it was a single entity.
  945. * **IMPORTANT** Celery now depends on carrot >= 0.4.1.
  946. * The celery daemon now sends task errors to the registered admin e-mails.
  947. To turn off this feature, set ``SEND_CELERY_TASK_ERROR_EMAILS`` to
  948. ``False`` in your ``settings.py``. Thanks to Grégoire Cachet.
  949. * You can now run the celery daemon by using ``manage.py``::
  950. $ python manage.py celeryd
  951. Thanks to Grégoire Cachet.
  952. * Added support for message priorities, topic exchanges, custom routing
  953. keys for tasks. This means we have introduced
  954. ``celery.task.apply_async``, a new way of executing tasks.
  955. You can use ``celery.task.delay`` and ``celery.Task.delay`` like usual, but
  956. if you want greater control over the message sent, you want
  957. ``celery.task.apply_async`` and ``celery.Task.apply_async``.
  958. This also means the AMQP configuration has changed. Some settings has
  959. been renamed, while others are new::
  960. CELERY_AMQP_EXCHANGE
  961. CELERY_AMQP_PUBLISHER_ROUTING_KEY
  962. CELERY_AMQP_CONSUMER_ROUTING_KEY
  963. CELERY_AMQP_CONSUMER_QUEUE
  964. CELERY_AMQP_EXCHANGE_TYPE
  965. See the entry `Can I send some tasks to only some servers?`_ in the
  966. `FAQ`_ for more information.
  967. .. _`Can I send some tasks to only some servers?`:
  968. http://bit.ly/celery_AMQP_routing
  969. .. _`FAQ`: http://ask.github.com/celery/faq.html
  970. * Task errors are now logged using loglevel ``ERROR`` instead of ``INFO``,
  971. and backtraces are dumped. Thanks to Grégoire Cachet.
  972. * Make every new worker process re-establish it's Django DB connection,
  973. this solving the "MySQL connection died?" exceptions.
  974. Thanks to Vitaly Babiy and Jirka Vejrazka.
  975. * **IMOPORTANT** Now using pickle to encode task arguments. This means you
  976. now can pass complex python objects to tasks as arguments.
  977. * Removed dependency to ``yadayada``.
  978. * Added a FAQ, see ``docs/faq.rst``.
  979. * Now converts any unicode keys in task ``kwargs`` to regular strings.
  980. Thanks Vitaly Babiy.
  981. * Renamed the ``TaskDaemon`` to ``WorkController``.
  982. * ``celery.datastructures.TaskProcessQueue`` is now renamed to
  983. ``celery.pool.TaskPool``.
  984. * The pool algorithm has been refactored for greater performance and
  985. stability.
  986. 0.2.0 [2009-05-20 05:14 P.M CET]
  987. ================================
  988. * Final release of 0.2.0
  989. * Compatible with carrot version 0.4.0.
  990. * Fixes some syntax errors related to fetching results
  991. from the database backend.
  992. 0.2.0-pre3 [2009-05-20 05:14 P.M CET]
  993. =====================================
  994. * *Internal release*. Improved handling of unpickled exceptions,
  995. ``get_result`` now tries to recreate something looking like the
  996. original exception.
  997. 0.2.0-pre2 [2009-05-20 01:56 P.M CET]
  998. =====================================
  999. * Now handles unpickleable exceptions (like the dynimically generated
  1000. subclasses of ``django.core.exception.MultipleObjectsReturned``).
  1001. 0.2.0-pre1 [2009-05-20 12:33 P.M CET]
  1002. =====================================
  1003. * It's getting quite stable, with a lot of new features, so bump
  1004. version to 0.2. This is a pre-release.
  1005. * ``celery.task.mark_as_read()`` and ``celery.task.mark_as_failure()`` has
  1006. been removed. Use ``celery.backends.default_backend.mark_as_read()``,
  1007. and ``celery.backends.default_backend.mark_as_failure()`` instead.
  1008. 0.1.15 [2009-05-19 04:13 P.M CET]
  1009. =================================
  1010. * The celery daemon was leaking AMQP connections, this should be fixed,
  1011. if you have any problems with too many files open (like ``emfile``
  1012. errors in ``rabbit.log``, please contact us!
  1013. 0.1.14 [2009-05-19 01:08 P.M CET]
  1014. =================================
  1015. * Fixed a syntax error in the ``TaskSet`` class. (No such variable
  1016. ``TimeOutError``).
  1017. 0.1.13 [2009-05-19 12:36 P.M CET]
  1018. =================================
  1019. * Forgot to add ``yadayada`` to install requirements.
  1020. * Now deletes all expired task results, not just those marked as done.
  1021. * Able to load the Tokyo Tyrant backend class without django
  1022. configuration, can specify tyrant settings directly in the class
  1023. constructor.
  1024. * Improved API documentation
  1025. * Now using the Sphinx documentation system, you can build
  1026. the html documentation by doing ::
  1027. $ cd docs
  1028. $ make html
  1029. and the result will be in ``docs/.build/html``.
  1030. 0.1.12 [2009-05-18 04:38 P.M CET]
  1031. =================================
  1032. * ``delay_task()`` etc. now returns ``celery.task.AsyncResult`` object,
  1033. which lets you check the result and any failure that might have
  1034. happened. It kind of works like the ``multiprocessing.AsyncResult``
  1035. class returned by ``multiprocessing.Pool.map_async``.
  1036. * Added dmap() and dmap_async(). This works like the
  1037. ``multiprocessing.Pool`` versions except they are tasks
  1038. distributed to the celery server. Example:
  1039. >>> from celery.task import dmap
  1040. >>> import operator
  1041. >>> dmap(operator.add, [[2, 2], [4, 4], [8, 8]])
  1042. >>> [4, 8, 16]
  1043. >>> from celery.task import dmap_async
  1044. >>> import operator
  1045. >>> result = dmap_async(operator.add, [[2, 2], [4, 4], [8, 8]])
  1046. >>> result.ready()
  1047. False
  1048. >>> time.sleep(1)
  1049. >>> result.ready()
  1050. True
  1051. >>> result.result
  1052. [4, 8, 16]
  1053. * Refactored the task metadata cache and database backends, and added
  1054. a new backend for Tokyo Tyrant. You can set the backend in your django
  1055. settings file. e.g::
  1056. CELERY_RESULT_BACKEND = "database"; # Uses the database
  1057. CELERY_RESULT_BACKEND = "cache"; # Uses the django cache framework
  1058. CELERY_RESULT_BACKEND = "tyrant"; # Uses Tokyo Tyrant
  1059. TT_HOST = "localhost"; # Hostname for the Tokyo Tyrant server.
  1060. TT_PORT = 6657; # Port of the Tokyo Tyrant server.
  1061. 0.1.11 [2009-05-12 02:08 P.M CET]
  1062. =================================
  1063. * The logging system was leaking file descriptors, resulting in
  1064. servers stopping with the EMFILES (too many open files) error. (fixed)
  1065. 0.1.10 [2009-05-11 12:46 P.M CET]
  1066. =================================
  1067. * Tasks now supports both positional arguments and keyword arguments.
  1068. * Requires carrot 0.3.8.
  1069. * The daemon now tries to reconnect if the connection is lost.
  1070. 0.1.8 [2009-05-07 12:27 P.M CET]
  1071. ================================
  1072. * Better test coverage
  1073. * More documentation
  1074. * celeryd doesn't emit ``Queue is empty`` message if
  1075. ``settings.CELERYD_EMPTY_MSG_EMIT_EVERY`` is 0.
  1076. 0.1.7 [2009-04-30 1:50 P.M CET]
  1077. ===============================
  1078. * Added some unittests
  1079. * Can now use the database for task metadata (like if the task has
  1080. been executed or not). Set ``settings.CELERY_TASK_META``
  1081. * Can now run ``python setup.py test`` to run the unittests from
  1082. within the ``tests`` project.
  1083. * Can set the AMQP exchange/routing key/queue using
  1084. ``settings.CELERY_AMQP_EXCHANGE``, ``settings.CELERY_AMQP_ROUTING_KEY``,
  1085. and ``settings.CELERY_AMQP_CONSUMER_QUEUE``.
  1086. 0.1.6 [2009-04-28 2:13 P.M CET]
  1087. ===============================
  1088. * Introducing ``TaskSet``. A set of subtasks is executed and you can
  1089. find out how many, or if all them, are done (excellent for progress
  1090. bars and such)
  1091. * Now catches all exceptions when running ``Task.__call__``, so the
  1092. daemon doesn't die. This does't happen for pure functions yet, only
  1093. ``Task`` classes.
  1094. * ``autodiscover()`` now works with zipped eggs.
  1095. * celeryd: Now adds curernt working directory to ``sys.path`` for
  1096. convenience.
  1097. * The ``run_every`` attribute of ``PeriodicTask`` classes can now be a
  1098. ``datetime.timedelta()`` object.
  1099. * celeryd: You can now set the ``DJANGO_PROJECT_DIR`` variable
  1100. for ``celeryd`` and it will add that to ``sys.path`` for easy launching.
  1101. * Can now check if a task has been executed or not via HTTP.
  1102. * You can do this by including the celery ``urls.py`` into your project,
  1103. >>> url(r'^celery/$', include("celery.urls"))
  1104. then visiting the following url,::
  1105. http://mysite/celery/$task_id/done/
  1106. this will return a JSON dictionary like e.g:
  1107. >>> {"task": {"id": $task_id, "executed": true}}
  1108. * ``delay_task`` now returns string id, not ``uuid.UUID`` instance.
  1109. * Now has ``PeriodicTasks``, to have ``cron`` like functionality.
  1110. * Project changed name from ``crunchy`` to ``celery``. The details of
  1111. the name change request is in ``docs/name_change_request.txt``.
  1112. 0.1.0 [2009-04-24 11:28 A.M CET]
  1113. ================================
  1114. * Initial release