Skip to main content
Help improve PyPI by participating in a 5-minute user interface survey!

Celery plugin thats adds ability to graceful stop worker

Project Description

# celery-graceful-stop

[Celery](http://celeryproject.org) plugin provides ability of graceful worker stopping.

# Problem Production deployment of long running tasks require worker to be stopped gracefully. Unfortunately celery got different behaviour:

  1. Receiving SIGTERM signal by celery results starting Warm shutdown procedure. Due this procedure, inspect and control commands become unavailable.
  2. More than that, all tasks are terminated forcely by the second SIGTERM with the Cold shutdown procedure.

This module provides more consistent approach to this problem, it

  1. overrides SIGTERM receiver to prevent default Warm shutdown and Cold shutdown worker behaviour,
  2. forces inspect and control commands to be working even after SIGTERM signal received.

# Installation & Setup

` pip install git+https://github.com/MnogoByte/celery-graceful-stop.git `

Append your proj/celery.py file containg app instance with the following lines.

`python import celery_graceful_stop celery_graceful_stop.register(app) `

# Settings

  • CELERY_GRACEFUL_STOP (boolean). Controls graceful stop function. (True by default)

# Using with systemd

  1. Define 1 service per each worker you got (systemd require only one master pid for restart).
  2. Provide /etc/conf.d/celery_<service_name> configuration file for each worker.
  3. Add [celery@.service](systemd/celery@.service) file into your system.
  4. Register your service with systemctl enable celery@<service_name>.

# Limitations

  • This module disables pool_shrink, pool_grow, autoscale, pool_reload, add_consumer, cancel_consumer control commands after receiving SIGTERM signal. Actually, you’ll does not need to call them when the worker is shutting down, because worker will not starts new tasks.
  • This module has been tested only with celery 3.1 with pool=prefork.

# Author

[Antonov Mikhail](https://github.com/atin65536)

# License

BSD - 3

Release history Release notifications

This version
History Node

0.0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
celery-graceful-stop-0.0.1.tar.gz (4.8 kB) Copy SHA256 hash SHA256 Source None Mar 29, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page