Changelog 40 KB

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