yab/man/yab.1 at dev · zmt/yab

487 lines (482 loc) · 10.1 KB
.TH yab 1 "5 September 2019"
yab \- yet another benchmarker
.SH SYNOPSIS
\fByab\fP [<service> <method> <body>] [OPTIONS]
.SH DESCRIPTION
yab is a benchmarking tool for TChannel and HTTP applications. It's primarily intended for Thrift applications but supports other encodings like JSON and binary (raw). It can be used in a curl-like fashion when benchmarking features are disabled.
yab includes a full man page (man yab), which is also available online: http://yarpc.github.io/yab/man.html
Default options can be specified in a ~/.config/yab/defaults.ini file (or ~/Library/Preferences/yab/defaults.ini on Mac) with contents similar to this:
timeout = 2s
[transport]
peer-list = "/path/to/peer/list.json"
[benchmark]
warmup = 10
.SH OPTIONS
.SS Application Options
\fB\fB\-v\fR\fP
Enable more detailed logging. Repeats increase the verbosity, ie. -vvv
\fB\fB\-\-version\fR\fP
Displays the application version
.SS Request Options
Configures the request data and the encoding.
To make Thrift requests, specify a Thrift file and pass the Thrift
service and procedure to the method argument (-m or --method) as
Service::Method.
$ yab -p localhost:9787 kv -t kv.thrift -m KeyValue::Count -r '{}'
You can also use positional arguments to specify the method and body:
$ yab -p localhost:9787 -t kv.thrift kv KeyValue::Count '{}'
The TChannel health endpoint can be hit without specifying a Thrift file
by passing --health.
Thrift requests can be specified as JSON or YAML. For example, for a method
defined as:
void addUser(1: string name, 2: i32 age)
You can pass the request as JSON: {"name": "Prashant", age: 100}
or as YAML:
name: Prashant
The request body can be specified on the command line using -r or --request:
$ yab -p localhost:9787 -t kv.thrift kv \\
    KeyValue::Get -r '{"key": "hello"}'
Or it can be loaded from a file using -f or --file:
$ yab -p localhost:9787 -t kv.thrift kv KeyValue::Get --file req.yaml
To make a proto requrest, specify a compiled FileDescriptorSet and pass the
fully qualified service an method name as procedure.
$ yab -p localhost:5435 --file-descriptor-set-bin proto.bin \\
    service package.Service/Method -r '{"key": "value"}'
A FileDescriptorSet can be generated using the --descriptor_set_out= flag
Request options can also be specified in a YAML file, e.g., get.yab:
service: kv
peer: localhost:9787
method: KeyValue::get
thrift: kv.thrift
  key: hello
The above YAML file represents the same request as the command above, and can
be run using yab -y get.yab.
You can make the request by directly executing the file (./get.yab) if you
add a shebang and mark the file as executable:
#!/usr/bin/env yab
service: kv
peer: localhost:9787
method: KeyValue::get
thrift: kv.thrift
  key: hello
YAML templates can use arguments using ${ARGNAME:default_value} in the body,
which can be specified on the command line using -A. If an argument is not
specified on the command line, then the default value is used. For example,
we can update the YAML template to take an argument for the key:
#!/usr/bin/env yab
service: kv
peer: localhost:9787
method: KeyValue::get
thrift: kv.thrift
  key: ${key:hello}
If no key is specified on the command line, the default value of "hello" is
used as the key. However we can specify the key on the command line:
$ ./get.yab -A key:world
A YAML template may have multiple keys and multiple keys can be specified on
the command line:
$ ./set.yab -A key:hello -A value:world
Binary data can be specified in one of many ways:
As a string or an array of bytes: "data" or [100, 97, 116, 97]
As base64: {"base64": "ZGF0YQ=="}
Loaded from a file: {"file": "data.bin"}
$ yab -p localhost:9787 -t kv.thrift kv -m KeyValue::Set \\
    -r '{"key": "hello", "value": [100, 97, 116, 97]}'
$ yab -p localhost:9787 -t kv.thrift kv KeyValue::Set \\
    -r '{"key": "hello", "value": {"file": "data.bin"}}'
\fB\fB\-e\fR, \fB\-\-encoding\fR\fP
The encoding of the data, options are: Thrift, proto, JSON, raw. Defaults to Thrift if the method contains '::' or a Thrift file is specified. Defaults to proto if the method contains '/' or a proto filedescriptorset is specified
\fB\fB\-t\fR, \fB\-\-thrift\fR\fP
Path of the .thrift file
\fB\fB\-F\fR, \fB\-\-file-descriptor-set-bin\fR\fP
A binary file containing a compiled protobuf FileDescriptorSet.
\fB\fB\-\-procedure\fR\fP
The full method name to invoke (Thrift: Svc::Method, Proto: package.Service/Method).
\fB\fB\-m\fR, \fB\-\-method\fR\fP
Alias for procedure
\fB\fB\-r\fR, \fB\-\-request\fR\fP
The request body, in JSON or YAML format
\fB\fB\-f\fR, \fB\-\-file\fR\fP
Path of a file containing the request body in JSON or YAML
\fB\fB\-H\fR, \fB\-\-header\fR\fP
Individual application header as a key:value pair per flag
\fB\fB\-\-headers\fR\fP
The headers in JSON or YAML format
\fB\fB\-\-headers-file\fR\fP
Path of a file containing the headers in JSON or YAML
\fB\fB\-B\fR, \fB\-\-baggage\fR\fP
Individual context baggage header as a key:value pair per flag
\fB\fB\-\-health\fR\fP
Hit the health endpoint, Meta::health
\fB\fB\-\-timeout\fR\fP
The timeout for each request. E.g., 100ms, 0.5s, 1s. If no unit is specified, milliseconds are assumed.
\fB\fB\-y\fR, \fB\-\-yaml-template\fR\fP
Send a tchannel request specified by a YAML template
\fB\fB\-A\fR, \fB\-\-arg\fR\fP
A list of key-value template arguments, specified as -A foo:bar -A user:me
\fB\fB\-\-disable-thrift-envelope\fR\fP
Disables Thrift envelopes (disabled by default for TChannel and gRPC)
\fB\fB\-\-multiplexed-thrift\fR\fP
Enables the Thrift TMultiplexedProtocol used by services that host multiple Thrift services on a single endpoint.
.SS Transport Options
Configures the network transport used to make requests.
yab can target both TChannel and HTTP endpoints. To specify a TChannel endpoint,
specify the peer's host and port:
$ yab -p localhost:9787 [options]
$ yab -p tchannel://localhost:9787 [options]
For HTTP endpoints, specify the URL as the peer,
$ yab -p http://localhost:8080/thrift [options]
The Thrift-encoded body will be POSTed to the specified URL.
Multiple peers can be specified using a peer list using -P or --peer-list.
When making a single request, a single peer from this list is selected randomly.
When benchmarking, connections will be established in a round-robin fashion,
starting with a random peer.
$ yab --peer-list hosts.json [options]
\fB\fB\-s\fR, \fB\-\-service\fR\fP
The TChannel/Hyperbahn service name
\fB\fB\-p\fR, \fB\-\-peer\fR\fP
The host:port of the service to call
\fB\fB\-P\fR, \fB\-\-peer-list\fR\fP
Path or URL of a JSON, YAML, or flat file containing a list of host:ports. -P? for supported protocols.
\fB\fB\-\-caller\fR\fP
Caller will override the default caller name (which is yab-$USER).
\fB\fB\-\-rk\fR\fP
The routing key overrides the service name traffic group for proxies.
\fB\fB\-\-rd\fR\fP
The routing delegate overrides the routing key traffic group for proxies.
\fB\fB\-\-sk\fR\fP
The shard key is a transport header that clues where to send a request within a clustered traffic group.
\fB\fB\-\-jaeger\fR\fP
Use the Jaeger tracing client to send Uber style traces and baggage headers
\fB\fB\-T\fR, \fB\-\-topt\fR\fP
Transport options for TChannel, protocol headers for HTTP
\fB\fB\-\-http-method\fR\fP
The HTTP method to use
.SS Benchmark Options
Configures benchmarking, which is disabled by default.
By default, yab will only make a single request. To enable benchmarking,
specify the maximum duration for the benchmark by passing -d or --max-duration.
yab will make requests until either the maximum requests (-n or --max-requests)
or the maximum duration is reached.
You can control the rate at which yab makes requests using the --rps flag.
An example benchmark command might be:
$ yab -p localhost:9787 moe --health -n 100000 -d 10s --rps 1000
This would make requests at 1000 RPS until either the maximum number of
requests (100,000) or the maximum duration (10 seconds) is reached.
By default, yab will create multiple connections (defaulting to the number of
CPUs on the machine), but will only have one concurrent call per connection.
The number of connections and concurrent calls per connection can be controlled
using --connections and --concurrency.
\fB\fB\-n\fR, \fB\-\-max-requests\fR <default: \fI"0"\fR>\fP
The maximum number of requests to make. 0 implies no limit.
\fB\fB\-d\fR, \fB\-\-max-duration\fR <default: \fI"0s"\fR>\fP
The maximum amount of time to run the benchmark for. 0 implies no duration limit.
\fB\fB\-\-cpus\fR\fP
The number of OS threads
\fB\fB\-\-connections\fR\fP
The number of TCP connections to use
\fB\fB\-\-warmup\fR <default: \fI"10"\fR>\fP
The number of requests to make to warmup each connection
\fB\fB\-\-concurrency\fR <default: \fI"1"\fR>\fP
The number of concurrent calls per connection
\fB\fB\-\-rps\fR <default: \fI"0"\fR>\fP
Limit on the number of requests per second. The default (0) is no limit.
\fB\fB\-\-statsd\fR\fP
Optional host:port of a StatsD server to report metrics
\fB\fB\-\-per-peer-stats\fR\fP
Whether to emit stats by peer rather than aggregated
.SS Help Options
\fB\fB\-h\fR, \fB\-\-help\fR\fP
Show this help message
Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

yab.1

Latest commit

History

yab.1

File metadata and controls
