Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mcmathja/curlyq
Efficient and reliable background processing for Go
https://github.com/mcmathja/curlyq
background-jobs background-worker go golang redis
Last synced: about 1 month ago
JSON representation
Efficient and reliable background processing for Go
- Host: GitHub
- URL: https://github.com/mcmathja/curlyq
- Owner: mcmathja
- License: mit
- Created: 2020-01-23T21:19:21.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-05-01T00:29:33.000Z (over 4 years ago)
- Last Synced: 2024-08-03T17:20:00.513Z (4 months ago)
- Topics: background-jobs, background-worker, go, golang, redis
- Language: Go
- Size: 108 KB
- Stars: 129
- Watchers: 6
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- go-awesome - CurlyQ - Library for processing background tasks (Open source library / Task/Timer)
README
# CurlyQ
[](https://godoc.org/github.com/mcmathja/curlyq)
[](https://travis-ci.org/mcmathja/curlyq)
[](https://gocover.io/github.com/mcmathja/curlyq)
[](https://goreportcard.com/report/github.com/mcmathja/curlyq)
[](https://github.com/mcmathja/curlyq/blob/master/LICENSE)
CurlyQ provides a simple, easy-to-use interface for performing background processing in Go. It supports scheduled jobs, job deduplication, and configurable concurrent execution out of the box.
## Quickstart
```go
package main
import (
"context"
"log"
cq "github.com/mcmathja/curlyq"
)
func main() {
// Create a new producer
producer := cq.NewProducer(&cq.ProducerOpts{
Address: "localhost:6379",
Queue: "testq",
})
// Use the producer to push a job to the queue
producer.Perform(cq.Job{
Data: []byte("Some data!"),
})
// Create a new consumer
consumer := cq.NewConsumer(&cq.ConsumerOpts{
Address: "localhost:6379",
Queue: "testq",
})
// Consume jobs from the queue with the consumer
consumer.Consume(func(ctx context.Context, job cq.Job) error {
log.Println(string(job.Data))
return nil
})
}
```
## The Basics
CurlyQ exposes three key types: Jobs, Producers, and Consumers.
### Jobs
A Job wraps your data. In most cases, that's all you'll ever need to know about it:
```go
job := cq.Job{
Data: []byte("Some data."),
}
```
Every Job also exposes an `ID` field that uniquely identifies it among all jobs in the queue, and an `Attempt` field representing how many times it has been attempted so far.
### Producers
A Producer pushes jobs on to the queue. Create one by providing it with the address of your Redis instance and a queue name:
```go
producer := cq.NewProducer(&cq.ProducerOpts{
Address: "my.redis.addr:6379",
Queue: "queue_name",
})
```
You can also provide an existing [go-redis](https://github.com/go-redis/redis) instance if you would like to configure the queue to run on a more advanced Redis configuration or set up your own retry and timeout logic for network calls:
```go
import "github.com/go-redis/redis/v7"
client := redis.NewClient(&redis.Options{
Password: "p@55vvoRd",
DB: 3,
MaxRetries: 2,
})
producer := cq.NewProducer(&cq.ProducerOpts{
Client: client,
Queue: "queue_name",
})
```
Running `producer.Perform(job)` will add a job to the queue to be run asynchronously. You can also schedule a job to be enqueued at a particular time by running `producer.PerformAt(time, job)`, or after a certain wait period by running `producer.PerformAfter(duration, job)`. All of the `Perform` methods return the ID assigned to the job and an error if one occurred.
You can deduplicate jobs by pre-assigning them IDs:
```go
job := cq.Job{
ID: "todays_job",
}
// Enqueue the job
producer.PerformAfter(10 * time.Second, job)
// Does nothing, because a job with the same ID is already on the queue
producer.Perform(job)
```
Once a job has been acknowledged, its ID becomes available for reuse.
See the documentation for [ProducerOpts](https://godoc.org/github.com/mcmathja/curlyq#ProducerOpts) for more details about available configuration options.
### Consumers
A Consumer pulls jobs off the queue and executes them using a provided handler function. Create one with the same basic options as a Producer:
```go
consumer := cq.NewConsumer(&cq.ConsumerOpts{
Queue: "queue_name",
// With an address:
Address: "my.redis.addr:6379",
// With a preconfigured go-redis client:
Client: redisClient,
})
```
You start a consumer by running its `Consume` method with a handler function:
```go
consumer.Consume(func(ctx context.Context, job cq.Job) error {
log.Println("Job %s has been processed!")
return nil
})
```
If the provided handler function returns `nil`, the job is considered to have been processed successfully and is removed from the queue. If the handler returns an error or panics, the job is considered to have failed and will be retried or killed based on how many times it has been attempted.
`Consume` will continue to process jobs until your application receives an interrupt signal or the consumer encounters a fatal error. Fatal errors only occur when the consumer is unable to communicate with Redis for an essential operation, such as updating the status of a job in flight.
See the documentation for [ConsumerOpts](https://godoc.org/github.com/mcmathja/curlyq#ConsumerOpts) for more details about available configuration options.