Skip to content

ExecutorConfig

如果安装了python-dotenv,支持从.env文件加载配置项

Warning

会从环境变量覆盖配置，列如access_token参数

优先级为: 环境变量access_token > 环境变量ACCESS_TOKEN > ExecutorConfig().access_token

access_token: Optional[str] = None class-attribute instance-attribute

调度器的token. Default: None

dotenv_path: Optional[str] = None class-attribute instance-attribute

.env文件的路径,默认为当前路径下的.env文件.

executor_app_name: str instance-attribute

xxl-admin上定义的执行器名称,必须一致否则无法注册(如xxl-job-executor-sample). 必填

executor_baseurl: str property

暴露给xxl-admin的地址

executor_listen_host: str = '' class-attribute instance-attribute

执行器HTTP服务绑定的HOST,大部分情况下不需要设置. Default: 第一个网卡的ip地址

当执行器通过了端口转发暴露给admin的时候,需要把executor_url填写为直连admin的地址.

列如调用路径为 xxl-admin -> nginx_ip_or_domain:80 -> executor:9999 这个时候需要配置为

executor_url="http://nginx_ip_or_domain:80"
executor_listen_port=9999
executor_listen_host="0.0.0.0"

executor_listen_port: int = 9999 class-attribute instance-attribute

Default: 9999

executor_log_path: str = 'pyxxl.log' class-attribute instance-attribute

executor日志输出的路径(注意路径必须存在). Default: pyxxl.log

executor_logger: logging.Logger = field(default=None) class-attribute instance-attribute

executor_logger的实例,用于打印executor相关的日志. 由于task的日志需要能展示在xxl-admin上,所以暂时无法定制.

executor_url: str = field(default='') class-attribute instance-attribute

执行器绑定的http服务的url,xxl-admin通过这个host来回调pyxxl执行器. Default: "http://{executor_listen_host}:{executor_listen_port}"

graceful_close: bool = False class-attribute instance-attribute

是否优雅关闭. Default: True

graceful_timeout: int = 60 * 5 class-attribute instance-attribute

优雅关闭的等待时间,超过改时间强制停止任务. Default: 60 * 5

http_retry_duration: int = 5 class-attribute instance-attribute

xxl-admin的http请求重试间隔时间,单位秒. Default: 3

http_retry_times: int = 3 class-attribute instance-attribute

xxl-admin的http请求重试次数. Default: 3

http_timeout: int = 30 class-attribute instance-attribute

xxl-admin的http请求超时时间,单位秒. Default: 10

log_clean_interval: int = 3600 class-attribute instance-attribute

task任务日志清理的间隔时间,单位秒. Default: 3600

如果你的任务执行很频繁，建议减少这个时间间隔，比如设置为60秒，这样每分钟会清理一次过期的日志，避免一次性清理太多文件卡住主进程

log_expired_days: float = 14 class-attribute instance-attribute

task任务日志存储的本地的过期天数. Default: 14

log_local_dir: str = 'logs' class-attribute instance-attribute

task任务日志存储的本地目录,默认为当前目录logs文件夹

log_redis_uri: str = '' class-attribute instance-attribute

task任务日志存储到redis的连接地址

log_target: Literal['disk', 'redis'] = 'disk' class-attribute instance-attribute

task任务日志存储的地方. Default: disk

max_workers: int = 30 class-attribute instance-attribute

执行器线程池（执行同步任务时使用）. Default: 30

task_queue_length: int = 30 class-attribute instance-attribute

任务的队列长度.单机串行的队列长度,当阻塞的任务大于此值时会抛弃. Default: 30

task_timeout: int = 60 * 10 class-attribute instance-attribute

任务的默认超时时间,如果调度器传了以参数executorTimeout为准. Default: 60 * 10

xxl_admin_baseurl: str instance-attribute

xxl-admin服务端暴露的restful接口url(如http://localhost:8080/xxl-job-admin/api/). 必填