ripple-cron-go

The fastest cron for ripple you'll never need.

A bit of explaination here:

Ripple uses a cronjob to fix any eventual errors in the database. For doing it, it used cron.php, a terribly performing script. No, really. That's three minutes of server CPU being used at 100%!

So I decided to rewrite it to be better performant, and what better language to do it if not Go (well, C, C++ and Assembly are indeed faster, but I'm not on that level of insanity).

This is the result: https://asciinema.org/a/42583 (watch the video especially for the last 30 seconds, as you can see the true power of ripple-cron-go).

• Origin: https://zxq.co/ripple/ripple-cron-go
• Mirror: https://github.com/osuripple/ripple-cron-go

Installing

Assuming you have Go installed and your GOPATH set up

go get -u github.com/osuripple/ripple-cron-go
cd $GOPATH/src/github.com/osuripple/ripple-cron-go
go build
./ripple-cron-go
nano cron.conf
./ripple-cron-go # Boom!

Extending

This is an example of a very simple unit of ripple-cron-go:

package main

import (
	"time"

	"github.com/fatih/color"
)

func opTimeConsumingTask() {
	defer wg.Done()

	time.Sleep(time.Second)
	color.Green("> TimeConsumingTask: done!", count)
}

Then you would add a bool in the config struct to enable/disable the task, then this to cron.go (cron.go contains main())

	if c.TimeConsumingTask {
		verboseln("Starting time consuming task")
		wg.Add(1)
		go opTimeConsumingTask()
	}

CLI Arguments

root@c021393c3a8a:/go/src/zxq.co/ripple/ripple-cron-go# ./ripple-cron-go -h                 
Usage of ./ripple-cron-go:
  -config string
    	Configuration file (default "cron.conf")
  -v	verbose
  -vv
    	very verbose (LogQueries)

Logging

By default, ripple-cron-go outputs very little information to stdout. You can increase the amount of logged information with the -v flag. This will show the progress of each job.
The -vv flag will log queries as well and it should be used only for debugging purposes.

Multiple configs

You can also specify multiple .conf files (es: hourly.conf and daily.conf) and then run ripple-cron-go with a specific config file with:

$ ./ripple-cron-co -config=hourly.conf
$ ./ripple-cron-co -config=daily.conf

If the specified .conf file does not exist, ripple-cron-go will create it and populate it with default settings.
If no -config flag is provided, cron.conf will be used as configuration file.

License

All code in this repository is licensed under the GNU AGPL 3 License.
See the "LICENSE" file for more information.