cli

Documentation

Index

• Constants
• Variables
• type BuryCommand
  • func (c *BuryCommand) Bury() error
  • func (c *BuryCommand) Execute(args []string) error
• type Command
  • func (c *Command) GetStatsForTube(tube string) (*TubeStats, error)
  • func (c *Command) Init() error
  • func (c *Command) PrintJob(id uint64, body []byte) error
• type DeleteCommand
  • func (c *DeleteCommand) Delete() error
  • func (c *DeleteCommand) Execute(args []string) error
• type KickCommand
  • func (c *KickCommand) Execute(args []string) error
  • func (c *KickCommand) Kick() error
• type PeekCommand
  • func (c *PeekCommand) Execute(args []string) error
  • func (c *PeekCommand) Peek() error
• type PutCommand
  • func (c *PutCommand) Execute(args []string) error
  • func (c *PutCommand) Put() error
• type StatsCommand
  • func (c *StatsCommand) Execute(args []string) error
  • func (c *StatsCommand) GetStats() (map[string]*TubeStats, error)
  • func (c *StatsCommand) PrintStats() error
• type TailCommand
  • func (c *TailCommand) Execute(args []string) error
  • func (c *TailCommand) Tail() error
• type TubeStats

Constants

const (
	HighSeverity = iota
	NormalSeverity
	LowSeverity
	DefaultTube = "default"
)

Variables

var HighSeverityStyle = gocolorize.NewColor("white:red")

var InfoStyle = gocolorize.NewColor("yellow")

var NormalSeverityStyle = gocolorize.NewColor("green")

var TitleStyle = gocolorize.NewColor("green")

var TooManyErrorsError = errors.New("Too many errors")

var TubeStatsRetrievalError = errors.New("Unable to retrieve tube stats")

Types

type BuryCommand

type BuryCommand struct {
	Tube string `short:"t" long:"tube" description:"tube to bury jobs in." required:"true"`
	Num  int    `short:"" long:"num" description:"number of jobs to bury."`
	Command
}

func (*BuryCommand) Bury

func (c *BuryCommand) Bury() error

func (*BuryCommand) Execute

func (c *BuryCommand) Execute(args []string) error

type Command

type Command struct {
	Host string `short:"h" long:"host" description:"beanstalkd host addr." required:"true" default:"localhost:11300"`
	// contains filtered or unexported fields
}

func (*Command) GetStatsForTube

func (c *Command) GetStatsForTube(tube string) (*TubeStats, error)

func (*Command) Init

func (c *Command) Init() error

func (*Command) PrintJob

func (c *Command) PrintJob(id uint64, body []byte) error

type DeleteCommand

type DeleteCommand struct {
	Tube  string `short:"t" long:"tube" description:"tube to be delete." required:"true"`
	State string `short:"" long:"state" description:"peek from 'buried', 'ready' or 'delayed' queues." default:"buried"`
	Print bool   `short:"" long:"print" description:"prints the jobs after delete it."`
	Empty bool   `short:"" long:"empty" description:"delete all jobs with the given status in the given tube."`
	Command
}

func (*DeleteCommand) Delete

func (c *DeleteCommand) Delete() error

func (*DeleteCommand) Execute

func (c *DeleteCommand) Execute(args []string) error

type KickCommand

type KickCommand struct {
	Tube string `short:"t" long:"tube" description:"tube to kick jobs in." required:"true"`
	Num  int    `short:"" long:"num" description:"number of jobs to kick."`
	Command
}

func (*KickCommand) Execute

func (c *KickCommand) Execute(args []string) error

func (*KickCommand) Kick

func (c *KickCommand) Kick() error

type PeekCommand

type PeekCommand struct {
	Tube  string `short:"t" long:"tube" description:"tube to be tailed." required:"true"`
	State string `short:"" long:"state" description:"peek from 'buried', 'ready' or 'delayed' queues." default:"buried"`
	Command
}

func (*PeekCommand) Execute

func (c *PeekCommand) Execute(args []string) error

func (*PeekCommand) Peek

func (c *PeekCommand) Peek() error

type PutCommand

type PutCommand struct {
	Tube     string        `short:"t" long:"tube" description:"tube to be tailed." required:"true"`
	Body     string        `short:"b" long:"body" description:"plain text data for the job." required:"true"`
	Priority uint32        `short:"" long:"priority" description:"priority for the job." default:"1024"`
	Delay    time.Duration `short:"" long:"delay" description:"delay for the job." default:"0"`
	TTR      time.Duration `short:"" long:"ttr" description:"TTR for the job." default:"60s"`

	Command
}

func (*PutCommand) Execute

func (c *PutCommand) Execute(args []string) error

func (*PutCommand) Put

func (c *PutCommand) Put() error

type StatsCommand

type StatsCommand struct {
	Tubes string `short:"t" long:"tubes" description:"tubes to be listed (separated by ,). By default all are listed"`

	Command
}

func (*StatsCommand) Execute

func (c *StatsCommand) Execute(args []string) error

func (*StatsCommand) GetStats

func (c *StatsCommand) GetStats() (map[string]*TubeStats, error)

func (*StatsCommand) PrintStats

func (c *StatsCommand) PrintStats() error

type TailCommand

type TailCommand struct {
	Tube   string `short:"t" long:"tube" description:"tube to be tailed." required:"true"`
	Action string `short:"" long:"action" description:"action to perform after reserver the job. (release, bury, delete)" default:"release"`

	Command
}

func (*TailCommand) Execute

func (c *TailCommand) Execute(args []string) error

func (*TailCommand) Tail

func (c *TailCommand) Tail() error

type TubeStats

type TubeStats struct {
	JobsBuried   int
	JobsDelayed  int
	JobsReady    int
	JobsReserved int
	JobsUrgent   int
	Waiting      int
	TotalJobs    int
}