fcfangcc / pyxxl

XXL-JOB的Python执行器实现,可以方便的将Python方法注册到XXL-JOB的调度中心上进行管理
https://fcfangcc.github.io/pyxxl/
GNU General Public License v3.0
60 stars 16 forks source link

xxl-jobs 的python客户端实现

Package version Supported Python versions Coverage

使用pyxxl可以方便的把Python写的方法注册到XXL-JOB中,使用XXL-JOB-ADMIN管理Python定时任务和周期任务

实现原理:通过XXL-JOB提供的RESTful API接口进行对接

注意!!!如果用同步的方法,请查看下面同步任务注意事项。

已经支持的功能

适配的XXL-JOB版本

2.4.0,2.3.0,2.2.0

如遇到不兼容的情况请issue告诉我XXL-JOB版本和对应的问题我会尽量适配

如何使用

pip install pyxxl

# 如果日志需要写入redis
pip install "pyxxl[redis]"

# 如果需要从.env加载配置
pip install "pyxxl[dotenv]"

# 安装所有功能
pip install "pyxxl[all]"
import asyncio

from pyxxl import ExecutorConfig, PyxxlRunner

config = ExecutorConfig(
    xxl_admin_baseurl="http://localhost:8080/xxl-job-admin/api/",
    executor_app_name="xxl-job-executor-sample",
    executor_host="172.17.0.1",
)

app = PyxxlRunner(config)

@app.register(name="demoJobHandler")
async def test_task():
    await asyncio.sleep(5)
    return "成功..."

# 如果你代码里面没有实现全异步,请使用同步函数,不然会阻塞其他任务
@app.register(name="xxxxx")
def test_task3():
    return "成功3"

app.run_executor()

更多示例和接口文档请参考 PYXXL文档 ,具体代码在example文件夹下面

如果executor服务无法直连xxl-admin,请参考PYXXL配置修改executor_listen_host

监控指标

pip install "pyxxl[metrics]"

安装metrics扩展后,执行器会自动加载prometheus的指标监控功能

访问地址为: http://executor_listen_host:executor_listen_port/metrics

同步任务注意事项

同步任务会放到线程池中运行,无法正确接受cancel信号和timeout配置

如果需要使用同步任务并且无法控制(预料)里面执行时间,又需要进行超时和cancel功能的,需要接受pyxxl发出的cancel_event,当该cancel_event被设置时需要中断任务,下面是一个案例:

...

@app.register(name="sync_func")
def sync_loop_demo():
    # 如果同步任务里面有循环,为了支持cancel操作,必须每次都判断g.cancel_event.
    task_params_list = []
    while not g.cancel_event.is_set() and task_parasm_list:
        params = task_params_list.pop()
        time.sleep(3)
    return "ok"

# 如下代码会造成线程池里的线程被永远占用,timeout cancel全部不生效
@app.register(name="sync_func2")
def sync_loop_demo2():
    while True:
        time.sleep(3) # 模拟你运行的任务
    return "ok"

其他

已知问题

  1. 界面上显示的执行时间其实是任务回调的时间,而不是真正开始的时间.这是XXL-JOB的bug,pyxxl这边已经传了正确的执行时间过去,XXL-JOB没有按预期解析直接取了当前时间

开发人员

下面是开发人员如何快捷的搭建开发调试环境

启动xxl的调度中心

./init_dev_env.sh

启动执行器

# if you need. set venv in project.
pip install -e ".[dev,all]"
# 修改app.py中相关的配置信息,然后启动
python example/executor_app.py