README
¶
yab 
======
yab (Yet Another Benchmarker) is tool to benchmark YARPC services. It currently
supports making Thrift requests to both HTTP and TChannel services.
NOTE: HTTP support is not cross-compatible with Apache Thrift yet, due to missing message envelope support.
yab is currently in alpha status.
Installing
If you have go installed, simply run the following to install the latest version:
go get -u -f github.com/yarpc/yab
This will install yab to $GOPATH/bin/yab.
Usage
Usage:
yab [<service> <method> <body>] [OPTIONS]
Request Options:
-t, --thrift= Path of the .thrift file
-m, --method= The full Thrift method name (Svc::Method) to invoke
-r, --request= The request body, in JSON format
-f, --file= Path of a file containing the request body in JSON
Transport Options:
-s, --service= The TChannel/Hyperbahn service name
-p, --peer= The host:port of the service to call
-P, --peer-list= Path of a JSON file containing a list of host:ports
Benchmark Options:
-n, --maxRequests= The maximum number of requests to make (default: 1000000)
-d, --maxDuration= The maximum amount of time to run the benchmark for (default: 0s)
--cpus= The number of OS threads
--connections= The number of TCP connections to use
--concurrency= The number of concurrent calls per connection (default: 1)
--rps= Limit on the number of requests per second. The default (0) is no limit. (default: 0)
--statsd= Optional host:port of a StatsD server to report metrics
Help Options:
-h, --help Show this help message
Making a single request
The following examples assume that the Thrift service running looks like:
service KeyValue {
string get(1: string key)
}
If a TChannel service was running with name keyvalue on localhost:12345, you can
make a call to the get method by running:
yab -t ~/keyvalue.thrift -p localhost:12345 keyvalue KeyValue::get -r '{"key": "hello"}'
This specifies a single host:port using -p, but you can also specify multiple peers
by passing the -p flag multiple times:
yab -t ~/keyvalue.thrift -p localhost:12345 -p localhost:12346 keyvalue KeyValue::get -r '{"key": "hello"}'
If you have a file containing a list of host:ports (either JSON or new line separated), you can
specify the file using -P:
yab -t ~/keyvalue.thrift -P ~/hosts.json keyvalue KeyValue::get -r '{"key": "hello"}'
yab also supports HTTP, instead of the peer being a single host:port, you would use a URL:
yab -t ~/keyvalue.thrift -p "http://localhost:8080/rpc" keyvalue KeyValue::get -r '{"key": "hello"}'
Benchmarking
To benchmark an endpoint, you need all the command line arguments to describe the request,
followed by benchmarking options. You need to set at least --maxDuration (or -d) to
set the maximum amount of time to run the benchmark.
You can set values such as 3s for 3 seconds, or 1m for 1 minute. Valid time units are:
msfor millisecondssfor secondsmfor minutes.
You can also control rate limit the benchmark (--rps), or customize the number of
connections (--connections) or control the amount of concurrent calls per
connection (--concurrency).
yab -t ~/keyvalue.thrift -p localhost:12345 keyvalue KeyValue::get -r '{"key": "hello"}' -d 5s --rps 100 --connections 4
Documentation
¶
There is no documentation for this package.
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
Package sorted contains sort related utilities.
|
Package sorted contains sort related utilities. |
|
Package thrift contains functionality for converting generic data structures to and from Thrift payloads.
|
Package thrift contains functionality for converting generic data structures to and from Thrift payloads. |