Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/holdno/gopherCron
golang 开箱即用的秒级分布式定时任务系统
https://github.com/holdno/gopherCron
crontab golang
Last synced: about 2 months ago
JSON representation
golang 开箱即用的秒级分布式定时任务系统
- Host: GitHub
- URL: https://github.com/holdno/gopherCron
- Owner: holdno
- Created: 2018-12-29T05:51:38.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-18T08:56:53.000Z (8 months ago)
- Last Synced: 2024-04-18T10:29:40.320Z (8 months ago)
- Topics: crontab, golang
- Language: Go
- Homepage:
- Size: 194 MB
- Stars: 426
- Watchers: 9
- Forks: 63
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-ops - holdno/gopherCron - 12-29|2024-09-23 | 基于 Go 语言开发的开箱即用的秒级分布式定时任务系统 | (Crontab)
README
GopherCron
开箱即用的分布式可视化crontab
[使用文档](https://gophercron.ojbk.io/)
### Discussions
[关于“为系统增加内置环境变量”的讨论](https://github.com/holdno/gopherCron/discussions/21)
### 依赖
- Etcd # 服务注册与发现
- Mysql # 任务日志存储
### 引用
- [Gin](https://github.com/gin-gonic/gin) 提供 webapi
- 🍉[水瓜](https://github.com/spacegrower/watermelon) 提供服务注册发现能力(中心与边缘通信)
- [gopherCronFe](https://github.com/holdno/gopherCronFe) 提供可视化管理界面(已将构建后的文件内置于 dist/view 目录下)
- [cronexpr](https://github.com/gorhill/cronexpr) 提供 cron 表达式解析器
### 实现功能
- 秒级定时任务(最细 5s 周期)
- 任务日志查看
- 随时结束任务进程
- 分布式扩展
- 健康节点检测 (分项目显示对应的健康节点 IP 及节点数)
- workflow 任务编排
### 监控面板
[Grafana Dashboard 19874](https://grafana.com/grafana/dashboards/19874-gophercron-dashboard/)
### 配套前端
项目地址 [gopherCronFe](https://github.com/holdno/gopherCronFe)
### 任务日志集中上报
1.10.x 版本中 client 配置增加了 report_addr 项，该配置接收一个 http 接口
配置后，任务日志将通过 http 发送到该地址进行集中处理
可通过请求中的 Head 参数 Report-Type 来判断是告警还是日志来做对应的处理
日志结构(参考：common/protocol.go 下的 TaskExecuteResult)：
```golang
// TaskExecuteResult 任务执行结果
type TaskExecuteResult struct {
ExecuteInfo *TaskExecutingInfo `json:"execute_info"`
Output string `json:"output"` // 程序输出
Err string `json:"error"` // 是否发生错误
StartTime time.Time `json:"start_time"` // 开始时间
EndTime time.Time `json:"end_time"` // 结束时间
}
```
v2.1.0 + 版本中移除了 client 对 etcd 的依赖
日志上报相关代码参考 app/taskreport.go
### cronexpr 秒级 cron 表达式介绍(引用)
* * * * * * *
Field name Mandatory? Allowed values Allowed special characters
---------- ---------- -------------- --------------------------
Seconds No 0-59 * / , -
Minutes Yes 0-59 * / , -
Hours Yes 0-23 * / , -
Day of month Yes 1-31 * / , - L W
Month Yes 1-12 or JAN-DEC * / , -
Day of week Yes 0-6 or SUN-SAT * / , - L #
Year No 1970–2099 * / , -
### 使用方法
下载项目到本地并编译，根据 cmd 文件夹下 service 和 client 中包含的 conf/config-default.toml 进行配置
### 初始化数据库表
建表语句在 `pkg/store/sqlstore/table.sql`
### Admin 管理页面
访问地址: localhost:6306/admin
> 管理员初始账号密码为 admin 123456
### 注意
client 配置文件中的 project 配置需要用户先部署 service
在 service 中创建项目后可以获得项目 ID
需要将项目 ID 填写在 client 的配置中该 client 才会调度这个项目的任务
### Chat & QA
- [Discord](https://discord.gg/TCybDnu8)