alive

README

alive

任务保活

直接安装

> go install github.com/Drelf2018/alive/cmd/keepalive@latest
> keepalive --cfg=config.yml --log=logs/2006-01-02.log

程序报错了！为什么？原来是要完善配置文件 config.yml

# config.yml

name: 任务
desc: 任务自身可以绑定命令，也可以在子任务集绑定更多任务，任务的工作目录、环境和输出模板会传递给子任务
env:
  - PYTHONIOENCODING=utf-8
cmd: cmd
args:
  - /C
  - echo
  - Running!
format: '{{if ne .Dir "."}}{{.Dir}}{{end}}> {{.Cmd}}{{range .Args}} {{.}}{{end}}{{endl}}%s{{endl}}'
interval: -1
tasks:
  - name: python 脚本
    desc: 用命令行打印文本
    dir: logs
    env:
      - LOGURU_FORMAT={name}.{function}:{line} | {message}
    cmd: python
    args:
      - -u
      - -c
      - print("Hello KeepAlive!")
    delay: 1
    interval: 2.5

这是程序预设并自动生成的配置文件，看到这一系列参数肯定头大，别急，我带你们读

参数名	参数类型	参数含义
name	string	任务名称，仅用作打印变量和配置文件标识
desc	string	任务介绍，仅用作打印变量和配置文件标识
dir	string	工作路径，会将该值拼接在父任务的工作路径后
env	[]string	环境变量，会复制父任务的环境变量并添加该值
cmd	string	命令名
args	[]string	命令参数
format	string	输出模板，会通过 go 语言自带的 text/template 对内容进行填充，再将真正的输出内容填充进 %s 里面，特别地，用 {{endl}} 表示换行符
delay	float64	延迟启动，在同一任务集中上一任务启动后延迟启动，单位秒
interval	float64	重试间隔，当任务完成或报错终止后，等待一段时间重启该任务，负值则不再启动，单位秒
tasks	[]Task	子任务集，也就是这个表中字段组成的对象的列表

会了没？还没会？那咋办？

Documentation

Index

• type ChanWriter
  • func (c ChanWriter) Write(p []byte) (int, error)
• type Task
  • func (t *Task) Fprint(w io.Writer, s string) (n int, err error)
  • func (t Task) Run() error
  • func (t Task) RunForever(ctx context.Context)
  • func (t *Task) RunTasks(ctx context.Context)
  • func (t Task) RunWithContext(ctx context.Context) error
  • func (t Task) String() string
  • func (t *Task) WriterWrapper(ctx context.Context, w io.Writer) io.Writer

Types

type ChanWriter

type ChanWriter chan []byte

func (ChanWriter) Write

func (c ChanWriter) Write(p []byte) (int, error)

type Task

type Task struct {
	// 任务名称
	Name string `yaml:"name,omitempty" json:"name,omitempty" toml:"name,omitempty"`

	// 任务介绍
	Desc string `yaml:"desc,omitempty" json:"desc,omitempty" toml:"desc,omitempty"`

	// 工作路径
	Dir string `yaml:"dir,omitempty" json:"dir,omitempty" toml:"dir,omitempty"`

	// 环境变量
	Env []string `yaml:"env,omitempty" json:"env,omitempty" toml:"env,omitempty"`

	// 命令名
	Cmd string `yaml:"cmd,omitempty" json:"cmd,omitempty" toml:"cmd,omitempty"`

	// 命令参数
	Args []string `yaml:"args,omitempty" json:"args,omitempty" toml:"args,omitempty"`

	// 输出模板
	Format string `yaml:"format,omitempty" json:"format,omitempty" toml:"format,omitempty"`

	// 延迟启动
	Delay float64 `yaml:"delay,omitempty" json:"delay,omitempty" toml:"delay,omitempty"`

	// 重试间隔
	Interval float64 `yaml:"interval,omitempty" json:"interval,omitempty" toml:"interval,omitempty"`

	// 子任务
	Tasks []Task `yaml:"tasks,omitempty" json:"tasks,omitempty" toml:"tasks,omitempty"`

	// 常规输出
	Out io.Writer `yaml:"-" json:"-" toml:"-"`

	// 错误输出
	Err io.Writer `yaml:"-" json:"-" toml:"-"`

	// 合并输出间隔
	MergeThreshold time.Duration `yaml:"-" json:"-" toml:"-"`

	// 强制输出超时
	FlushTimeout time.Duration `yaml:"-" json:"-" toml:"-"`
}

任务

func (*Task) Fprint

func (t *Task) Fprint(w io.Writer, s string) (n int, err error)

模板输出

func (Task) Run

func (t Task) Run() error

执行任务

func (Task) RunForever

func (t Task) RunForever(ctx context.Context)

任务保活

func (*Task) RunTasks

func (t *Task) RunTasks(ctx context.Context)

运行子任务

func (Task) RunWithContext

func (t Task) RunWithContext(ctx context.Context) error

携带上下文执行任务

func (Task) String

func (t Task) String() string

func (*Task) WriterWrapper

func (t *Task) WriterWrapper(ctx context.Context, w io.Writer) io.Writer

任务输出包装器