roylee0704 / gron Goto Github PK

View Code? Open in Web Editor NEW

1.0K 15.0 65.0 51 KB

gron, Cron Jobs in Go.

License: MIT License

Go 100.00%

golang cron-jobs scheduling

gron's Introduction

gron

Gron provides a clear syntax for writing and deploying cron jobs.

Goals

Minimalist APIs for scheduling jobs.
Thread safety.
Customizable Job Type.
Customizable Schedule.

Installation

$ go get github.com/roylee0704/gron

Usage

Create schedule.go

package main

import (
	"fmt"
	"time"
	"github.com/roylee0704/gron"
)

func main() {
	c := gron.New()
	c.AddFunc(gron.Every(1*time.Hour), func() {
		fmt.Println("runs every hour.")
	})
	c.Start()
}

Schedule Parameters

All scheduling is done in the machine's local time zone (as provided by the Go time package).

Setup basic periodic schedule with gron.Every().

gron.Every(1*time.Second)
gron.Every(1*time.Minute)
gron.Every(1*time.Hour)

Also support Day, Week by importing gron/xtime:

import "github.com/roylee0704/gron/xtime"

gron.Every(1 * xtime.Day)
gron.Every(1 * xtime.Week)

Schedule to run at specific time with .At(hh:mm)

gron.Every(30 * xtime.Day).At("00:00")
gron.Every(1 * xtime.Week).At("23:59")

Custom Job Type

You may define custom job types by implementing gron.Job interface: Run().

For example:

type Reminder struct {
	Msg string
}

func (r Reminder) Run() {
  fmt.Println(r.Msg)
}

After job has defined, instantiate it and schedule to run in Gron.

c := gron.New()
r := Reminder{ "Feed the baby!" }
c.Add(gron.Every(8*time.Hour), r)
c.Start()

Custom Job Func

You may register Funcs to be executed on a given schedule. Gron will run them in their own goroutines, asynchronously.

c := gron.New()
c.AddFunc(gron.Every(1*time.Second), func() {
	fmt.Println("runs every second")
})
c.Start()

Custom Schedule

Schedule is the interface that wraps the basic Next method: Next(p time.Duration) time.Time

In gron, the interface value Schedule has the following concrete types:

periodicSchedule. adds time instant t to underlying period p.
atSchedule. reoccurs every period p, at time components(hh:mm).

For more info, checkout schedule.go.

Full Example

package main

import (
	"fmt"
	"github.com/roylee0704/gron"
	"github.com/roylee0704/gron/xtime"
)

type PrintJob struct{ Msg string }

func (p PrintJob) Run() {
	fmt.Println(p.Msg)
}

func main() {

	var (
		// schedules
		daily     = gron.Every(1 * xtime.Day)
		weekly    = gron.Every(1 * xtime.Week)
		monthly   = gron.Every(30 * xtime.Day)
		yearly    = gron.Every(365 * xtime.Day)

		// contrived jobs
		purgeTask = func() { fmt.Println("purge aged records") }
		printFoo  = printJob{"Foo"}
		printBar  = printJob{"Bar"}
	)

	c := gron.New()

	c.Add(daily.At("12:30"), printFoo)
	c.AddFunc(weekly, func() { fmt.Println("Every week") })
	c.Start()

	// Jobs may also be added to a running Gron
	c.Add(monthly, printBar)
	c.AddFunc(yearly, purgeTask)

	// Stop Gron (running jobs are not halted).
	c.Stop()
}

gron's People

Contributors

Stargazers

Watchers

Forkers

marpie imjerrybao eaciit wangmingjob postromantic daerwang gotoolkit dzirg44 shotishu lifang218c go-steven gluckyiyi echoorchid ukyiwin jaafar173 alexandre-normand friedcrisptiger eduardev flywithbug-go a4abhishek x0ps trendingtechnology qialie quxiaolong1504 zzg1996 sandeepk17 quieting linxlib eltaline fred07 yunhe1992 imgoogege isgasho rick-max lingling1420q nondramatic big-cabbage sstshenshutao hswuhao binrick liuz quantumghost standardgalactic ajunlonglive nobitapassword yiyiyaya q-meet ag9920 wnz27 craftsland 1511563371 tiger0oo0 coolskys wifecooky himanshusharma-angel fakeyanss shijieqin bacsituan iq-scm hakusai22 kaylee595 xavierxia cyruslabs

gron's Issues

Data race in Add method

Using channel based synchronization in Add method prevents the data races when the cron instance is running.

Although, it can't stop them when the cron instance is inactive.

package main

import (
  "fmt"
  "time"
  "github.com/roylee0704/gron"
)

func main() {
  blocker := make(chan int)
  g := gron.New()

  g.AddFunc(gron.Every(4*time.Second), func() {
    fmt.Println("J-1/4")
  })
  g.AddFunc(gron.Every(3*time.Second), func() {
    fmt.Println("J-2/3")
  })

  // this will access (write) the shared state 'entries' concurrently
  go func() {
    g.AddFunc(gron.Every(2*time.Second), func() {
      fmt.Println("J-3/2")
    })
  }()

  g.Start()

  <-blocker
}

Running this with Golang's Race Detector will report the data race.

$ go run -race main.go

I propose to use Mutex for this particular case.

cc @roylee0704

UTC time using in AtSchedule

Hi，
You mentioned ‘All scheduling is done in the machine's local time zone (as provided by the Go time package).’ in the REAMME.md.

In the implementation of AtSchedule a UTC time is used in reset() function.
Shouldn't that be time.Local?

[Feature Request] Jobs monitoring

Thanks for awesome work!
It would be great if the gron can have some info for all added jobs (runnning, scheduled, ...)

reset 方法是会把时间设置为UTC时区时间吗，为什么不是Local？

func (as atSchedule) reset(t time.Time) time.Time { return time.Date(t.Year(), t.Month(), t.Day(), as.hh, as.mm, 0, 0, time.UTC) }

add cancel support

A cronjob may need be canceled before run in some situation. Sugguest to add this feature

Process all files as arguments

It will be great to parse all files, like in this example:

gron file1.json file2.json file3.json

Only the first file is parsed. No error, no parsing of other files.

This is how tools like jq works.

is it possible to run job once across multiple instances?

Hi
Is it possible to execute the cron jobs only once across multiple instances?
If no, What could a better solution to achieve this?

Run Every hour at a specific time

gron.Every(1 * time.Hour).At("00:30"), func() {
fmt.Println("Every hour on the half hour")
})

crontab:
0 30 * * * *

My use case is that I want to run every hour:
job1 at 00:30
job2 at 00:40