Changelog 39 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291
  1. .. _changelog:
  2. ================
  3. Change history
  4. ================
  5. This document contains change notes for bugfix releases in the 3.1.x series
  6. (Cipater), please see :ref:`whatsnew-3.1` for an overview of what's
  7. new in Celery 3.1.
  8. .. _version-3.1.18:
  9. 3.1.18
  10. ======
  11. :release-date: TBD
  12. :release-by: Ask Solem
  13. - **Requirements**
  14. - Now depends on :ref:`Kombu 3.0.25 <kombu:version-3.0.25>`.
  15. - **Worker**: Properly recycle Django database connection in the worker when CONN_MAX_AGE is used.
  16. Fix contributed by Luke Burden.
  17. .. _version-3.1.17:
  18. 3.1.17
  19. ======
  20. :release-date: 2014-11-19 03:30 P.M UTC
  21. :release-by: Ask Solem
  22. .. admonition:: Do not enable the :setting:`CELERYD_FORCE_EXECV` setting!
  23. Please review your configuration and disable this option if you're using the
  24. RabbitMQ or Redis transport.
  25. Keeping this option enabled after 3.1 means the async based prefork pool will
  26. be disabled, which can easily cause instability.
  27. - **Requirements**
  28. - Now depends on :ref:`Kombu 3.0.24 <kombu:version-3.0.24>`.
  29. Includes the new Qpid transport coming in Celery 3.2, backported to
  30. support those who may still require Python 2.6 compatibility.
  31. - Now depends on :mod:`billiard` 3.3.0.19.
  32. - ``celery[librabbitmq]`` now depends on librabbitmq 1.6.1.
  33. - **Task**: The timing of ETA/countdown tasks were off after the example ``LocalTimezone``
  34. implementation in the Python documentation no longer works in Python 3.4.
  35. (Issue #2306).
  36. - **Task**: Raising :exc:`~celery.exceptions.Ignore` no longer sends
  37. ``task-failed`` event (Issue #2365).
  38. - **Redis result backend**: Fixed unbound local errors.
  39. Fix contributed by Thomas French.
  40. - **Task**: Callbacks was not called properly if ``link`` was a list of
  41. signatures (Issuse #2350).
  42. - **Canvas**: chain and group now handles json serialized signatures
  43. (Issue #2076).
  44. - **Results**: ``.join_native()`` would accidentally treat the ``STARTED``
  45. state as being ready (Issue #2326).
  46. This could lead to the chord callback being called with invalid arguments
  47. when using chords with the :setting:`CELERY_TRACK_STARTED` setting
  48. enabled.
  49. - **Canvas**: The ``chord_size`` attribute is now set for all canvas primitives,
  50. making sure more combinations will work with the ``new_join`` optimization
  51. for Redis (Issue #2339).
  52. - **Task**: Fixed problem with app not being properly propagated to
  53. ``trace_task`` in all cases.
  54. Fix contributed by kristaps.
  55. - **Worker**: Expires from task message now associated with a timezone.
  56. Fix contributed by Albert Wang.
  57. - **Cassandra result backend**: Fixed problems when using detailed mode.
  58. When using the Cassandra backend in detailed mode, a regression
  59. caused errors when attempting to retrieve results.
  60. Fix contributed by Gino Ledesma.
  61. - **Mongodb Result backend**: Pickling the backend instance will now include
  62. the original url (Issue #2347).
  63. Fix contributed by Sukrit Khera.
  64. - **Task**: Exception info was not properly set for tasks raising
  65. :exc:`~celery.exceptions.Reject` (Issue #2043).
  66. - **Worker**: Duplicates are now removed when loading the set of revoked tasks
  67. from the worker state database (Issue #2336).
  68. - **celery.contrib.rdb**: Fixed problems with ``rdb.set_trace`` calling stop
  69. from the wrong frame.
  70. Fix contributed by llllllllll.
  71. - **Canvas**: ``chain`` and ``chord`` can now be immutable.
  72. - **Canvas**: ``chord.apply_async`` will now keep partial args set in
  73. ``self.args`` (Issue #2299).
  74. - **Results**: Small refactoring so that results are decoded the same way in
  75. all result backends.
  76. - **Logging**: The ``processName`` format was introduced in Py2.6.2 so for
  77. compatibility this format is now excluded when using earlier versions
  78. (Issue #1644).
  79. .. _version-3.1.16:
  80. 3.1.16
  81. ======
  82. :release-date: 2014-10-03 06:00 P.M UTC
  83. :release-by: Ask Solem
  84. - **Worker**: 3.1.15 broke ``-Ofair`` behavior (Issue #2286).
  85. This regression could result in all tasks executing
  86. in a single child process if ``-Ofair`` was enabled.
  87. - **Canvas**: ``celery.signature`` now properly forwards app argument
  88. in all cases.
  89. - **Task**: ``.retry()`` did not raise the exception correctly
  90. when called without a current exception.
  91. Fix contributed by Andrea Rabbaglietti.
  92. - **Worker**: The ``enable_events`` remote control command
  93. disabled worker-related events by mistake (Issue #2272).
  94. Fix contributed by Konstantinos Koukopoulos.
  95. - **Django**: Adds support for Django 1.7 class names in INSTALLED_APPS
  96. when using ``app.autodiscover_tasks()`` (Issue #2248).
  97. - **Sphinx**: ``celery.contrib.sphinx`` now uses ``getfullargspec``
  98. on Python 3 (Issue #2302).
  99. - **Redis/Cache Backends**: Chords will now run at most once if one or more tasks
  100. in the chord are executed multiple times for some reason.
  101. .. _version-3.1.15:
  102. 3.1.15
  103. ======
  104. :release-date: 2014-09-14 11:00 P.M UTC
  105. :release-by: Ask Solem
  106. - **Django**: Now makes sure ``django.setup()`` is called
  107. before importing any task modules (Django 1.7 compatibility, Issue #2227)
  108. - **Results**: ``result.get()`` was misbehaving by calling
  109. ``backend.get_task_meta`` in a finally call leading to
  110. AMQP result backend queues not being properly cleaned up (Issue #2245).
  111. .. _version-3.1.14:
  112. 3.1.14
  113. ======
  114. :release-date: 2014-09-08 03:00 P.M UTC
  115. :release-by: Ask Solem
  116. - **Requirements**
  117. - Now depends on :ref:`Kombu 3.0.22 <kombu:version-3.0.22>`.
  118. - **Init scripts**: The generic worker init scripts ``status`` command
  119. now gets an accurate pidfile list (Issue #1942).
  120. - **Init scripts**: The generic beat script now implements the ``status``
  121. command.
  122. Contributed by John Whitlock.
  123. - **Commands**: Multi now writes informational output to stdout instead of stderr.
  124. - **Worker**: Now ignores not implemented error for ``pool.restart``
  125. (Issue #2153).
  126. - **Task**: Retry no longer raises retry exception when executed in eager
  127. mode (Issue #2164).
  128. - **AMQP Result backend**: Now ensured ``on_interval`` is called at least
  129. every second for blocking calls to properly propagate parent errors.
  130. - **Django**: Compatibility with Django 1.7 on Windows (Issue #2126).
  131. - **Programs**: `--umask` argument can be now specified in both octal (if starting
  132. with 0) or decimal.
  133. .. _version-3.1.13:
  134. 3.1.13
  135. ======
  136. Security Fixes
  137. --------------
  138. * [Security: `CELERYSA-0002`_] Insecure default umask.
  139. The built-in utility used to daemonize the Celery worker service sets
  140. an insecure umask by default (umask 0).
  141. This means that any files or directories created by the worker will
  142. end up having world-writable permissions.
  143. Special thanks to Red Hat for originally discovering and reporting the
  144. issue!
  145. This version will no longer set a default umask by default, so if unset
  146. the umask of the parent process will be used.
  147. .. _`CELERYSA-0002`:
  148. http://github.com/celery/celery/tree/master/docs/sec/CELERYSA-0002.txt
  149. News
  150. ----
  151. - **Requirements**
  152. - Now depends on :ref:`Kombu 3.0.21 <kombu:version-3.0.21>`.
  153. - Now depends on :mod:`billiard` 3.3.0.18.
  154. - **App**: ``backend`` argument now also sets the :setting:`CELERY_RESULT_BACKEND`
  155. setting.
  156. - **Task**: ``signature_from_request`` now propagates ``reply_to`` so that
  157. the RPC backend works with retried tasks (Issue #2113).
  158. - **Task**: ``retry`` will no longer attempt to requeue the task if sending
  159. the retry message fails.
  160. Unrelated exceptions being raised could cause a message loop, so it was
  161. better to remove this behavior.
  162. - **Beat**: Accounts for standard 1ms drift by always waking up 0.010s
  163. earlier.
  164. This will adjust the latency so that the periodic tasks will not move
  165. 1ms after every invocation.
  166. - Documentation fixes
  167. Contributed by Yuval Greenfield, Lucas Wiman, nicholsonjf
  168. - **Worker**: Removed an outdated assert statement that could lead to errors
  169. being masked (Issue #2086).
  170. .. _version-3.1.12:
  171. 3.1.12
  172. ======
  173. :release-date: 2014-06-09 10:12 P.M UTC
  174. :release-by: Ask Solem
  175. - **Requirements**
  176. Now depends on :ref:`Kombu 3.0.19 <kombu:version-3.0.19>`.
  177. - **App**: Connections were not being closed after fork due to an error in the
  178. after fork handler (Issue #2055).
  179. This could manifest itself by causing framing errors when using RabbitMQ.
  180. (``Unexpected frame``).
  181. - **Django**: ``django.setup()`` was being called too late when
  182. using Django 1.7 (Issue #1802).
  183. - **Django**: Fixed problems with event timezones when using Django
  184. (``Substantial drift``).
  185. Celery did not take into account that Django modifies the
  186. ``time.timeone`` attributes and friends.
  187. - **Canvas**: ``Signature.link`` now works when the link option is a scalar
  188. value (Issue #2019).
  189. - **Prefork pool**: Fixed race conditions for when file descriptors are
  190. removed from the event loop.
  191. Fix contributed by Roger Hu.
  192. - **Prefork pool**: Improved solution for dividing tasks between child
  193. processes.
  194. This change should improve performance when there are many child
  195. processes, and also decrease the chance that two subsequent tasks are
  196. written to the same child process.
  197. - **Worker**: Now ignores unknown event types, instead of crashing.
  198. Fix contributed by Illes Solt.
  199. - **Programs**: :program:`celery worker --detach` no longer closes open file
  200. descriptors when :envvar:`C_FAKEFORK` is used so that the workers output
  201. can be seen.
  202. - **Programs**: The default working directory for :program:`celery worker
  203. --detach` is now the current working directory, not ``/``.
  204. - **Canvas**: ``signature(s, app=app)`` did not upgrade serialized signatures
  205. to their original class (``subtask_type``) when the ``app`` keyword argument
  206. was used.
  207. - **Control**: The ``duplicate nodename`` warning emitted by control commands
  208. now shows the duplicate node name.
  209. - **Tasks**: Can now call ``ResultSet.get()`` on a result set without members.
  210. Fix contributed by Alexey Kotlyarov.
  211. - **App**: Fixed strange traceback mangling issue for
  212. ``app.connection_or_acquire``.
  213. - **Programs**: The :program:`celery multi stopwait` command is now documented
  214. in usage.
  215. - **Other**: Fixed cleanup problem with ``PromiseProxy`` when an error is
  216. raised while trying to evaluate the promise.
  217. - **Other**: The utility used to censor configuration values now handles
  218. non-string keys.
  219. Fix contributed by Luke Pomfrey.
  220. - **Other**: The ``inspect conf`` command did not handle non-string keys well.
  221. Fix contributed by Jay Farrimond.
  222. - **Programs**: Fixed argument handling problem in
  223. :program:`celery worker --detach`.
  224. Fix contributed by Dmitry Malinovsky.
  225. - **Programs**: :program:`celery worker --detach` did not forward working
  226. directory option (Issue #2003).
  227. - **Programs**: :program:`celery inspect registered` no longer includes
  228. the list of built-in tasks.
  229. - **Worker**: The ``requires`` attribute for boot steps were not being handled
  230. correctly (Issue #2002).
  231. - **Eventlet**: The eventlet pool now supports the ``pool_grow`` and
  232. ``pool_shrink`` remote control commands.
  233. Contributed by Mher Movsisyan.
  234. - **Eventlet**: The eventlet pool now implements statistics for
  235. :program:``celery inspect stats``.
  236. Contributed by Mher Movsisyan.
  237. - **Documentation**: Clarified ``Task.rate_limit`` behavior.
  238. Contributed by Jonas Haag.
  239. - **Documentation**: ``AbortableTask`` examples now updated to use the new
  240. API (Issue #1993).
  241. - **Documentation**: The security documentation examples used an out of date
  242. import.
  243. Fix contributed by Ian Dees.
  244. - **Init scripts**: The CentOS init scripts did not quote
  245. :envvar:`CELERY_CHDIR`.
  246. Fix contributed by ffeast.
  247. .. _version-3.1.11:
  248. 3.1.11
  249. ======
  250. :release-date: 2014-04-16 11:00 P.M UTC
  251. :release-by: Ask Solem
  252. - **Now compatible with RabbitMQ 3.3.0**
  253. You need to run Celery 3.1.11 or later when using RabbitMQ 3.3,
  254. and if you use the ``librabbitmq`` module you also have to upgrade
  255. to librabbitmq 1.5.0:
  256. .. code-block:: bash
  257. $ pip install -U librabbitmq
  258. - **Requirements**:
  259. - Now depends on :ref:`Kombu 3.0.15 <kombu:version-3.0.15>`.
  260. - Now depends on `billiard 3.3.0.17`_.
  261. - Bundle ``celery[librabbitmq]`` now depends on :mod:`librabbitmq` 1.5.0.
  262. .. _`billiard 3.3.0.17`:
  263. https://github.com/celery/billiard/blob/master/CHANGES.txt
  264. - **Tasks**: The :setting:`CELERY_DEFAULT_DELIVERY_MODE` setting was being
  265. ignored (Issue #1953).
  266. - **Worker**: New :option:`--heartbeat-interval` can be used to change the
  267. time (in seconds) between sending event heartbeats.
  268. Contributed by Matthew Duggan and Craig Northway.
  269. - **App**: Fixed memory leaks occurring when creating lots of temporary
  270. app instances (Issue #1949).
  271. - **MongoDB**: SSL configuration with non-MongoDB transport breaks MongoDB
  272. results backend (Issue #1973).
  273. Fix contributed by Brian Bouterse.
  274. - **Logging**: The color formatter accidentally modified ``record.msg``
  275. (Issue #1939).
  276. - **Results**: Fixed problem with task trails being stored multiple times,
  277. causing ``result.collect()`` to hang (Issue #1936, Issue #1943).
  278. - **Results**: ``ResultSet`` now implements a ``.backend`` attribute for
  279. compatibility with ``AsyncResult``.
  280. - **Results**: ``.forget()`` now also clears the local cache.
  281. - **Results**: Fixed problem with multiple calls to ``result._set_cache``
  282. (Issue #1940).
  283. - **Results**: ``join_native`` populated result cache even if disabled.
  284. - **Results**: The YAML result serializer should now be able to handle storing
  285. exceptions.
  286. - **Worker**: No longer sends task error emails for expected errors (in
  287. ``@task(throws=(..., )))``.
  288. - **Canvas**: Fixed problem with exception deserialization when using
  289. the JSON serializer (Issue #1987).
  290. - **Eventlet**: Fixes crash when ``celery.contrib.batches`` attempted to
  291. cancel a non-existing timer (Issue #1984).
  292. - Can now import ``celery.version_info_t``, and ``celery.five`` (Issue #1968).
  293. .. _version-3.1.10:
  294. 3.1.10
  295. ======
  296. :release-date: 2014-03-22 09:40 P.M UTC
  297. :release-by: Ask Solem
  298. - **Requirements**:
  299. - Now depends on :ref:`Kombu 3.0.14 <kombu:version-3.0.14>`.
  300. - **Results**:
  301. Reliability improvements to the SQLAlchemy database backend. Previously the
  302. connection from the MainProcess was improperly shared with the workers.
  303. (Issue #1786)
  304. - **Redis:** Important note about events (Issue #1882).
  305. There is a new transport option for Redis that enables monitors
  306. to filter out unwanted events. Enabling this option in the workers
  307. will increase performance considerably:
  308. .. code-block:: python
  309. BROKER_TRANSPORT_OPTIONS = {'fanout_patterns': True}
  310. Enabling this option means that your workers will not be able to see
  311. workers with the option disabled (or is running an older version of
  312. Celery), so if you do enable it then make sure you do so on all
  313. nodes.
  314. See :ref:`redis-caveats`.
  315. This will be the default in Celery 3.2.
  316. - **Results**: The :class:`@AsyncResult` object now keeps a local cache
  317. of the final state of the task.
  318. This means that the global result cache can finally be disabled,
  319. and you can do so by setting :setting:`CELERY_MAX_CACHED_RESULTS` to
  320. :const:`-1`. The lifetime of the cache will then be bound to the
  321. lifetime of the result object, which will be the default behavior
  322. in Celery 3.2.
  323. - **Events**: The "Substantial drift" warning message is now logged once
  324. per node name only (Issue #1802).
  325. - **Worker**: Ability to use one log file per child process when using the
  326. prefork pool.
  327. This can be enabled by using the new ``%i`` and ``%I`` format specifiers
  328. for the log file name. See :ref:`worker-files-process-index`.
  329. - **Redis**: New experimental chord join implementation.
  330. This is an optimization for chords when using the Redis result backend,
  331. where the join operation is now considerably faster and using less
  332. resources than the previous strategy.
  333. The new option can be set in the result backend URL:
  334. CELERY_RESULT_BACKEND = 'redis://localhost?new_join=1'
  335. This must be enabled manually as it's incompatible
  336. with workers and clients not using it, so be sure to enable
  337. the option in all clients and workers if you decide to use it.
  338. - **Multi**: With ``-opt:index`` (e.g. :option:`-c:1`) the index now always refers
  339. to the position of a node in the argument list.
  340. This means that referring to a number will work when specifying a list
  341. of node names and not just for a number range:
  342. .. code-block:: bash
  343. celery multi start A B C D -c:1 4 -c:2-4 8
  344. In this example ``1`` refers to node A (as it's the first node in the
  345. list).
  346. - **Signals**: The sender argument to ``Signal.connect`` can now be a proxy
  347. object, which means that it can be used with the task decorator
  348. (Issue #1873).
  349. - **Task**: A regression caused the ``queue`` argument to ``Task.retry`` to be
  350. ignored (Issue #1892).
  351. - **App**: Fixed error message for :meth:`~@Celery.config_from_envvar`.
  352. Fix contributed by Dmitry Malinovsky.
  353. - **Canvas**: Chords can now contain a group of other chords (Issue #1921).
  354. - **Canvas**: Chords can now be combined when using the amqp result backend
  355. (a chord where the callback is also a chord).
  356. - **Canvas**: Calling ``result.get()`` for a chain task will now complete
  357. even if one of the tasks in the chain is ``ignore_result=True``
  358. (Issue #1905).
  359. - **Canvas**: Worker now also logs chord errors.
  360. - **Canvas**: A chord task raising an exception will now result in
  361. any errbacks (``link_error``) to the chord callback to also be called.
  362. - **Results**: Reliability improvements to the SQLAlchemy database backend
  363. (Issue #1786).
  364. Previously the connection from the ``MainProcess`` was improperly
  365. inherited by child processes.
  366. Fix contributed by Ionel Cristian Mărieș.
  367. - **Task**: Task callbacks and errbacks are now called using the group
  368. primitive.
  369. - **Task**: ``Task.apply`` now properly sets ``request.headers``
  370. (Issue #1874).
  371. - **Worker**: Fixed ``UnicodeEncodeError`` occuring when worker is started
  372. by `supervisord`.
  373. Fix contributed by Codeb Fan.
  374. - **Beat**: No longer attempts to upgrade a newly created database file
  375. (Issue #1923).
  376. - **Beat**: New setting :setting:``CELERYBEAT_SYNC_EVERY`` can be be used
  377. to control file sync by specifying the number of tasks to send between
  378. each sync.
  379. Contributed by Chris Clark.
  380. - **Commands**: :program:`celery inspect memdump` no longer crashes
  381. if the :mod:`psutil` module is not installed (Issue #1914).
  382. - **Worker**: Remote control commands now always accepts json serialized
  383. messages (Issue #1870).
  384. - **Worker**: Gossip will now drop any task related events it receives
  385. by mistake (Issue #1882).
  386. .. _version-3.1.9:
  387. 3.1.9
  388. =====
  389. :release-date: 2014-02-10 06:43 P.M UTC
  390. :release-by: Ask Solem
  391. - **Requirements**:
  392. - Now depends on :ref:`Kombu 3.0.12 <kombu:version-3.0.12>`.
  393. - **Prefork pool**: Better handling of exiting child processes.
  394. Fix contributed by Ionel Cristian Mărieș.
  395. - **Prefork pool**: Now makes sure all file descriptors are removed
  396. from the hub when a process is cleaned up.
  397. Fix contributed by Ionel Cristian Mărieș.
  398. - **New Sphinx extension**: for autodoc documentation of tasks:
  399. :mod:`celery.contrib.spinx` (Issue #1833).
  400. - **Django**: Now works with Django 1.7a1.
  401. - **Task**: Task.backend is now a property that forwards to ``app.backend``
  402. if no custom backend has been specified for the task (Issue #1821).
  403. - **Generic init scripts**: Fixed bug in stop command.
  404. Fix contributed by Rinat Shigapov.
  405. - **Generic init scripts**: Fixed compatibility with GNU :manpage:`stat`.
  406. Fix contributed by Paul Kilgo.
  407. - **Generic init scripts**: Fixed compatibility with the minimal
  408. :program:`dash` shell (Issue #1815).
  409. - **Commands**: The :program:`celery amqp basic.publish` command was not
  410. working properly.
  411. Fix contributed by Andrey Voronov.
  412. - **Commands**: Did no longer emit an error message if the pidfile exists
  413. and the process is still alive (Issue #1855).
  414. - **Commands**: Better error message for missing arguments to preload
  415. options (Issue #1860).
  416. - **Commands**: :program:`celery -h` did not work because of a bug in the
  417. argument parser (Issue #1849).
  418. - **Worker**: Improved error message for message decoding errors.
  419. - **Time**: Now properly parses the `Z` timezone specifier in ISO 8601 date
  420. strings.
  421. Fix contributed by Martin Davidsson.
  422. - **Worker**: Now uses the *negotiated* heartbeat value to calculate
  423. how often to run the heartbeat checks.
  424. - **Beat**: Fixed problem with beat hanging after the first schedule
  425. iteration (Issue #1822).
  426. Fix contributed by Roger Hu.
  427. - **Signals**: The header argument to :signal:`before_task_publish` is now
  428. always a dictionary instance so that signal handlers can add headers.
  429. - **Worker**: A list of message headers is now included in message related
  430. errors.
  431. .. _version-3.1.8:
  432. 3.1.8
  433. =====
  434. :release-date: 2014-01-17 10:45 P.M UTC
  435. :release-by: Ask Solem
  436. - **Requirements**:
  437. - Now depends on :ref:`Kombu 3.0.10 <kombu:version-3.0.10>`.
  438. - Now depends on `billiard 3.3.0.14`_.
  439. .. _`billiard 3.3.0.14`:
  440. https://github.com/celery/billiard/blob/master/CHANGES.txt
  441. - **Worker**: The event loop was not properly reinitialized at consumer restart
  442. which would force the worker to continue with a closed ``epoll`` instance on
  443. Linux, resulting in a crash.
  444. - **Events:** Fixed issue with both heartbeats and task events that could
  445. result in the data not being kept in sorted order.
  446. As a result this would force the worker to log "heartbeat missed"
  447. events even though the remote node was sending heartbeats in a timely manner.
  448. - **Results:** The pickle serializer no longer converts group results to tuples,
  449. and will keep the original type (*Issue #1750*).
  450. - **Results:** ``ResultSet.iterate`` is now pending deprecation.
  451. The method will be deprecated in version 3.2 and removed in version 3.3.
  452. Use ``result.get(callback=)`` (or ``result.iter_native()`` where available)
  453. instead.
  454. - **Worker**\|eventlet/gevent: A regression caused ``Ctrl+C`` to be ineffective
  455. for shutdown.
  456. - **Redis result backend:** Now using a pipeline to store state changes
  457. for improved performance.
  458. Contributed by Pepijn de Vos.
  459. - **Redis result backend:** Will now retry storing the result if disconnected.
  460. - **Worker**\|gossip: Fixed attribute error occurring when another node leaves.
  461. Fix contributed by Brodie Rao.
  462. - **Generic init scripts:** Now runs a check at startup to verify
  463. that any configuration scripts are owned by root and that they
  464. are not world/group writeable.
  465. The init script configuration is a shell script executed by root,
  466. so this is a preventive measure to ensure that users do not
  467. leave this file vulnerable to changes by unprivileged users.
  468. .. note::
  469. Note that upgrading celery will not update the init scripts,
  470. instead you need to manually copy the improved versions from the
  471. source distribution:
  472. https://github.com/celery/celery/tree/3.1/extra/generic-init.d
  473. - **Commands**: The :program:`celery purge` command now warns that the operation
  474. will delete all tasks and prompts the user for confirmation.
  475. A new :option:`-f` was added that can be used to disable
  476. interactive mode.
  477. - **Task**: ``.retry()`` did not raise the value provided in the ``exc`` argument
  478. when called outside of an error context (*Issue #1755*).
  479. - **Commands:** The :program:`celery multi` command did not forward command
  480. line configuration to the target workers.
  481. The change means that multi will forward the special ``--`` argument and
  482. configuration content at the end of the arguments line to the specified
  483. workers.
  484. Example using command-line configuration to set a broker heartbeat
  485. from :program:`celery multi`:
  486. .. code-block:: bash
  487. $ celery multi start 1 -c3 -- broker.heartbeat=30
  488. Fix contributed by Antoine Legrand.
  489. - **Canvas:** ``chain.apply_async()`` now properly forwards execution options.
  490. Fix contributed by Konstantin Podshumok.
  491. - **Redis result backend:** Now takes ``connection_pool`` argument that can be
  492. used to change the connection pool class/constructor.
  493. - **Worker:** Now truncates very long arguments and keyword arguments logged by
  494. the pool at debug severity.
  495. - **Worker:** The worker now closes all open files on :sig:`SIGHUP` (regression)
  496. (*Issue #1768*).
  497. Fix contributed by Brodie Rao
  498. - **Worker:** Will no longer accept remote control commands while the
  499. worker startup phase is incomplete (*Issue #1741*).
  500. - **Commands:** The output of the event dump utility
  501. (:program:`celery events -d`) can now be piped into other commands.
  502. - **Documentation:** The RabbitMQ installation instructions for OS X was
  503. updated to use modern homebrew practices.
  504. Contributed by Jon Chen.
  505. - **Commands:** The :program:`celery inspect conf` utility now works.
  506. - **Commands:** The :option:`-no-color` argument was not respected by
  507. all commands (*Issue #1799*).
  508. - **App:** Fixed rare bug with ``autodiscover_tasks()`` (*Issue #1797*).
  509. - **Distribution:** The sphinx docs will now always add the parent directory
  510. to path so that the current celery source code is used as a basis for
  511. API documentation (*Issue #1782*).
  512. - **Documentation:** Supervisord examples contained an extraneous '-' in a
  513. `--logfile` argument example.
  514. Fix contributed by Mohammad Almeer.
  515. .. _version-3.1.7:
  516. 3.1.7
  517. =====
  518. :release-date: 2013-12-17 06:00 P.M UTC
  519. :release-by: Ask Solem
  520. .. _v317-important:
  521. Important Notes
  522. ---------------
  523. Init script security improvements
  524. ---------------------------------
  525. Where the generic init scripts (for ``celeryd``, and ``celerybeat``) before
  526. delegated the responsibility of dropping privileges to the target application,
  527. it will now use ``su`` instead, so that the Python program is not trusted
  528. with superuser privileges.
  529. This is not in reaction to any known exploit, but it will
  530. limit the possibility of a privilege escalation bug being abused in the
  531. future.
  532. You have to upgrade the init scripts manually from this directory:
  533. https://github.com/celery/celery/tree/3.1/extra/generic-init.d
  534. AMQP result backend
  535. ~~~~~~~~~~~~~~~~~~~
  536. The 3.1 release accidentally left the amqp backend configured to be
  537. non-persistent by default.
  538. Upgrading from 3.0 would give a "not equivalent" error when attempting to
  539. set or retrieve results for a task. That is unless you manually set the
  540. persistence setting::
  541. CELERY_RESULT_PERSISTENT = True
  542. This version restores the previous value so if you already forced
  543. the upgrade by removing the existing exchange you must either
  544. keep the configuration by setting ``CELERY_RESULT_PERSISTENT = False``
  545. or delete the ``celeryresults`` exchange again.
  546. Synchronous subtasks
  547. ~~~~~~~~~~~~~~~~~~~~
  548. Tasks waiting for the result of a subtask will now emit
  549. a :exc:`RuntimeWarning` warning when using the prefork pool,
  550. and in 3.2 this will result in an exception being raised.
  551. It's not legal for tasks to block by waiting for subtasks
  552. as this is likely to lead to resource starvation and eventually
  553. deadlock when using the prefork pool (see also :ref:`task-synchronous-subtasks`).
  554. If you really know what you are doing you can avoid the warning (and
  555. the future exception being raised) by moving the operation in a whitelist
  556. block:
  557. .. code-block:: python
  558. from celery.result import allow_join_result
  559. @app.task
  560. def misbehaving():
  561. result = other_task.delay()
  562. with allow_join_result():
  563. result.get()
  564. Note also that if you wait for the result of a subtask in any form
  565. when using the prefork pool you must also disable the pool prefetching
  566. behavior with the worker :ref:`-Ofair option <prefork-pool-prefetch>`.
  567. .. _v317-fixes:
  568. Fixes
  569. -----
  570. - Now depends on :ref:`Kombu 3.0.8 <kombu:version-3.0.8>`.
  571. - Now depends on :mod:`billiard` 3.3.0.13
  572. - Events: Fixed compatibility with non-standard json libraries
  573. that sends float as :class:`decimal.Decimal` (Issue #1731)
  574. - Events: State worker objects now always defines attributes:
  575. ``active``, ``processed``, ``loadavg``, ``sw_ident``, ``sw_ver``
  576. and ``sw_sys``.
  577. - Worker: Now keeps count of the total number of tasks processed,
  578. not just by type (``all_active_count``).
  579. - Init scripts: Fixed problem with reading configuration file
  580. when the init script is symlinked to a runlevel (e.g. ``S02celeryd``).
  581. (Issue #1740).
  582. This also removed a rarely used feature where you can symlink the script
  583. to provide alternative configurations. You instead copy the script
  584. and give it a new name, but perhaps a better solution is to provide
  585. arguments to ``CELERYD_OPTS`` to separate them:
  586. .. code-block:: bash
  587. CELERYD_NODES="X1 X2 Y1 Y2"
  588. CELERYD_OPTS="-A:X1 x -A:X2 x -A:Y1 y -A:Y2 y"
  589. - Fallback chord unlock task is now always called after the chord header
  590. (Issue #1700).
  591. This means that the unlock task will not be started if there's
  592. an error sending the header.
  593. - Celery command: Fixed problem with arguments for some control commands.
  594. Fix contributed by Konstantin Podshumok.
  595. - Fixed bug in ``utcoffset`` where the offset when in DST would be
  596. completely wrong (Issue #1743).
  597. - Worker: Errors occurring while attempting to serialize the result of a
  598. task will now cause the task to be marked with failure and a
  599. :class:`kombu.exceptions.EncodingError` error.
  600. Fix contributed by Ionel Cristian Mărieș.
  601. - Worker with ``-B`` argument did not properly shut down the beat instance.
  602. - Worker: The ``%n`` and ``%h`` formats are now also supported by the
  603. :option:`--logfile`, :option:`--pidfile` and :option:`--statedb` arguments.
  604. Example:
  605. .. code-block:: bash
  606. $ celery -A proj worker -n foo@%h --logfile=%n.log --statedb=%n.db
  607. - Redis/Cache result backends: Will now timeout if keys evicted while trying
  608. to join a chord.
  609. - The fallbock unlock chord task now raises :exc:`Retry` so that the
  610. retry even is properly logged by the worker.
  611. - Multi: Will no longer apply Eventlet/gevent monkey patches (Issue #1717).
  612. - Redis result backend: Now supports UNIX sockets.
  613. Like the Redis broker transport the result backend now also supports
  614. using ``redis+socket:///tmp/redis.sock`` URLs.
  615. Contributed by Alcides Viamontes Esquivel.
  616. - Events: Events sent by clients was mistaken for worker related events
  617. (Issue #1714).
  618. For ``events.State`` the tasks now have a ``Task.client`` attribute
  619. that is set when a ``task-sent`` event is being received.
  620. Also, a clients logical clock is not in sync with the cluster so
  621. they live in a "time bubble". So for this reason monitors will no
  622. longer attempt to merge with the clock of an event sent by a client,
  623. instead it will fake the value by using the current clock with
  624. a skew of -1.
  625. - Prefork pool: The method used to find terminated processes was flawed
  626. in that it did not also take into account missing popen objects.
  627. - Canvas: ``group`` and ``chord`` now works with anon signatures as long
  628. as the group/chord object is associated with an app instance (Issue #1744).
  629. You can pass the app by using ``group(..., app=app)``.
  630. .. _version-3.1.6:
  631. 3.1.6
  632. =====
  633. :release-date: 2013-12-02 06:00 P.M UTC
  634. :release-by: Ask Solem
  635. - Now depends on :mod:`billiard` 3.3.0.10.
  636. - Now depends on :ref:`Kombu 3.0.7 <kombu:version-3.0.7>`.
  637. - Fixed problem where Mingle caused the worker to hang at startup
  638. (Issue #1686).
  639. - Beat: Would attempt to drop privileges twice (Issue #1708).
  640. - Windows: Fixed error with ``geteuid`` not being available (Issue #1676).
  641. - Tasks can now provide a list of expected error classes (Issue #1682).
  642. The list should only include errors that the task is expected to raise
  643. during normal operation::
  644. @task(throws=(KeyError, HttpNotFound))
  645. What happens when an exceptions is raised depends on the type of error:
  646. - Expected errors (included in ``Task.throws``)
  647. Will be logged using severity ``INFO``, and traceback is excluded.
  648. - Unexpected errors
  649. Will be logged using severity ``ERROR``, with traceback included.
  650. - Cache result backend now compatible with Python 3 (Issue #1697).
  651. - CentOS init script: Now compatible with sys-v style init symlinks.
  652. Fix contributed by Jonathan Jordan.
  653. - Events: Fixed problem when task name is not defined (Issue #1710).
  654. Fix contributed by Mher Movsisyan.
  655. - Task: Fixed unbound local errors (Issue #1684).
  656. Fix contributed by Markus Ullmann.
  657. - Canvas: Now unrolls groups with only one task (optimization) (Issue #1656).
  658. - Task: Fixed problem with eta and timezones.
  659. Fix contributed by Alexander Koval.
  660. - Django: Worker now performs model validation (Issue #1681).
  661. - Task decorator now emits less confusing errors when used with
  662. incorrect arguments (Issue #1692).
  663. - Task: New method ``Task.send_event`` can be used to send custom events
  664. to Flower and other monitors.
  665. - Fixed a compatibility issue with non-abstract task classes
  666. - Events from clients now uses new node name format (``gen<pid>@<hostname>``).
  667. - Fixed rare bug with Callable not being defined at interpreter shutdown
  668. (Issue #1678).
  669. Fix contributed by Nick Johnson.
  670. - Fixed Python 2.6 compatibility (Issue #1679).
  671. .. _version-3.1.5:
  672. 3.1.5
  673. =====
  674. :release-date: 2013-11-21 06:20 P.M UTC
  675. :release-by: Ask Solem
  676. - Now depends on :ref:`Kombu 3.0.6 <kombu:version-3.0.6>`.
  677. - Now depends on :mod:`billiard` 3.3.0.8
  678. - App: ``config_from_object`` is now lazy (Issue #1665).
  679. - App: ``autodiscover_tasks`` is now lazy.
  680. Django users should now wrap access to the settings object
  681. in a lambda::
  682. app.autodiscover_tasks(lambda: settings.INSTALLED_APPS)
  683. this ensures that the settings object is not prepared
  684. prematurely.
  685. - Fixed regression for ``--app`` argument experienced by
  686. some users (Issue #1653).
  687. - Worker: Now respects the ``--uid`` and ``--gid`` arguments
  688. even if ``--detach`` is not enabled.
  689. - Beat: Now respects the ``--uid`` and ``--gid`` arguments
  690. even if ``--detach`` is not enabled.
  691. - Python 3: Fixed unorderable error occuring with the worker ``-B``
  692. argument enabled.
  693. - ``celery.VERSION`` is now a named tuple.
  694. - ``maybe_signature(list)`` is now applied recursively (Issue #1645).
  695. - ``celery shell`` command: Fixed ``IPython.frontend`` deprecation warning.
  696. - The default app no longer includes the builtin fixups.
  697. This fixes a bug where ``celery multi`` would attempt
  698. to load the Django settings module before entering
  699. the target working directory.
  700. - The Django daemonization tutorial was changed.
  701. Users no longer have to explicitly export ``DJANGO_SETTINGS_MODULE``
  702. in :file:`/etc/default/celeryd` when the new project layout is used.
  703. - Redis result backend: expiry value can now be 0 (Issue #1661).
  704. - Censoring settings now accounts for non-string keys (Issue #1663).
  705. - App: New ``autofinalize`` option.
  706. Apps are automatically finalized when the task registry is accessed.
  707. You can now disable this behavior so that an exception is raised
  708. instead.
  709. Example:
  710. .. code-block:: python
  711. app = Celery(autofinalize=False)
  712. # raises RuntimeError
  713. tasks = app.tasks
  714. @app.task
  715. def add(x, y):
  716. return x + y
  717. # raises RuntimeError
  718. add.delay(2, 2)
  719. app.finalize()
  720. # no longer raises:
  721. tasks = app.tasks
  722. add.delay(2, 2)
  723. - The worker did not send monitoring events during shutdown.
  724. - Worker: Mingle and gossip is now automatically disabled when
  725. used with an unsupported transport (Issue #1664).
  726. - ``celery`` command: Preload options now supports
  727. the rare ``--opt value`` format (Issue #1668).
  728. - ``celery`` command: Accidentally removed options
  729. appearing before the subcommand, these are now moved to the end
  730. instead.
  731. - Worker now properly responds to ``inspect stats`` commands
  732. even if received before startup is complete (Issue #1659).
  733. - :signal:`task_postrun` is now sent within a finally block, to make
  734. sure the signal is always sent.
  735. - Beat: Fixed syntax error in string formatting.
  736. Contributed by nadad.
  737. - Fixed typos in the documentation.
  738. Fixes contributed by Loic Bistuer, sunfinite.
  739. - Nested chains now works properly when constructed using the
  740. ``chain`` type instead of the ``|`` operator (Issue #1656).
  741. .. _version-3.1.4:
  742. 3.1.4
  743. =====
  744. :release-date: 2013-11-15 11:40 P.M UTC
  745. :release-by: Ask Solem
  746. - Now depends on :ref:`Kombu 3.0.5 <kombu:version-3.0.5>`.
  747. - Now depends on :mod:`billiard` 3.3.0.7
  748. - Worker accidentally set a default socket timeout of 5 seconds.
  749. - Django: Fixup now sets the default app so that threads will use
  750. the same app instance (e.g. for manage.py runserver).
  751. - Worker: Fixed Unicode error crash at startup experienced by some users.
  752. - Calling ``.apply_async`` on an empty chain now works again (Issue #1650).
  753. - The ``celery multi show`` command now generates the same arguments
  754. as the start command does.
  755. - The ``--app`` argument could end up using a module object instead
  756. of an app instance (with a resulting crash).
  757. - Fixed a syntax error problem in the celerybeat init script.
  758. Fix contributed by Vsevolod.
  759. - Tests now passing on PyPy 2.1 and 2.2.
  760. .. _version-3.1.3:
  761. 3.1.3
  762. =====
  763. :release-date: 2013-11-13 00:55 A.M UTC
  764. :release-by: Ask Solem
  765. - Fixed compatibility problem with Python 2.7.0 - 2.7.5 (Issue #1637)
  766. ``unpack_from`` started supporting ``memoryview`` arguments
  767. in Python 2.7.6.
  768. - Worker: :option:`-B` argument accidentally closed files used
  769. for logging.
  770. - Task decorated tasks now keep their docstring (Issue #1636)
  771. .. _version-3.1.2:
  772. 3.1.2
  773. =====
  774. :release-date: 2013-11-12 08:00 P.M UTC
  775. :release-by: Ask Solem
  776. - Now depends on :mod:`billiard` 3.3.0.6
  777. - No longer needs the billiard C extension to be installed.
  778. - The worker silently ignored task errors.
  779. - Django: Fixed ``ImproperlyConfigured`` error raised
  780. when no database backend specified.
  781. Fix contributed by j0hnsmith
  782. - Prefork pool: Now using ``_multiprocessing.read`` with ``memoryview``
  783. if available.
  784. - ``close_open_fds`` now uses ``os.closerange`` if available.
  785. - ``get_fdmax`` now takes value from ``sysconfig`` if possible.
  786. .. _version-3.1.1:
  787. 3.1.1
  788. =====
  789. :release-date: 2013-11-11 06:30 P.M UTC
  790. :release-by: Ask Solem
  791. - Now depends on :mod:`billiard` 3.3.0.4.
  792. - Python 3: Fixed compatibility issues.
  793. - Windows: Accidentally showed warning that the billiard C extension
  794. was not installed (Issue #1630).
  795. - Django: Tutorial updated with a solution that sets a default
  796. :envvar:`DJANGO_SETTINGS_MODULE` so that it doesn't have to be typed
  797. in with the :program:`celery` command.
  798. Also fixed typos in the tutorial, and added the settings
  799. required to use the Django database backend.
  800. Thanks to Chris Ward, orarbel.
  801. - Django: Fixed a problem when using the Django settings in Django 1.6.
  802. - Django: Fixup should not be applied if the django loader is active.
  803. - Worker: Fixed attribute error for ``human_write_stats`` when using the
  804. compatibility prefork pool implementation.
  805. - Worker: Fixed compatibility with billiard without C extension.
  806. - Inspect.conf: Now supports a ``with_defaults`` argument.
  807. - Group.restore: The backend argument was not respected.
  808. .. _version-3.1.0:
  809. 3.1.0
  810. =======
  811. :release-date: 2013-11-09 11:00 P.M UTC
  812. :release-by: Ask Solem
  813. See :ref:`whatsnew-3.1`.