Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/olivere/jobqueue
Jobqueue manages running and scheduling jobs (think Sidekiq or Resque for Go).
https://github.com/olivere/jobqueue
go jobqueue resque scheduled-jobs sidekiq workers
Last synced: 7 days ago
JSON representation
Jobqueue manages running and scheduling jobs (think Sidekiq or Resque for Go).
- Host: GitHub
- URL: https://github.com/olivere/jobqueue
- Owner: olivere
- License: mit
- Created: 2016-04-28T13:38:13.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-05-19T16:46:53.000Z (over 3 years ago)
- Last Synced: 2024-08-01T15:41:46.936Z (3 months ago)
- Topics: go, jobqueue, resque, scheduled-jobs, sidekiq, workers
- Language: Go
- Homepage:
- Size: 3.65 MB
- Stars: 37
- Watchers: 5
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Jobqueue
Jobqueue manages running and scheduling jobs (think Sidekiq or Resque).
[](https://github.com/olivere/jobqueue/actions/workflows/test.yaml)
[](https://pkg.go.dev/github.com/olivere/jobqueue)
[](https://raw.githubusercontent.com/olivere/jobqueue/master/LICENSE)
## Prerequisites
You can choose between
[MySQL](https://travis-ci.org/olivere/jobqueue/master/mysql)
and
[MongoDB](https://travis-ci.org/olivere/jobqueue/master/mongodb)
as a backend for persistent storage.
## Getting started
Get the repository with `go get github.com/olivere/jobqueue`.
Example:
```go
import (
"github.com/olivere/jobqueue"
"github.com/olivere/jobqueue/mysql"
)
// Create a MySQL-based persistent backend.
store, err := mysql.NewStore("root@tcp(127.0.0.1:3306)/jobqueue_e2e?loc=UTC&parseTime=true")
if err != nil {
panic(err)
}
// Create a manager with the MySQL store and 10 concurrent workers.
m := jobqueue.New(
jobqueue.SetStore(store),
jobqueue.SetConcurrency(10),
)
// Register one or more topics and their processor
m.Register("clicks", func(args ...interface{}) error {
// Handle "clicks" topic
})
// Start the manager
err := m.Start()
if err != nil {
panic(err)
}
// Add a job: It'll be added to the store and processed eventually.
err = m.Add(&jobqueue.Add{Topic: "clicks", Args: []interface{}{640, 480}})
if err != nil {
panic(err)
}
...
// Stop the manager, either via Stop/Close (which stops after all workers
// are finished) or CloseWithTimeout (which gracefully waits for a specified
// time span)
err = m.CloseWithTimeout(15 * time.Second) // wait for 15 seconds before forced stop
if err != nil {
panic(err)
}
```
See the tests for more details on using jobqueue.
## Tests and Web UI
Ensure the tests succeed with `go test`. You may have to install dependencies.
You can run a simulation of a real worker like so:
```sh
cd e2e
go run main.go
```
Play with the options: `go run e2e/main.go -h`.
Then open a second console and watch the worker doing its job:
```sh
cd ui
go run main.go
```
Then open your web browser at [http://127.0.0.1:12345](http://127.0.0.1:12345).
# License
MIT License. See [LICENSE](https://olivere.mit-license.org/) file for details.