client

Documentation

Index

• Variables
• func Parse(p string, cp *CliPayload) error
• func Run(args []string)
• func RunWithOptions(runOpts *Options) error
• type C
• type CliPayload
  • func (c *CliPayload) Bind(k string, value interface{}, msg *client.Message) error
  • func (c *CliPayload) Iterator(pair common.Pair) error
  • func (c *CliPayload) Pair(key string, value interface{}) error
  • func (c *CliPayload) SetBatch(msg *client.Message)
• type Options
  • func (o *Options) Hosts() []*client.Host
  • func (o *Options) Init()
  • func (o *Options) Payloads() ([]*CliPayload, error)
  • func (o *Options) Validate() error
• type RepeatSet
• type Report
• type WPRun
• type WorkerPayload

Variables

var CustomMakerRegistry *customMakerRegistry = new(customMakerRegistry)

Use CustomMakerRegistry with --maker to use a specific entity for Response.Data.

Functions

func Parse

func Parse(p string, cp *CliPayload) error

Parse expects the following format: "<input name>:[<type>|]<CSV values>[;<input name>:...]". If type is not provided, then it will be string; otherwise, "int" and "float32" can be used.

func Run

func Run(args []string)

func RunWithOptions

func RunWithOptions(runOpts *Options) error

Types

type C

type C uint8

const (
	None C = iota
	Single
	Batch
)

type CliPayload

type CliPayload struct {
	Data  map[string]interface{}
	Batch int
}

func (*CliPayload) Bind

func (c *CliPayload) Bind(k string, value interface{}, msg *client.Message) error

Bind delegates types to appropriate client.Message method.

func (*CliPayload) Iterator

func (c *CliPayload) Iterator(pair common.Pair) error

func (*CliPayload) Pair

func (c *CliPayload) Pair(key string, value interface{}) error

func (*CliPayload) SetBatch

func (c *CliPayload) SetBatch(msg *client.Message)

type Options

type Options struct {
	Host    string `long:"host" description:"endpoint host"`
	Port    int    `short:"p" long:"port" description:"endpoint port"`
	Address string `long:"address" description:"address overrides host and port"`

	Debug     bool `long:"debug"`
	TimeoutUs int  `short:"t" long:"timeout"`

	Model       string `short:"m" long:"model" description:"model"`
	Storable    string `short:"s" long:"storable"`
	CustomMaker string `long:"maker" description:"non-storable Response.Data, requires binding with CustomMaker"`

	CacheMB     int  `long:"cache"`
	NoHashCheck bool `long:"nohash"`

	Workers    int `long:"workers"`
	Concurrent int `long:"concurrent"`
	// In the case Workers > 1, Repeats is the total number of times each payload
	// is run, not the number of times each workers sends the paylod.
	Repeats int `long:"repeats" description:"times to repeat all payloads"`

	PayloadStr   []string `short:"a" long:"payload"`
	PayloadPause int      `long:"pause" description:"pause seconds between payloads"`
	PayloadDelay int      `long:"delay" description:"pause seconds from first payload"`

	SkipError bool `long:"skiperrs"`

	NoOutput     bool `long:"noout"`
	Metrics      bool `long:"metrics"`
	ErrorHistory bool `long:"errhist"`

	// Report forces NoOutput and SkipError true, Metrics and ErrorHistory false.
	// Will generate a final JSON object as its only output to stdout.
	// stderr may have other output if Debug is true or there are other errors.
	Report bool `long:"report"`
}

func (*Options) Hosts

func (o *Options) Hosts() []*client.Host

func (*Options) Init

func (o *Options) Init()

func (*Options) Payloads

func (o *Options) Payloads() ([]*CliPayload, error)

func (*Options) Validate

func (o *Options) Validate() error

type RepeatSet

type RepeatSet struct {
	Num       int
	WPayloads []WorkerPayload
}

type Report

type Report struct {
	Start time.Time
	End   time.Time

	Runs    []RepeatSet
	Metrics []gmetric.Operation
}

type WPRun

type WPRun struct {
	Response *client.Response
	Err      error
}

type WorkerPayload

type WorkerPayload struct {
	Payload *CliPayload
	Worker  int

	Runs []WPRun
}