Top Related Projects
Cron for containers
Easy and fluent Go cron scheduling. This is a fork from https://github.com/jasonlvhit/gocron
Minimalist and zero-dependency scheduling library for Go
A Distributed, Fault-Tolerant Cron-Style Job System.
Quick Overview
robfig/cron is a Go library that implements a cron spec parser and job runner. It allows developers to schedule tasks to run periodically at fixed times, dates, or intervals, similar to the Unix cron system. The library provides a flexible and powerful way to manage time-based job scheduling in Go applications.
Pros
- Easy to use and integrate into existing Go projects
- Supports both standard cron syntax and extended syntax for more precise scheduling
- Provides a robust parser that can handle various time formats and intervals
- Offers thread-safe job execution and management
Cons
- Limited built-in error handling for failed jobs
- Lacks advanced features like job prioritization or distributed scheduling
- May consume more resources for applications with a large number of scheduled jobs
- Documentation could be more comprehensive for advanced use cases
Code Examples
- Basic cron job scheduling:
c := cron.New()
c.AddFunc("0 30 * * * *", func() {
fmt.Println("This runs every hour at 30 minutes")
})
c.Start()
- Using custom cron schedules:
c := cron.New()
c.AddFunc("@every 1h30m", func() {
fmt.Println("This runs every 1 hour 30 minutes")
})
c.Start()
- Scheduling a job with error handling:
c := cron.New(cron.WithChain(
cron.Recover(cron.DefaultLogger),
))
c.AddFunc("@daily", func() {
// This job will recover from panics
panic("some error")
})
c.Start()
Getting Started
To use robfig/cron in your Go project, follow these steps:
-
Install the library:
go get github.com/robfig/cron/v3
-
Import the library in your Go code:
import "github.com/robfig/cron/v3"
-
Create a new cron instance and add jobs:
c := cron.New() c.AddFunc("* * * * *", func() { fmt.Println("This runs every minute") }) c.Start()
-
Remember to keep your application running to allow scheduled jobs to execute:
select {} // Block forever
Competitor Comparisons
Cron for containers
Pros of Supercronic
- Designed for containerized environments, offering better support for Docker
- Provides detailed logging and error reporting
- Implements a subset of cron features, focusing on simplicity and reliability
Cons of Supercronic
- Limited feature set compared to cron's extensive capabilities
- May require additional configuration for complex scheduling needs
- Less widely adopted and potentially fewer community resources available
Code Comparison
Cron:
c := cron.New()
c.AddFunc("0 30 * * * *", func() { fmt.Println("Every hour on the half hour") })
c.Start()
Supercronic:
# Crontab file
0 30 * * * * /bin/echo "Every hour on the half hour"
# Run Supercronic
supercronic crontab
Summary
Supercronic is tailored for containerized environments, offering improved logging and simplicity. However, it has a more limited feature set compared to cron. Cron provides more extensive scheduling capabilities and wider adoption but may require additional configuration for containerized use. The choice between the two depends on the specific requirements of your project and deployment environment.
Easy and fluent Go cron scheduling. This is a fork from https://github.com/jasonlvhit/gocron
Pros of gocron
- More feature-rich, including job chaining and concurrent execution
- Actively maintained with regular updates and improvements
- Better support for time zones and custom schedulers
Cons of gocron
- Slightly more complex API, which may have a steeper learning curve
- Potentially higher memory usage due to additional features
Code Comparison
gocron:
s := gocron.NewScheduler(time.UTC)
s.Every(1).Day().At("10:30").Do(task)
s.StartAsync()
cron:
c := cron.New()
c.AddFunc("30 10 * * *", task)
c.Start()
Summary
gocron offers more advanced features and active development, making it suitable for complex scheduling needs. cron provides a simpler, lightweight solution for basic cron-like scheduling. The choice between the two depends on the specific requirements of your project, with gocron being more versatile but potentially more resource-intensive, while cron offers simplicity and efficiency for straightforward scheduling tasks.
Minimalist and zero-dependency scheduling library for Go
Pros of go-quartz
- More feature-rich, offering advanced scheduling options like calendars and time zones
- Provides a more flexible API with support for job chaining and error handling
- Includes built-in persistence and clustering capabilities
Cons of go-quartz
- Higher complexity and steeper learning curve compared to cron
- Potentially overkill for simple scheduling tasks
- Less widespread adoption and community support
Code Comparison
cron example:
c := cron.New()
c.AddFunc("0 30 * * * *", func() { fmt.Println("Every hour on the half hour") })
c.Start()
go-quartz example:
scheduler := quartz.NewStdScheduler()
job := quartz.NewFunctionJob(func() { fmt.Println("Every hour on the half hour") })
trigger := quartz.NewCronTrigger("0 30 * * * ?")
scheduler.ScheduleJob(job, trigger)
scheduler.Start()
Both libraries provide cron-like scheduling functionality, but go-quartz offers a more comprehensive set of features at the cost of increased complexity. cron is simpler and more lightweight, making it suitable for basic scheduling needs. go-quartz is better suited for applications requiring advanced scheduling capabilities, job management, and distributed execution.
A Distributed, Fault-Tolerant Cron-Style Job System.
Pros of cronsun
- Distributed system with web UI for job management
- Supports multiple nodes for high availability and scalability
- Offers more advanced features like alerting and logging
Cons of cronsun
- More complex setup and infrastructure requirements
- Steeper learning curve due to additional features
- Less actively maintained compared to cron
Code Comparison
cron:
c := cron.New()
c.AddFunc("0 30 * * * *", func() { fmt.Println("Every hour on the half hour") })
c.Start()
cronsun:
node := cronsun.NewNode(cfg)
err := node.Run()
if err != nil {
log.Fatal(err)
}
Summary
cron is a simpler, lightweight Go library for scheduling tasks within a single application. It's easy to use and integrate into existing projects.
cronsun is a more feature-rich, distributed job scheduling system with a web interface. It's suitable for larger-scale applications requiring high availability and advanced management capabilities.
Choose cron for straightforward, in-process task scheduling, and cronsun for distributed, scalable job management across multiple nodes.
Convert
designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual CopilotREADME
cron
Cron V3 has been released!
To download the specific tagged release, run:
go get github.com/robfig/cron/v3@v3.0.0
Import it in your program as:
import "github.com/robfig/cron/v3"
It requires Go 1.11 or later due to usage of Go Modules.
Refer to the documentation here: http://godoc.org/github.com/robfig/cron
The rest of this document describes the the advances in v3 and a list of breaking changes for users that wish to upgrade from an earlier version.
Upgrading to v3 (June 2019)
cron v3 is a major upgrade to the library that addresses all outstanding bugs, feature requests, and rough edges. It is based on a merge of master which contains various fixes to issues found over the years and the v2 branch which contains some backwards-incompatible features like the ability to remove cron jobs. In addition, v3 adds support for Go Modules, cleans up rough edges like the timezone support, and fixes a number of bugs.
New features:
-
Support for Go modules. Callers must now import this library as
github.com/robfig/cron/v3
, instead ofgopkg.in/...
-
Fixed bugs:
- 0f01e6b parser: fix combining of Dow and Dom (#70)
- dbf3220 adjust times when rolling the clock forward to handle non-existent midnight (#157)
- eeecf15 spec_test.go: ensure an error is returned on 0 increment (#144)
- 70971dc cron.Entries(): update request for snapshot to include a reply channel (#97)
- 1cba5e6 cron: fix: removing a job causes the next scheduled job to run too late (#206)
-
Standard cron spec parsing by default (first field is "minute"), with an easy way to opt into the seconds field (quartz-compatible). Although, note that the year field (optional in Quartz) is not supported.
-
Extensible, key/value logging via an interface that complies with the https://github.com/go-logr/logr project.
-
The new Chain & JobWrapper types allow you to install "interceptors" to add cross-cutting behavior like the following:
- Recover any panics from jobs
- Delay a job's execution if the previous run hasn't completed yet
- Skip a job's execution if the previous run hasn't completed yet
- Log each job's invocations
- Notification when jobs are completed
It is backwards incompatible with both v1 and v2. These updates are required:
-
The v1 branch accepted an optional seconds field at the beginning of the cron spec. This is non-standard and has led to a lot of confusion. The new default parser conforms to the standard as described by the Cron wikipedia page.
UPDATING: To retain the old behavior, construct your Cron with a custom parser:
// Seconds field, required
cron.New(cron.WithSeconds())
// Seconds field, optional
cron.New(cron.WithParser(cron.NewParser(
cron.SecondOptional | cron.Minute | cron.Hour | cron.Dom | cron.Month | cron.Dow | cron.Descriptor,
)))
-
The Cron type now accepts functional options on construction rather than the previous ad-hoc behavior modification mechanisms (setting a field, calling a setter).
UPDATING: Code that sets Cron.ErrorLogger or calls Cron.SetLocation must be updated to provide those values on construction.
-
CRON_TZ is now the recommended way to specify the timezone of a single schedule, which is sanctioned by the specification. The legacy "TZ=" prefix will continue to be supported since it is unambiguous and easy to do so.
UPDATING: No update is required.
-
By default, cron will no longer recover panics in jobs that it runs. Recovering can be surprising (see issue #192) and seems to be at odds with typical behavior of libraries. Relatedly, the
cron.WithPanicLogger
option has been removed to accommodate the more general JobWrapper type.UPDATING: To opt into panic recovery and configure the panic logger:
cron.New(cron.WithChain(
cron.Recover(logger), // or use cron.DefaultLogger
))
-
In adding support for https://github.com/go-logr/logr,
cron.WithVerboseLogger
was removed, since it is duplicative with the leveled logging.UPDATING: Callers should use
WithLogger
and specify a logger that does not discardInfo
logs. For convenience, one is provided that wraps*log.Logger
:
cron.New(
cron.WithLogger(cron.VerbosePrintfLogger(logger)))
Background - Cron spec format
There are two cron spec formats in common usage:
-
The "standard" cron format, described on the Cron wikipedia page and used by the cron Linux system utility.
-
The cron format used by the Quartz Scheduler, commonly used for scheduled jobs in Java software
The original version of this package included an optional "seconds" field, which made it incompatible with both of these formats. Now, the "standard" format is the default format accepted, and the Quartz format is opt-in.
Top Related Projects
Cron for containers
Easy and fluent Go cron scheduling. This is a fork from https://github.com/jasonlvhit/gocron
Minimalist and zero-dependency scheduling library for Go
A Distributed, Fault-Tolerant Cron-Style Job System.
Convert
designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual Copilot