kronk

README

kronk

kronk is dead simple scheduler for modern scalable systems.

It allows you to manage background tasks in a distributed architecture.

Already supports Redis as distributed lock manager.

So, now you can add jobs and be sure that they will be completed on only one instance.

Get started

1. Install and import package

go get -u github.com/utkonos-dev/kronk

2. Create Kronk

import (
    "github.com/utkonos-dev/kronk"
    redisAdapter "github.com/utkonos-dev/kronk/dlm/redis"
    "github.com/utkonos-dev/kronk/scheduler/cron"
)

k := kronk.New(
    redisAdapter.NewLocker(redisConn),
    cron.NewScheduler(),
    logger,
    kronk.Config{
        DefaultLockExp:     time.Second,
    },
)

3. Start scheduler

k.Start()

4. Add job

AddJob can be safely called on all instances, but the job will be performed only by one.

job := func() {
    fmt.Println("That'll work")
}

err := k.AddRegularJob("kronksays", "* * * * *", job)
if err != nil {
    // ...
}

PR accepted!

Documentation

Index

• Variables
• type Config
• type Kronk
  • func New(locker dlm.DLM, scheduler scheduler.Scheduler, logger Logger, cfg Config) *Kronk
  • func (k *Kronk) AddOneTimeJob(name string, runAt time.Time, job func()) error
  • func (k *Kronk) AddRegularJob(name, cronTab string, job func()) error
  • func (k *Kronk) RemoveJob(name string) error
  • func (k *Kronk) Scheduler() scheduler.Scheduler
  • func (k *Kronk) Start()
• type Logger

Variables

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

Types

type Config

type Config struct {
	DefaultLockExp time.Duration
	SkipDuplicate  bool
}

type Kronk

type Kronk struct {
	// contains filtered or unexported fields
}

func New

func New(locker dlm.DLM, scheduler scheduler.Scheduler, logger Logger, cfg Config) *Kronk

func (*Kronk) AddOneTimeJob

func (k *Kronk) AddOneTimeJob(name string, runAt time.Time, job func()) error

func (*Kronk) AddRegularJob

func (k *Kronk) AddRegularJob(name, cronTab string, job func()) error

func (*Kronk) RemoveJob

func (k *Kronk) RemoveJob(name string) error

func (*Kronk) Scheduler

func (k *Kronk) Scheduler() scheduler.Scheduler

func (*Kronk) Start

func (k *Kronk) Start()

type Logger

type Logger interface {
	Println(v ...interface{})
	Printf(format string, v ...interface{})
}