Celery 初次使用

Celery 是一个包含一系列的消息任务队列。您可以不用了解内部的原理直接使用,它的使用时非常简单的。此外 Celery 可以快速与您的产品扩展与集成,以及 Celery 提供了一系列 Celery 可能会用到的工具和技术支持方案。

在本教程中,您将学习 Celery 的基础支持。

学习如下:

  • 选择并且安装一个消息中间件(Broker)

  • 安装 Celery 并且创建第一个任务

  • 运行职程(Worker)以及调用任务

  • 跟踪任务的情况以及返回值

译者:我觉得 Celery 上手是非常简单的,看完本次教程。建议看看下一节的 Celery 的介绍,你可能会发现很多有趣的功能。

选择中间人(Broker)

Celery 需要一个中间件来进行接收和发送消息,通常以独立的服务形式出现,成为 消息中间人(Broker)

以下有几种选择:

RabbitMQ

RabbitMQ 的功能比较齐全、稳定、便于安装。在生产环境来说是首选的,有关 Celery 中使用 RabbitMQ 的详细信息:

使用RabbitMQ

如果您使用的是 Ubuntu 或 Debian ,可以通过以下命令进行安装 RabbitMQ:

$ sudo apt-get install rabbitmq-server

如果在 Docker 中运行 RabbitMQ ,可以使用以下命令:

$ docker run -d -p 5462:5462 rabbitmq

命令执行完毕之后,中间人(Broker)会在后台继续运行,准备输出一条 Starting rabbitmq-server: SUCCESS 的消息。

如果您没有 Ubuntu 或 Debian ,你可以访问官方网站查看其他操作系统(如:Windows)的安装方式:

http://www.rabbitmq.com/download.html

Redis

Redis 功能比较全,但是如果突然停止运行或断电会造成数据丢失,有关 Celery 中使用 Redis 的详细信息:

使用Redis

在 Docker 中运行 Redis ,可以通过以下命令实现:

$ docker run -d -p 6379:6379 redis

其他中间人(Broker)

除以上提到的中间人(Broker)之外,还有处于实验阶段的中间人(Broker),其中包含 Amazon SQS

相关完整的中间人(Broker)列表,请查阅中间人:Broker

安装 Celery

Celery 在 python 的 PyPI 中管理,可以使用 pip 或 easy_install 来进行安装:

$ pip install celery

应用

创建第一个 Celery 实例程序,我们把创建 Celery 程序成为 Celery 应用或直接简称 为 app,创建的第一个实例程序可能需要包含 Celery 中执行操作的所有入口点,例如创建任务、管理职程(Worker)等,所以必须要导入 Celery 模块。

在本教程中将所有的内容,保存为一个 app 文件中。针对大型的项目,可能需要创建 独立的模块。

首先创建 tasks.py:

tasks.py
from celery import Celery
app = Celery('tasks', broker='amqp://[email protected]//')
@app.task
def add(x, y):
return x + y

第一个参数为当前模块的名称,只有在 __main__ 模块中定义任务时才会生产名称。

第二个参数为中间人(Broker)的链接 URL ,实例中使用的 RabbitMQ(Celery默认使用的也是RabbitMQ)。

更多相关的 Celery 中间人(Broker)的选择方案,可查阅上面的中间人(Broker)。例如,对于 RabbitMQ 可以写为 amqp://localhost ,使用 Redis 可以写为 redis://localhost。

创建了一个名称为 add 的任务,返回的俩个数字的和。

译者:我比较喜欢使用 Redis 作为中间人(Broker),对于新上手的建议使用 Redis 作为中间人(Broker),因为我觉得 Redis 比 RabbitMQ 好用一点。

运行 Celery 职程(Worker)服务

现在可以使用 worker 参数进行执行我们刚刚创建职程(Worker):

$ celery -A tasks worker --loglevel=info

注意:

如果职程(Worker)没有正常启动,请查阅 “故障排除”相关分布。

在生产环境中,如果需要将职程(Worker)作为守护进程在后台运行,可以使用平台提供的工具来进行实现,或使用类似 supervisord 这样的工具来进行管理(详情: 守护进程:Daemonization 部分)

关于 Celery 可用的命令完整列表,可以通过以下命令进行查看:

$ celery worker --help

也可以通过以下命令查看一些 Celery 帮助选项:

$ celery help

调用任务

需要调用我们创建的实例任务,可以通过 delay() 进行调用。

delay()apply_async() 的快捷方法,可以更好的控制任务的执行(详情:调用任务:Calling Tasks):

>>> from tasks import add
>>> add.delay(4, 4)

该任务已经有职程(Worker)开始处理,可以通过控制台输出的日志进行查看执行情况。

调用任务会返回一个 AsyncResult 的实例,用于检测任务的状态,等待任务完成获取返回值(如果任务执行失败,会抛出异常)。默认这个功能是不开启的,如果开启则需要配置 Celery 的结果后端,下一小节会详细说明。

保存结果

如果您需要跟踪任务的状态,Celery 需要在某处存储任务的状态信息。Celery 内置了一些后端结果:SQLAlchemy/Django ORM、MemcachedRedis、 RPC (RabbitMQ/AMQP)以及自定义的后端结果存储中间件。

针对本次实例,我们使用 RPC 作为结果后端,将状态信息作为临时消息回传。后端通过 backend 参数指定给 Celery(或者通过配置模块中的 result_backend 选项设定):

app = Celery('tasks', backend='rpc://', broker='pyamqp://')

可以使用Redis作为Celery结果后端,使用RabbitMQ作为中间人(Broker)可以使用以下配置(这种组合比较流行):

app = Celery('tasks', backend='redis://localhost', broker='pyamqp://')

更多关于后端结果配置,请查阅任务结果后端

现在已经配置结果后端,重新调用执行任务。会得到调用任务后返回的一个 AsyncResult 实例:

>>> result = add.delay(4, 4)

ready() 可以检测是否已经处理完毕:

>>> result.ready()
False

整个任务执行过程为异步的,如果一直等待任务完成,会将异步调用转换为同步调用:

>>> result.get(timeout=1)
8

如果任务出现异常,get() 会再次引发异常,可以通过 propagate 参数进行覆盖:

>>> result.get(propagate=False)

如果任务出现异常,可以通过以下命令进行回溯:

>>> result.traceback

警告:

如果后端使用资源进行存储结果,必须要针对调用任务后返回每一个 AsyncResult 实例调用 get() 或 forget() ,进行资源释放。

完整的结果对象,请参阅:celery.result

配置

Celery 像家用电器一样,不需要任何配置,开箱即用。它有一个输入和输出,输入端必须连接中间人(Broker),输出端可以连接到结果后端。如果仔细观察一些家用电器,会发现有很多到按钮,这就是配置。

大多数情况下,使用默认的配置就可以满足,也可以按需配置。查看配置选项可以更加的熟悉 Celery 的配置信息,可以参考 配置和默认配置:Configuration and defaults 章节阅读 Celery 的配置。

可以直接在程序中进行配置,也可以通过配置模块进行专门配置。例如,通过 task_serializer 选项可以指定序列化的方式:

app.conf.task_serializer = 'json'

如果需要配置多个选项,可以通过 upate 进行配置:

app.conf.update(
task_serializer='json',
accept_content=['json'], # Ignore other content
result_serializer='json',
timezone='Europe/Oslo',
enable_utc=True,
)

针对大型的项目,建议使用专用配置模块,进行针对 Celery 配置。不建议使用硬编码,建议将所有的配置项集中化配置。集中化配置可以像系统管理员一样,当系统发生故障时可针对其进行微调。

可以通过 app.config_from_object() 进行加载配置模块:

app.config_from_object('celeryconfig')

其中 celeryconfig 为配置模块的名称,这个是可以自定义修改的、

在上面的实例中,需要在同级目录下创建一个名为 celeryconfig.py 的文件,添加以下内容:

celeryconfig.py
broker_url = 'pyamqp://'
result_backend = 'rpc://'
task_serializer = 'json'
result_serializer = 'json'
accept_content = ['json']
timezone = 'Europe/Oslo'
enable_utc = True

可以通过以下命令来进行验证配置模块是否配置正确:

$ python -m celeryconfig

有关实例的默认配置,详情参考 配置和默认配置:Configuration and defaults

Celery 也可以设置任务执行错误时的专用队列中,这只是配置模块中一小部分,详细配置如下:

celeryconfig.py
task_routes = {
'tasks.add': 'low-priority',
}

Celery 也可以针对任务进行限速,以下为每分钟内允许执行的10个任务的配置:

celeryconfig.py
task_annotations = {
'tasks.add': {'rate_limit': '10/m'}
}

如果使用的是 RabbitMQ 或 Redis 的话,可以在运行时进行设置任务的速率:

$ celery -A tasks control rate_limit tasks.add 10/m
new rate limit set successfully

有关远程控制以及监控职程(Worker),详情参阅 路由任务:Routing Tasks了解更多的任务路由以及 task_annotations 有关的描述信息,或查阅 监控和管理手册:Monitoring and Management Guide

接下来干什么

如果想要了解更多的信息,请参阅 Celery 进阶使用 教程,然后阅读 “用户指南”章节。

故障处理

“常见问题“中含有一部分故障排除信息。

职程(Worker)无法正常启动:权限错误

  • 如果使用系统是 Debian、Ubuntu 或其他基于 Debian 的发行版:

    Debian 最近把 /dev/shm/重名 `/run/shm`。

    使用软连接可以解决该问题:

    # ln -s /run/shm /dev/shm
  • 其他:

    如果设置了 --pidfile --logfile--statedb 其中的一个参数,必须要保证职程(Worker)对指向的文件/目录可读可写。

任务总处于 PENDING (待处理)状态

所有任务的状态默认都是 PENDING (待处理)状态,Celery 在下发任务时不会更换任务状态, 并且如果没有历史任务的都是会被任务待处理状态。

  1. 确认任务没有启用 ignore_result

    如果其中,会强制跳过任务更新状态。

  2. 确保 task_ignore_result 未启用。

  3. 确保没有旧的职程(Worker)正在运行。

    启动多个职程(Worker)比较容易,在每次运行新的职程(Worker)之前需要确保之前的职程是否关闭。

    未配置结果后端的职程(Worker)是否正在运行,可能会消费当前的任务消息。

    –pidfile 参数设置为绝对路径,确保该情况不会出现。

  4. 确认客户是否配置正确。

    可能由于某种场景,客户端与职程(Worker)的后端不配置不同,导致无法获取结果,所以需要确保配置是否正确:

    >>> result = task.delay()
    >>> print(result.backend)