Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

cron

package

Go to main page

Versions in this module

v0

v0.8.6

Jan 3, 2026

v0.8.5

Jan 3, 2026

v0.8.4

Jan 3, 2026

v0.8.3

Jan 2, 2026

v0.8.2

Dec 31, 2025

v0.8.1

Dec 31, 2025

v0.8.0

Dec 29, 2025

v0.7.5

Dec 22, 2025

Changes in this version

type Config

+ func (c *Config) GetMode() SchedulerMode

+ func (c *Config) GetStorage() StorageType

type ConfigOption

+ func WithModeString(mode string) ConfigOption

+ func WithStorageString(storage string) ConfigOption

+ type SchedulerMode string

+ const ModeDistributed

+ const ModeSimple

+ func (m SchedulerMode) IsValid() bool

+ func (m SchedulerMode) String() string

+ type StorageType string

+ const StorageDatabase

+ const StorageMemory

+ const StorageRedis

+ func (s StorageType) IsValid() bool

+ func (s StorageType) String() string

v0.7.4

Dec 19, 2025

Changes in this version

+ const ErrCodeExecutionCancelled

+ const ErrCodeExecutionNotFound

+ const ErrCodeExecutionTimeout

+ const ErrCodeHandlerNotFound

+ const ErrCodeInvalidConfig

+ const ErrCodeInvalidJobType

+ const ErrCodeInvalidSchedule

+ const ErrCodeJobAlreadyExists

+ const ErrCodeJobDisabled

+ const ErrCodeJobNotFound

+ const ErrCodeJobRunning

+ const ErrCodeLockAcquisitionFailed

+ const ErrCodeMaxRetriesExceeded

+ const ErrCodeNotLeader

+ const ErrCodeSchedulerNotRunning

+ const ErrCodeStorageError

+ var ErrExecutionCancelled = errors.New("execution cancelled")

+ var ErrExecutionNotFound = errors.New("execution not found")

+ var ErrExecutionTimeout = errors.New("execution timeout")

+ var ErrHandlerNotFound = errors.New("handler not found")

+ var ErrInvalidConfig = errors.New("invalid configuration")

+ var ErrInvalidData = errors.New("invalid data received from storage")

+ var ErrInvalidJobType = errors.New("invalid job type: must have either handler or command")

+ var ErrInvalidSchedule = errors.New("invalid cron schedule")

+ var ErrJobAlreadyExists = errors.New("job already exists")

+ var ErrJobDisabled = errors.New("job is disabled")

+ var ErrJobNotFound = errors.New("job not found")

+ var ErrJobRunning = errors.New("job is already running")

+ var ErrLockAcquisitionFailed = errors.New("lock acquisition failed")

+ var ErrMaxRetriesExceeded = errors.New("max retries exceeded")

+ var ErrNotLeader = errors.New("not leader")

+ var ErrSchedulerNotRunning = errors.New("scheduler not running")

+ var ErrStorageError = errors.New("storage error")

+ func CreateLoggingMiddleware(log func(ctx context.Context, job *Job, err error)) func(JobHandler) JobHandler

+ func CreatePanicRecoveryMiddleware(onPanic func(ctx context.Context, job *Job, recovered interface{})) func(JobHandler) JobHandler

+ func CreateTimeoutMiddleware() func(JobHandler) JobHandler

+ func NewExtension(opts ...ConfigOption) forge.Extension

+ func NewExtensionWithConfig(config Config) forge.Extension

+ type Config struct

+ APIPrefix string

+ ConfigFile string

+ ConsensusExtension string

+ DatabaseConnection string

+ DefaultTimeout time.Duration

+ DefaultTimezone string

+ EnableAPI bool

+ EnableMetrics bool

+ EnableWebUI bool

+ HeartbeatInterval time.Duration

+ HistoryRetentionDays int

+ LeaderElection bool

+ LockTTL time.Duration

+ MaxConcurrentJobs int

+ MaxHistoryRecords int

+ MaxRetries int

+ MaxRetryBackoff time.Duration

+ Mode string

+ NodeID string

+ RedisConnection string

+ RequireConfig bool

+ RetryBackoff time.Duration

+ RetryMultiplier float64

+ ShutdownTimeout time.Duration

+ Storage string

+ func DefaultConfig() Config

+ func (c *Config) Validate() error

+ type ConfigOption func(*Config)

+ func WithAPI(enable bool) ConfigOption

+ func WithAPIPrefix(prefix string) ConfigOption

+ func WithConfig(config Config) ConfigOption

+ func WithConfigFile(path string) ConfigOption

+ func WithConsensusExtension(name string) ConfigOption

+ func WithDatabaseConnection(name string) ConfigOption

+ func WithDefaultTimeout(timeout time.Duration) ConfigOption

+ func WithDefaultTimezone(tz string) ConfigOption

+ func WithHeartbeatInterval(interval time.Duration) ConfigOption

+ func WithHistoryRetention(days int) ConfigOption

+ func WithLeaderElection(enable bool) ConfigOption

+ func WithLockTTL(ttl time.Duration) ConfigOption

+ func WithMaxConcurrentJobs(max int) ConfigOption

+ func WithMaxHistoryRecords(max int) ConfigOption

+ func WithMaxRetries(max int) ConfigOption

+ func WithMaxRetryBackoff(max time.Duration) ConfigOption

+ func WithMetrics(enable bool) ConfigOption

+ func WithMode(mode string) ConfigOption

+ func WithNodeID(id string) ConfigOption

+ func WithRedisConnection(name string) ConfigOption

+ func WithRequireConfig(require bool) ConfigOption

+ func WithRetryBackoff(backoff time.Duration) ConfigOption

+ func WithRetryMultiplier(multiplier float64) ConfigOption

+ func WithShutdownTimeout(timeout time.Duration) ConfigOption

+ func WithStorage(storage string) ConfigOption

+ func WithWebUI(enable bool) ConfigOption

+ type ExecutionFilter struct

+ After *time.Time

+ Before *time.Time

+ JobID string

+ Limit int

+ NodeID string

+ Offset int

+ OrderBy string

+ OrderDir string

+ StartedAt *time.Time

+ Status []ExecutionStatus

+ type ExecutionStatus string

+ const ExecutionStatusCancelled

+ const ExecutionStatusFailed

+ const ExecutionStatusPending

+ const ExecutionStatusRetrying

+ const ExecutionStatusRunning

+ const ExecutionStatusSuccess

+ const ExecutionStatusTimeout

+ type Executor struct

+ func NewExecutor(config Config, storage Storage, registry *JobRegistry, logger forge.Logger, ...) *Executor

+ func (e *Executor) Execute(ctx context.Context, job *Job) (string, error)

+ func (e *Executor) GetRunningCount() int

+ func (e *Executor) GetRunningJobs() []string

+ func (e *Executor) IsJobRunning(jobID string) bool

+ func (e *Executor) Shutdown(ctx context.Context) error

+ type Extension struct

+ func (e *Extension) CreateJob(ctx context.Context, job *Job) error

+ func (e *Extension) DeleteJob(ctx context.Context, jobID string) error

+ func (e *Extension) Dependencies() []string

+ func (e *Extension) GetExecutor() *Executor

+ func (e *Extension) GetRegistry() *JobRegistry

+ func (e *Extension) GetScheduler() Scheduler

+ func (e *Extension) GetStats(ctx context.Context) (*SchedulerStats, error)

+ func (e *Extension) GetStorage() Storage

+ func (e *Extension) Health(ctx context.Context) error

+ func (e *Extension) Register(app forge.App) error

+ func (e *Extension) Run(ctx context.Context) error

+ func (e *Extension) Shutdown(ctx context.Context) error

+ func (e *Extension) Start(ctx context.Context) error

+ func (e *Extension) Stop(ctx context.Context) error

+ func (e *Extension) TriggerJob(ctx context.Context, jobID string) (string, error)

+ func (e *Extension) UpdateJob(ctx context.Context, jobID string, update *JobUpdate) error

+ type HistoryTracker struct

+ func NewHistoryTracker(config Config, storage Storage, logger forge.Logger) *HistoryTracker

+ func (h *HistoryTracker) DeleteJobExecutions(ctx context.Context, jobID string) (int64, error)

+ func (h *HistoryTracker) DeleteOldExecutions(ctx context.Context, before time.Time) (int64, error)

+ func (h *HistoryTracker) GetAllJobStats(ctx context.Context) (map[string]*JobStats, error)

+ func (h *HistoryTracker) GetAverageDuration(ctx context.Context, jobID string) (time.Duration, error)

+ func (h *HistoryTracker) GetExecution(ctx context.Context, executionID string) (*JobExecution, error)

+ func (h *HistoryTracker) GetExecutionCount(ctx context.Context, filter *ExecutionFilter) (int64, error)

+ func (h *HistoryTracker) GetExecutionTrend(ctx context.Context, jobID string, duration time.Duration) (map[string]int, error)

+ func (h *HistoryTracker) GetExecutions(ctx context.Context, filter *ExecutionFilter) ([]*JobExecution, error)

+ func (h *HistoryTracker) GetExecutionsByDateRange(ctx context.Context, after, before time.Time, limit int) ([]*JobExecution, error)

+ func (h *HistoryTracker) GetExecutionsByStatus(ctx context.Context, status ExecutionStatus, limit int) ([]*JobExecution, error)

+ func (h *HistoryTracker) GetFailedExecutions(ctx context.Context, limit int) ([]*JobExecution, error)

+ func (h *HistoryTracker) GetJobExecutions(ctx context.Context, jobID string, limit int) ([]*JobExecution, error)

+ func (h *HistoryTracker) GetJobStats(ctx context.Context, jobID string) (*JobStats, error)

+ func (h *HistoryTracker) GetLastExecution(ctx context.Context, jobID string) (*JobExecution, error)

+ func (h *HistoryTracker) GetLastSuccessfulExecution(ctx context.Context, jobID string) (*JobExecution, error)

+ func (h *HistoryTracker) GetRecentExecutions(ctx context.Context, limit int) ([]*JobExecution, error)

+ func (h *HistoryTracker) GetSuccessRate(ctx context.Context, jobID string) (float64, error)

+ func (h *HistoryTracker) Start(ctx context.Context) error

+ func (h *HistoryTracker) Stop(ctx context.Context) error

+ type Job struct

+ Args []string

+ Command string

+ CreatedAt time.Time

+ Enabled bool

+ Env []string

+ Handler JobHandler

+ HandlerName string

+ ID string

+ LastExecutionAt *time.Time

+ MaxRetries int

+ Metadata map[string]string

+ Name string

+ NextExecutionAt *time.Time

+ Payload map[string]interface{}

+ Schedule string

+ Tags []string

+ Timeout time.Duration

+ Timezone *time.Location

+ UpdatedAt time.Time

+ WorkingDir string

+ type JobConfig struct

+ Args []string

+ Command string

+ Enabled bool

+ Env []string

+ Handler string

+ HandlerName string

+ ID string

+ MaxRetries int

+ Metadata map[string]string

+ Name string

+ Payload map[string]interface{}

+ Schedule string

+ Tags []string

+ Timeout string

+ Timezone string

+ WorkingDir string

+ type JobExecution struct

+ CompletedAt *time.Time

+ Duration time.Duration

+ Error string

+ ID string

+ JobID string

+ JobName string

+ Metadata map[string]string

+ NodeID string

+ Output string

+ Retries int

+ ScheduledAt time.Time

+ StartedAt time.Time

+ Status ExecutionStatus

+ type JobHandler func(ctx context.Context, job *Job) error

+ type JobLoader struct

+ func NewJobLoader(logger forge.Logger, registry *JobRegistry) *JobLoader

+ func (l *JobLoader) ExportToFile(ctx context.Context, jobs []*Job, filePath string) error

+ func (l *JobLoader) LoadFromFile(ctx context.Context, filePath string) ([]*Job, error)

+ func (l *JobLoader) LoadFromJSON(ctx context.Context, data []byte) ([]*Job, error)

+ func (l *JobLoader) LoadFromYAML(ctx context.Context, data []byte) ([]*Job, error)

+ func (l *JobLoader) ValidateJobConfig(config JobConfig) error

+ type JobRegistry struct

+ func NewJobRegistry() *JobRegistry

+ func (r *JobRegistry) Clear()

+ func (r *JobRegistry) Count() int

+ func (r *JobRegistry) Get(name string) (JobHandler, error)

+ func (r *JobRegistry) Has(name string) bool

+ func (r *JobRegistry) List() []string

+ func (r *JobRegistry) MustRegister(name string, handler JobHandler)

+ func (r *JobRegistry) Register(name string, handler JobHandler) error

+ func (r *JobRegistry) RegisterBatch(handlers map[string]JobHandler) error

+ func (r *JobRegistry) RegisterWithMiddleware(name string, handler JobHandler, middleware ...func(JobHandler) JobHandler) error

+ func (r *JobRegistry) Unregister(name string) error

+ func (r *JobRegistry) WrapHandler(name string, wrapper func(JobHandler) JobHandler) error

+ type JobStats struct

+ AverageDuration time.Duration

+ CancelCount int64

+ FailureCount int64

+ JobID string

+ JobName string

+ LastExecution *time.Time

+ LastFailure *time.Time

+ LastSuccess *time.Time

+ MaxDuration time.Duration

+ MinDuration time.Duration

+ NextExecution *time.Time

+ RecentExecutions int

+ SuccessCount int64

+ SuccessRate float64

+ TimeoutCount int64

+ TotalExecutions int64

+ type JobUpdate struct

+ Args []string

+ Command *string

+ Enabled *bool

+ Env []string

+ HandlerName *string

+ MaxRetries *int

+ Metadata map[string]string

+ Name *string

+ Payload map[string]interface{}

+ Schedule *string

+ Tags []string

+ Timeout *time.Duration

+ WorkingDir *string

+ type JobsConfig struct

+ Jobs []JobConfig

+ type MetricsCollector struct

+ func NewMetricsCollector(metrics forge.Metrics, logger forge.Logger) *MetricsCollector

+ func (m *MetricsCollector) ExportMetrics(ctx context.Context) error

+ func (m *MetricsCollector) GetAverageExecutionDuration() time.Duration

+ func (m *MetricsCollector) GetAverageSchedulerLag() time.Duration

+ func (m *MetricsCollector) GetExecutionsTotal() map[string]int64

+ func (m *MetricsCollector) GetJobsTotal() int64

+ func (m *MetricsCollector) GetLeaderStatus() int64

+ func (m *MetricsCollector) GetMetricsSummary() map[string]interface{}

+ func (m *MetricsCollector) GetQueueSize() int64

+ func (m *MetricsCollector) RecordExecution(jobID, jobName string, status ExecutionStatus, duration time.Duration)

+ func (m *MetricsCollector) RecordJobRegistered()

+ func (m *MetricsCollector) RecordJobUnregistered()

+ func (m *MetricsCollector) RecordLeaderStatus(isLeader bool)

+ func (m *MetricsCollector) RecordQueueSize(size int64)

+ func (m *MetricsCollector) RecordSchedulerLag(jobID string, lag time.Duration)

+ func (m *MetricsCollector) Reset()

+ type Scheduler = core.Scheduler

+ type SchedulerStats struct

+ DisabledJobs int

+ EnabledJobs int

+ IsLeader bool

+ JobStats map[string]int

+ NodeID string

+ QueuedExecutions int

+ RunningExecutions int

+ TotalJobs int

+ Uptime time.Duration

+ type Storage = core.Storage

Other modules containing this package

github.com/xraph/forge/extensions/cron