Gearhulk is a modern implementation of Gearman in Go Programming Language. Gearhulk includes various improvements in retry and connection logic for using in Kubernetes. It comes with built-in Prometheus ready metrics. Gearhulk also implements scheduled jobs via cron expressions.
The client package is used for sending jobs to the Gearman job server and getting responses from the server.
"github.com/drawks/gearhulk/client"
The worker package will help developers in developing Gearman worker service easily.
"github.com/drawks/gearhulk/worker"
The gearadmin package implements a client for the gearman admin protocol.
"github.com/drawks/gearhulk/gearadmin"
Install the client package:
$ go get github.com/drawks/gearhulk/client
Install the worker package:
$ go get github.com/drawks/gearhulk/worker
Both of them:
$ go get github.com/drawks/gearhulk
how to start the gearman server?
./gearhulk server --verbose --addr="0.0.0.0:4730"
how to specify leveldb location?
./gearhulk server --verbose --storage-dir=/my-dir --addr="0.0.0.0:4730"
how to export metrics to Prometheus:
http://localhost:3000/metrics
how to list all workers ?
http://localhost:3000/workers
how to list workers by "cando" ?
http://localhost:3000/workers/<function>
how to list all jobs ?
http://localhost:3000/jobs
how to query job status ?
http://localhost:3000/jobs/<jobhandle>
how to change monitor address ?
./gearhulk server --verbose --web-addr=:4567
// Limit number of concurrent jobs execution.
// Use worker.Unlimited (0) if you want no limitation.
w := worker.New(worker.OneByOne)
w.ErrorHandler = func(e error) {
log.Println(e)
}
w.AddServer("tcp4", "127.0.0.1:4730")
// Use worker.Unlimited (0) if you want no timeout
w.AddFunc("ToUpper", ToUpper, worker.Unlimited)
// This will give a timeout of 5 seconds
w.AddFunc("ToUpperTimeOut5", ToUpper, 5)
if err := w.Ready(); err != nil {
log.Fatal(err)
return
}
go w.Work()c, err := client.New("tcp4", "127.0.0.1:4730")
defer c.Close()
//error handling
c.ErrorHandler = func(e error) {
log.Println(e)
}
echo := []byte("Hello\x00 world")
echomsg, err := c.Echo(echo)
log.Println(string(echomsg))
jobHandler := func(resp *client.Response) {
log.Printf("%s", resp.Data)
}
handle, err := c.Do("ToUpper", echo, runtime.JobNormal, jobHandler)Package gearadmin provides simple bindings to the gearman admin protocol: http://gearman.org/protocol/. Here's an example program that outputs the status of all worker queues in gearman:
c, err := net.Dial("tcp", "localhost:4730")
if err != nil {
panic(err)
}
defer c.Close()
admin := gearadmin.NewGearmanAdmin(c)
status, _ := admin.Status()
fmt.Printf("%#v\n", status)go build- Forked from https://github.com/appscode/gw
- Client and Worker package forked from https://github.com/mikespook/gearman-go
- Server package forked from https://github.com/ngaut/gearmand
- Gearadmin client forked from https://github.com/Clever/gearadmin
- Gearman project (http://gearman.org/protocol/)
Apache 2.0. See LICENSE.
- Copyright (C) 2024 Dave Rawks dave@rawks.io
- Copyright (C) 2016-2017 by AppsCode Inc.
- Copyright (C) 2016 by Clever.com (portions of gearadmin client)
- Copyright (c) 2014 ngaut (portions of gearmand)
- Copyright (C) 2011 by Xing Xing (portions of client and worker)