Changelog 34 KB

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