Celery

问题1:job无法被worker正确接收

线上同一台机器部署了两套服务,分别启动了Celery应用,选取Rabbitmq作为Broker,其中两套服务共用同一个Broker。结果导致:服务B的任务被服务A的Celery received,于是可能会报错:
Received unregistered task of type ‘apps.tasks.scheduled_job.calc_post_score’

消息队列

首先了解一下AMQP的几个核心定义:

AMQP,即Advanced Message Queuing Protocol(高级消息队列协议)
参考:celery文档

  • message 消息,由headers和body组成,例如celery中消息格式:

    1
    2
    3
    4
    5
    6
    
      {
       'task': 'myapp.tasks.add',
       'id': '54086c5e-6193-4575-8308-dbab76798756',
       'args': [4, 4],
       'kwargs': {}
       }
    
  • producer 生产者,发送信息的客户端通常称为发布者或生产者

  • consumer 消费者,接收消息的实体

  • broker 消息中间件,负责将信息从生产者路由到消费者,可以是redis或rabbitmq(官方推荐)

  • channel 信道,建立在connection连接之上

  • exchanges 交换机,负责接收生产者发送的消息,并将其路由到相应的队列。支持3种类型:Direct、Topic、Fanout,不是所有传输都支持这3种

  • queues 队列,存储消息的地方,消费者会从队列中获取消息

  • routing keys 路由键,exchange会根据路由键将消息路由到对应的队列

任务发送接收流程

yuque_diagram.jpg

AMQP通信流程

解决方案

问题1原因:
exchange无法将job路由到对应的队列,或者说因为没有指定队列,导致队列中的job共享而无法找到。
解决方法就是初始化时指定队列名。
以下展示了Flask中如何配置队列和交换机

通过工厂函数初始化celery app,配置了queue之后,任务函数也必须指定一个队列名,或者设置一个task_default_queue默认队列,就不用在每个任务函数装饰器中使用 queue 参数指定队列了

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
    
# 配置queues
celery.conf.task_queues = (
    Queue(
        "game_community_default",
        Exchange("game_community_default"),
        routing_key="game_community_default",
    ),
)
celery.conf.task_default_queue = "game_community_default"
celery.set_default()
celery.autodiscover_tasks(["apps.tasks"])

使用celery的注意点

task_acks_late
设置为True表示任务在执行完成之后才确认,如果Worker进程突然退出或被kill掉也会立即确认;如果为False表示执行之前就确认(默认值)

task_reject_on_worker_lost
设为False, worker进程崩掉之后将重新加入worker,默认值False,可能会造成循环执行

task_always_eager 设为True可用于本地同步调试,而不经过broker

周期任务无法被正确识别?
使用include指定任务模块(和import语义相同)
使用beat_schedule参数指定周期任务字典配置,比如:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
"""手动导入任务,否则可能无法识别"""
INCLUDES = "apps.tasks.scheduled_job"

BEAT_SCHEDULES = {
    # 更新文章热度值
    "calc_post_score": {
        "task": "apps.tasks.scheduled_job.calc_post_score",
        "schedule": crontab("0", "1,7,13,19"),
        "args": (),
    },
    # 更新评论热度值
    "calc_comment_score": {
        "task": "apps.tasks.scheduled_job.calc_comment_score",
        "schedule": crontab("30", "1,7,13,19"),
        "args": (),
    },
}

celery如何访问Flask App上下文

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
def init_app(app: Flask, config) -> Celery:
    class FlaskTask(Task):
        def __call__(self, *args: object, **kwargs: object) -> object:
            with app.app_context():
                return self.run(*args, **kwargs)

    celery = Celery(app.name, task_cls=FlaskTask)
    celery.task_cls = FlaskTask
    celery.config_from_object(config)
    
      
    # 配置queues
    celery.conf.task_queues = (
        Queue(
            "game_community_default",
            Exchange("game_community_default"),
            routing_key="game_community_default",
        ),
    )
    celery.conf.task_default_queue = "game_community_default"
    celery.set_default()
    celery.autodiscover_tasks(["apps.tasks"])

    app.extensions["celery"] = celery
    return celery

另外,使用 @celery_app.task 来装饰任务函数需要访问 celery_app 对象,而使用工厂模式则无法访问 celery_app对象,用@shared_task来替代。

调用 celery_app.set_default() 使得@shared_task 装饰器可以访问任何current app,这与 Flask 的蓝图和应用程序上下文概念类似。

Task states

状态说明
PENDING任务已被添加到任务队列中,等待执行
STARTED任务已开始执行
RETRY任务已失败并且正在尝试重新执行
FAILURE任务执行失败
SUCCESS任务执行成功
REVOKED任务已被撤销

自定义状态

1
2
3
4
5
6
@app.task(bind=True)
def upload_files(self, filenames):
    for i, file in enumerate(filenames):
        if not self.request.called_directly:
            self.update_state(state='PROGRESS',
                meta={'current': i, 'total': len(filenames)})

问题2:Apscheduler周期任务重复执行

多进程环境下,比如Gunicorn多个worker部署,Apscheduler周期任务会重复执行多次

这是Apscheduler3的一个issue,不知道后续版本会不会优化

解决方案

  • 尝试过设置gunicorn worker数=1,无法解决
  • redis分布式锁,执行之前尝试获取锁,成功才执行,注意最后无论执行是否成功都要释放锁

如何设计一个Scheduled Job

cron表达式

属性英文名值
分minute0-59
时hour0-23
日day_of_month1-31
月month_of_year1-12
周day_of_week0-6
开始时间(可选)start_time
截止时间(可选)end_time

周期任务表 periodic_task

columntypedescription
namestr任务名
descriptionstr备注
argsjson / jsonb任务函数参数
last_run_timedatetime最后一次运行时间
triggerstrcontab触发参数
statusint执行状态
enabledint任务启用 / 关闭
job_idstr任务唯一id
resultstr / json执行结果
log_pathstr日志路径