Psychiq provides background job processing for Common Lisp applications inspired by Ruby's Sidekiq.
This software is still ALPHA quality. The APIs will be likely to change.
Writing a worker
(psy:connect-toplevel :host "localhost" :port 6379) (defclass my-worker (psy:worker) ()) (defmethod psy:perform ((worker my-worker) &rest args) ;; Do something )
The worker class is commonly written in an individual ASDF system because it must be shared with clients and servers.
;; Enqueueing to "default" queue (psy:enqueue 'my-worker '("arg1" "arg2")) ;; Enqueueing the job after 300 seconds. (psy:enqueue-in-sec 300 'my-worker '("arg1" "arg2")) ;; Enqueueing a large number of jobs at a time ;; This is useful if you are pushing tens of thousands of jobs or more (psy:enqueue-bulk 'my-worker '("arg1" "arg2") '("another" "one") ...)
The arguments must be simple JSON datatypes which can be serialized with Jonathan.
Starting processing (Server)
Psychiq provides a Roswell script for starting processing:
$ psychiq --host localhost --port 6379 --system myapp-workers
$ psychiq -h Usage: psychiq [option...] Options: -o, --host HOST Redis server host (default: localhost) -p, --port PORT Redis server port (default: 6379) -d, --db DBNUM Redis server db (default: 0) -q, --queue QUEUE[,WEIGHT] Queues to process with optional weights (several -q's allowed) -c, --concurrency INT Processor threads to use (default: 25) -s, --system SYSTEM ASDF system to load before starting (several -s's allowed) -v, --verbose Print more verbose output -n, --namespace NAMESPACE Redis namespace (default: "psychiq") -V, --version Print version -h, --help Show help
(defclass my-worker (psy:worker) ()) ;; Specify max retry attempts. (default: 25) (defmethod psy:worker-max-retries ((worker my-worker)) 1000) ;; Use a named queue to push. (default: "default") (defmethod psy:worker-queue-name ((worker my-worker)) "my-worker-queue") ;; Disable jobs going to the dead job queue. (default: T) (defmethod psy:worker-use-dead-queue-p ((worker my-worker)) nil) ;; Whether to save any error backtrace in the retry payload. (default: NIL) (defmethod psy:worker-use-backtrace-p ((worker my-worker)) t)
- INT: graceful shutdown, waits for all processors are idle.
- TERM: shutdown immediately
When getting an error while performing a job, Psychiq will add the job to the "retry" queue. Jobs in the "retry" queue will be retried automatically with an exponential backoff. After 25 attempts, Psychiq move the job to the "dead" queue.
- SBCL (compiled with sb-thread) or Clozure CL
- Roswell for command-line launcher script.
$ cd ~/common-lisp $ git clone https://github.com/fukamachi/psychiq
$ ros -l ~/common-lisp/psychiq/psychiq.asd install psychiq
- Eitaro Fukamachi (email@example.com)
Copyright (c) 2015 Eitaro Fukamachi (firstname.lastname@example.org)
Licensed under the LLGPL License.