cmdstalk

command module
Version: v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 13, 2022 License: MIT Imports: 2 Imported by: 0

README

cmdstalk

Cmdstalk is a unix-process-based beanstalkd queue broker.

Written in Go, cmdstalk uses the kr/beanstalk library to interact with the beanstalkd queue daemon.

Each job is passed as stdin to a new instance of the configured worker command. On exit(0) the job is deleted. On exit(1) (or any non-zero status) the job is released with an exponential-backoff delay (releases^4), up to 10 times.

If the worker has not finished by the time the job TTR is reached, the worker is killed (SIGTERM, SIGKILL) and the job is allowed to time out. When the job is subsequently reserved, the timeouts: 1 will cause it to be buried.

In this way, job workers can be arbitrary commands, and queue semantics are reduced down to basic unix concepts of exit status and signals.

Install

From source:

# Make sure you have a sane $GOPATH
go install github.com/99designs/cmdstalk@latest

From binary:

https://github.com/99designs/cmdstalk/releases

Usage

cmdstalk -help
# Usage of ./cmdstalk:
#   -address="127.0.0.1:11300": beanstalkd TCP address.
#   -all=false: Listen to all tubes, instead of -tubes=...
#   -cmd="": Command to run in worker.
#   -per-tube=1: Number of workers per tube.
#   -tubes=[default]: Comma separated list of tubes.

# Watch three specific tubes.
cmdstalk -cmd="/path/to/your/worker --your=flags --here" -tubes="one,two,three"

# Watch all current and future tubes, four workers per tube.
cmdstalk -all -cmd="cat" -per-tube=4

Dev

# Run all tests, with minimal/buffered output.
go test ./...

# Run tests in the broker package with steaming output.
(cd broker && go test -v)

# Run cmdstalk from source.
go run cmdstalk.go -cmd='hexdump -C' -tubes="default,another"

# Build and run a binary.
go build
file cmdstalk # cmdstalk: Mach-O 64-bit executable x86_64

Release

# Set up cross-compiling tool.
go install github.com/mitchellh/gox@latest
gox -build-toolchain -os="darwin linux" -arch="amd64"

# Compile for various systems.
gox -os="darwin linux" -arch="amd64"
gzip cmdstalk_*_*

# Create a release.
open https://github.com/99designs/cmdstalk/releases/new

TODO

  • Graceful shutdown.
  • SIGKILL recalcitrant worker processes.
  • Logging improvements; stdout/stderr, concurrency-safety.
  • Interactive mode; single-concurrency, prompt for action for each job.

Created by Paul Annesley and Lachlan Donald.

© Copyright 2014 99designs Inc.

Documentation

Overview

Cmdstalk is a unix-process-based [beanstalkd][beanstalkd] queue broker.

Written in [Go][golang], cmdstalk uses the kr/beanstalk[beanstalk] library to interact with the [beanstalkd][beanstalkd] queue daemon.

Each job is passed as stdin to a new instance of the configured worker command. On `exit(0)` the job is deleted. On `exit(1)` (or any non-zero status) the job is released with an exponential-backoff delay (releases^4), up to 10 times.

If the worker has not finished by the time the job TTR is reached, the worker is killed (SIGTERM, SIGKILL) and the job is allowed to time out. When the job is subsequently reserved, the `timeouts: 1` will cause it to be buried.

In this way, job workers can be arbitrary commands, and queue semantics are reduced down to basic unix concepts of exit status and signals.

Source Files

Directories

Path Synopsis
Package broker reserves jobs from beanstalkd, spawns worker processes, and manages the interaction between the two.
Package broker reserves jobs from beanstalkd, spawns worker processes, and manages the interaction between the two.
Package bs provides a richer and/or more domain-specific layer over github.com/kr/beanstalk, including active-record style Job type.
Package bs provides a richer and/or more domain-specific layer over github.com/kr/beanstalk, including active-record style Job type.
Package cli provides command line support for cmdstalk.
Package cli provides command line support for cmdstalk.
Package cmd provides a more domain-specific layer over exec.Cmd.
Package cmd provides a more domain-specific layer over exec.Cmd.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL