README
¶
cronalt
Golang job scheduling
- Runs in-process
- Type-safe (avoids reflection)
- Pluggable and extensible
cronalt is inspired by gocron
Install using go modules
go get github.com/ahmedalhulaibi/cronalt@v1.0.0
Getting started
See internal/examples/basic directory for a simple example
Concepts
Job
The job is simply aware of the task it's provided. It is defined as an interface. Jobs can be extended/wrapped using a decorator to extend functionality.
Job Timer
A Job Timer informs the Scheduler how long to wait before triggering the next run for a given Job. The Job Timer is also defined as an interface to allow for irregular scheduling.
Scheduler
The Scheduler orchestrates all Jobs. It starts all the jobs and stops all the jobs. For each job, an individual goroutine is kicked off with its Job Timer informing the routine how the job should be scheduled.
How Do I...?
How do I lock a job in a distributed system (K8s, Nomad, etc.)?
Decorate your job with a locker implementation.
See internal/examples/redsync for an example.
How do I handle an error if my job fails?
Decorate your job with an error handler implementation.
See internal/examples/errorhandler for an example.
How do I stop the scheduler if a job keeps failing?
Decorate all your jobs with a circuit breaker which cancels the parent context. This will stop the entire process, not just the individual routine.
See internal/examples/circuitbreaker for an example
How do I propagate custom fields in context?
Decorate your job with a context decorator.
See internal/examples/runid for an example
How do I dynamically add and remove jobs?
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var (
ErrMaxConcurrentJobsZero error = fmt.Errorf("maxConcurrentJobs must be greater than zero")
)
Functions ¶
Types ¶
type Scheduler ¶
type Scheduler struct {
// contains filtered or unexported fields
}
func NewScheduler ¶
func NewScheduler(maxConcurrentJobs int, opts ...SchedulerOption) (*Scheduler, error)
type SchedulerOption ¶
func WithClock ¶
func WithClock(t clock) SchedulerOption
WithClock returns a SchedulerOption to inject a clock, default is time.Now
func WithJobStore ¶
func WithJobStore(js jobStore) SchedulerOption
WithJobStore returns a SchedulerOption to inject a jobStore, default is job.store
func WithLogger ¶
func WithLogger(l logger) SchedulerOption
WithLogger returns a SchedulerOption to inject a logger
func WithWaitGroup ¶
func WithWaitGroup(wg waitGroup) SchedulerOption
WithWaitGroup returns a SchedulerOption to inject a waitgroup, default is sync.WaitGroup This can be used to inject your own instance of sync.WaitGroup
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
extensions
|
|
|
internal
|
|
|
examples/basic
command
|
|
|
examples/circuitbreaker
command
|
|
|
examples/dynamicscheduling
command
|
|
|
examples/errorhandler
command
|
|
|
examples/redsync
command
|
|
|
examples/runid
command
|
|