KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agent #developer-tools #codex #typescript #cli #deepseek-harness #claude-code #ai-agents #mcp #rust

forsun

★ 216 Open GitHub ↗

高性能的定时调度服务。

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# forsun

[![Build Status](https://travis-ci.org/snower/forsun.svg?branch=master)](https://travis-ci.org/snower/forsun)

高性能的定时调度服务。

使用Linux系统定时器产生精确到秒的定时，长时间运行无误差，支持内存存储和redis持久化存储，轻松支持千万级定时任务调度，支持shell、http、reids、thrift、beanstalk、mysql六种到时触发回调方式，并可以通过扩展轻松自定义回调器。

使用crontab相似命令创建管理任务，同时Thrift接口创建和取消任务，支持大量语言接入。
	
- [安装](#安装)
- [Docker](#docker)
- [启动服务](#启动服务)
- [Bash接口](#bash接口)
- [Thrift接口](#thrift接口)
- [HTTP接口](#http接口)
- [Action参数详解](#action参数详解)

# 安装

```
pip install forsun

git clone https://github.com/snower/forsun.git
python setup.py install
```

# Docker

使用docker运行，注意：使用docker运行时，shell和宿主机在同一环境，执行shell时将在docker中运行。

```
docker run -d -p 6458:6458 -p 9002:9002 sujin190/forsun:latest

# 使用redis持久化
docker run -d -p 6458:6458 -p 9002:9002 -e ARG_DRIVER=redis -e ARG_DRIVER_REDIS_HOST=127.0.0.1 \
-e ARG_DRIVER_REDIS_PORT=6379 -e ARG_DRIVER_REDIS_PASSWORD=123456 -e ARG_DRIVER_REDIS_DB=0 sujin190/forsun:latest
```

```
# 使用docker-compose
git clone https://github.com/snower/forsun.git
cd forsun
docker-compose up -d
```

# 启动服务

```
usage: forsund [-h] [--conf CONF] [--bind BIND_HOST] [--port BIND_PORT]
               [--http HTTP_BIND] [--demon [DEMON]] [--nodemon [NODEMON]]
               [--log LOG_FILE] [--log-level LOG_LEVEL] [--driver DRIVER]
               [--driver-mem-store-file STORE_MEM_STORE_FILE]
               [--driver-redis-host DRIVER_REDIS_HOST]
               [--driver-redis-port DRIVER_REDIS_PORT]
               [--driver-redis-db DRIVER_REDIS_DB]
               [--driver-redis-password DRIVER_REDIS_PASSWORD]
               [--driver-redis-prefix DRIVER_REDIS_PREFIX]
               [--driver-redis-server-id DRIVER_REDIS_SERVER_ID]
               [--extension-path EXTENSION_PATH] [--extension EXTENSIONS]

High-performance timing scheduling service

optional arguments:
  -h, --help            show this help message and exit
  --conf CONF           conf filename
  --bind BIND_HOST      bind host (default: 127.0.0.1)
  --port BIND_PORT      bind port (default: 6458)
  --http HTTP_BIND      bind http server (default: ) example: 127.0.0.1:80
  --demon [DEMON]       run demon mode (default: True)
  --nodemon [NODEMON]   run no demon mode (default: False)
  --log LOG_FILE        log file
  --log-level LOG_LEVEL
                        log level (defaul: INFO)
  --driver DRIVER       store driver mem or redis (defaul: mem)
  --driver-mem-store-file STORE_MEM_STORE_FILE
                        store mem driver store file (defaul: ~/.forsun.dump)
  --driver-redis-host DRIVER_REDIS_HOST
                        store reids driver host (defaul: 127.0.0.1)
  --driver-redis-port DRIVER_REDIS_PORT
                        store reids driver port (defaul: 6379)
  --driver-redis-db DRIVER_REDIS_DB
                        store reids driver db (defaul: 0)
  --driver-redis-password DRIVER_REDIS_PASSWORD
                        store reids driver password (defaul: )
  --driver-redis-prefix DRIVER_REDIS_PREFIX
                        store reids driver key prefix (defaul: forsun)
  --driver-redis-server-id DRIVER_REDIS_SERVER_ID
                        store reids driver server id (defaul: 0)
  --extension-path EXTENSION_PATH
                        extension path
  --extension EXTENSIONS
                        extension name
```

### 使用内存持久化存储启动：

```
forsund --bind=0.0.0.0 --port=6458 --log=/var/log/forsun.log --log-level=INFO --driver=mem --driver-mem-store-file=/var/lib/fousun/forsun.session
```

### 使用redis持久化存储启动：

```
forsund --bind=0.0.0.0 --port=6458 --log=/var/log/forsun.log --log-level=INFO --driver=redis --driver-redis-host=127.0.0.1 --driver-redis-db=1
```

### 提供http接口：

```
forsund --bind=0.0.0.0 --port=6458 --http=0.0.0.0:9001 --log=/var/log/forsun.log --log-level=INFO --driver=redis --driver-redis-host=127.0.0.1 --driver-redis-db=1
```

### 使用配置文件前台进程方式启动：

```
forsund --conf=forsun.conf --nodemon
```

# Bash接口

```
forsun -h
usage: forsun [-h] [--host HOST] [--port PORT] [--exe EXECUTE] [cmd]

High-performance timing scheduling service

positional arguments:
  cmd            execute cmd (default: )

optional arguments:
  -h, --help     show this help message and exit
  --host HOST    host (default: 127.0.0.1)
  --port PORT    port (default: 6458)
  --exe EXECUTE  execute cmd (default: )
  
#timeout模式（每5秒运行，共运行1次）
forsun "set redis */5/1 * * * * * redis 'host=172.16.0.2;command=\'SET b 1 EX 300\'"
forsun "set shell */5/1 * * * * * shell 'cmd=ls"
forsun "set beanstalk */5/1 * * * * * beanstalk 'host=10.4.14.14;name=etask;body={}'"
forsun "set thrift */5/1 * * * * * thrift 'host=10.4.14.14;port=4220"
forsun "set http */5/1 * * * * * http 'url=\'http://www.baidu.com\''"
forsun "set mysql */5/1 * * * * * mysql 'host=172.16.0.2;user=root;passwd=123456;db=test;sql=\'update test set created_at=now() where id=1\'"

#time模式（定点时间，每天16:32:00运行）
forsun "set redis 0 32 16 * * * redis 'host=172.16.0.2;command=\'SET b 1 EX 300\'"
forsun "set shell 0 32 16 * * * shell 'cmd=ls"
forsun "set beanstalk 0 32 16 * * * beanstalk 'host=10.4.14.14;name=etask;body={}'"
forsun "set thrift 0 32 16 * * * thrift 'host=10.4.14.14;port=4220"
forsun "set http 0 32 16 * * * http 'url=\'http://www.baidu.com\''"
forsun "set mysql 32 16 * * * mysql 'host=172.16.0.2;user=root;passwd=123456;db=test;sql=\'update test set created_at=now() where id=1\'"
```

# Thrift接口

```
exception ForsunPlanError{
    1:i16 code,
    2:string message
}

struct ForsunPlan {
    1: required bool is_time_out,
    2: required string key,
    3: required i16 second,
    4: i16 minute = -1,
    5: i16 hour = -1,
    6: i16 day = -1,
    7: i16 month = -1,
    8: i16 week = -1,
    9: required i32 next_time,
    10: i16 status = 0,
    11: i16 count = 0,
    12: i16 current_count = 0,
    13: i32 last_timeout = 0,
    14:string action = "shell",
    15:map<string, string> params = {}
}

service Forsun{
    i16 ping(),
    ForsunPlan create(1:string key, 2:i16 second, 3:i16 minute = -1, 4:i16 hour = -1, 5:i16 day = -1, 6:i16 month = -1, 7:i16 week = -1, 8:string action="shell", 9:map<string, string> params={}) throws (1:ForsunPlanError err),
    ForsunPlan createTimeout(1:string key, 2:i16 second, 3:i16 minute = -1, 4:i16 hour = -1, 5:i16 day = -1, 6:i16 month = -1, 7:i16 week = -1, 8:i16 count=1, 9:string action="shell", 10:map<string, string> params={}) throws (1:ForsunPlanError err),
    ForsunPlan remove(1:string key) throws (1:ForsunPlanError err),
    ForsunPlan get(1:string key) throws (1:ForsunPlanError err),
    list<ForsunPlan> getCurrent(),
    list<ForsunPlan> getTime(1:i32 timestamp),
    list<string> getKeys(1:string prefix),
    void forsun_call(1:string key, 2:i32 ts, 3:map<string, string> params)
}
```

# HTTP接口

启用http接口需添加--http参数，如--http=0.0.0.0:8001

### 创建定时执行任务

POST /v1/plan

```
# 在03-23 16:35:01执行http get请求http://www.baidu.com/
curl -X POST -H 'Content-Type: application/json' -d '{"key": "test", "seconds": 1, "minute": 35, "hour": 16, "day": 23, "month": 3, "action": "http", "params": {"url": "http://www.baidu.com/"}}' http://127.0.0.1:8001/v1/plan

{"data": {"week": -1, "status": 0, "is_time_out": false, "hour": 16, "current_count": 0, "count": 0, "month": 3, "action": "http", "second": -1, "params": {"url": "http://www.baidu.com/"}, "key": "test", "created_time": 1521764975.0, "next_time": 1521794100, "last_timeout": 0, "day": 23, "minute": 35}, "errcode": 0, "errmsg": ""}
```

action及params参数信息请查看下Action参数信息

### 创建延时任务

PUT /v1/plan

```
# 5秒后执行1次http get请求http://www.baidu.com/
curl -X PUT -H 'Content-Type: application/json' -d '{"key": "test", "seconds": 5, "minute": 0, "hour": 0, "day": 0, "month": 0, "count": 0, "action": "http", "params": {"url": "http://www.baidu.com/"}}' http://127.0.0.1:8001/v1/plan

{"data": {"week": -1, "status": 0, "is_time_out": true, "hour": 0, "current_count": 0, "count": 0, "month": 0, "action": "http", "second": -1, "params": {"url": "http://www.baidu.com/"}, "key": "test", "created_time": 1521765952.0, "next_time": 1521765952, "last_timeout": 0, "day": 0, "minute": 0}, "errcode": 0, "errmsg": ""}
```
action及params参数信息请查看下Action参数信息

### 查询任务

GET /v1/plan

```
# 查询test任务信息
curl -X GET -H 'Content-Type: application/json' http://127.0.0.1:8001/v1/plan?key=test

{"data": {"week": -1, "status": 0, "is_time_out": true, "hour": 0, "current_count": 1, "count": 0, "month": 0, "action": "http", "second": -1, "params": {"url": "http://www.baidu.com/"}, "key": "test", "created_time": 1521766188.0, "next_time": 1521766213, "last_timeout": 1521766188, "day": 0, "minute": 0}, "errcode": 0, "errmsg": ""}
```

### 删除任务

DELETE /v1/plan

```
# 删除test任务信息

curl -X DELETE -H 'Content-Type: application/json' http://127.0.0.1:8001/v1/plan?key=test

{"data": {"week": -1, "status": 0, "is_time_out": true, "hour": 0, "current_count": 1, "count": 0, "month": 0, "action": "http", "second": -1, "params": {"url": "http://www.baidu.com/"}, "key": "test", "created_time": 1521766188.0, "next_time": 1521766378, "last_timeout": 1521766188, "day": 0, "minute": 0}, "errcode": 0, "errmsg": ""}
```

### 获取某时刻执行任务信息

GET /v1/time

```
# 查询1521795279这一刻要执行的任务信息

curl -X GET -H 'Content-Type: application/json' http://127.0.0.1:8001/v1/time?timestamp=1521795279

{"data": {"current_timestamp": 1521159718, "plans": []}, "errcode": 0, "errmsg": ""}
```

timestamp参数不传递或为0查询下一秒执行任务信息

### 查询任务KEY

GET /v1/keys

```
# 过滤t开头的任务
curl -X GET -H 'Content-Type: application/json' http://127.0.0.1:8001/v1/keys?prefix=t

{"data": [], "errcode": 0, "errmsg": ""}
```

# Action参数详解

回调器参数为create和createTimeout最后一个参数params key和value的map。

## shell参数

* cmd shell命令
* cwd 工作目录
* env 环境变量，以;分割＝号连接的字符串，如：a=1;b=c

## http参数

* url 请求接口URL字符串
* method 请求方法，只支持get,post,put,delete,head五种方法
* body 请求体字符串
* header_ 以header_为前缀的key都会放到请求header中
* auth_username 校验用户名
* auth_password 校验密码
* auth_mode 校验方法
* user_agent 请求User－Agent
* connect_timeout 连接超时时间，默认5秒
* request_timeout 请求超时时间，默认60秒

## redis参数

* host redis服务器地址，默认127.0.0.1
* port redis服务器端口，默认6379
* selected_db redis运行命令db
* max_connections 连接redis服务器最大连接数，第一次连接时的命令中的值有效
* command 需要执行的命令，多条命令以;分割

## mysql参数

* host mysql服务器地址，默认127.0.0.1
* port mysql服务器端口，默认3306
* db mysql运行命令db，默认mysql
* user mysql登陆用户名，默认root
* passwd mysql登陆密码，默认空字符串
* max_connections 连接redis服务器最大连接数，第一次连接时的命令中的值有效
* sql 需要执行的sql

## beanstalk参数

* host beanstalk服务器地址，默认127.0.0.1
* port beanstalk服务器端口，默认11300
* name 队列名称，默认default
* body 推送的消息体

## thrift参数

回调thrift接口时，固定请求void forsun_call(1:string key, 2:i32 ts, 3:map<string, string> params)该函数，第三个params参数即为任务定义时的params值。

* host thrift服务器地址，默认127.0.0.1
* port thrift服务器端口，默认5643
* max_connections 连接thrift服务器最大连接数，第一次连接时的命令中的值有效

# License

forsun uses the MIT license, see LICENSE file for the details.

forsun

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README