Documentation
¶
Overview ¶
Package cron is a tiny in-process recurring-job scheduler. Each job runs on an independent goroutine with a configurable interval, optional jitter, and panic recovery. For complex scheduling needs (cron expressions across instances, persistent queues, exactly-once) use temporal or a dedicated scheduler — this package is the boilerplate-killer for the common "every minute / every hour" workloads.
sched := cron.New(cron.WithLogger(log))
sched.Every(time.Minute, "cleanup-temp", func(ctx context.Context) error { ... })
sched.Every(5*time.Minute, "refresh-cache", func(ctx context.Context) error { ... })
sched.Start(ctx)
defer sched.Stop()
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ErrAlreadyStarted = errors.New("cron: scheduler already started")
ErrAlreadyStarted is returned when Start is called twice.
Functions ¶
This section is empty.
Types ¶
type JobStats ¶
type JobStats struct {
Name string
Interval time.Duration
Runs int64
Failures int64
LastError string
}
JobStats is a point-in-time snapshot of a job's counters.
type Option ¶
type Option func(*Scheduler)
func WithJitter ¶
WithJitter spreads job firing by up to `frac * interval` per run, to avoid thundering-herd patterns when many jobs share an interval. Default: 0.1 (10%).
func WithJobTimeout ¶
WithJobTimeout caps how long any single job invocation can run. Default unset (no timeout — relies on Stop or ctx cancellation).
func WithLogger ¶
WithLogger wires a logging function called with job lifecycle events.
type Scheduler ¶
type Scheduler struct {
// contains filtered or unexported fields
}
Scheduler owns a set of recurring jobs.
func (*Scheduler) Start ¶
Start launches every registered job's loop. Returns immediately; the scheduler runs until ctx is cancelled or Stop is called.
Source Files