Simple gRPC benchmarking and load testing tool inspired by hey and grpcurl.
All documentation at ghz.sh.
Usage: ghz [options...] host
Options:
-config Path to the JSON or TOML config file that specifies all the test run settings.
-proto The Protocol Buffer .proto file.
-protoset The compiled protoset file. Alternative to proto. -proto takes precedence.
-call A fully-qualified method name in 'package.Service/method' or 'package.Service.Method' format.
-i Comma separated list of proto import paths. The current working directory and the directory
of the protocol buffer file are automatically added to the import list.
-rmd Reflect metadata as stringified JSON used only for reflection request.
-cacert File containing trusted root certificates for verifying the server.
-cert File containing client certificate (public key), to present to the server. Must also provide -key option.
-key File containing client private key, to present to the server. Must also provide -cert option.
-cname Server name override when validating TLS certificate - useful for self signed certs.
-skipTLS Skip TLS client verification of the server's certificate chain and host name.
-insecure Use plaintext and insecure connection.
-authority Value to be used as the :authority pseudo-header. Only works if -insecure is used.
-c Number of requests to run concurrently.
Total number of requests cannot be smaller than the concurrency level. Default is 50.
-n Number of requests to run. Default is 200.
-q Rate limit, in queries per second (QPS). Default is no rate limit.
-t Timeout for each request in seconds. Default is 20, use 0 for infinite.
-z Duration of application to send requests. When duration is reached, application stops and exits.
If duration is specified, n is ignored. Examples: -z 10s -z 3m.
-x Maximum duration of application to send requests with n setting respected.
If duration is reached before n requests are completed, application stops and exits.
Examples: -x 10s -x 3m.
-d The call data as stringified JSON.
If the value is '@' then the request contents are read from stdin.
-D Path for call data JSON file. Examples: /home/user/file.json or ./file.json.
-b The call data comes as serialized binary message read from stdin.
-B Path for the call data as serialized binary message.
-m Request metadata as stringified JSON.
-M Path for call metadata JSON file. Examples: /home/user/metadata.json or ./metadata.json.
-si Stream interval duration. Spread stream sends by given amount.
Only applies to client and bidi streaming calls. Example: 100ms
-o Output path. If none provided stdout is used.
-O Output type. If none provided, a summary is printed.
"csv" outputs the response metrics in comma-separated values format.
"json" outputs the metrics report in JSON format.
"pretty" outputs the metrics report in pretty JSON format.
"html" outputs the metrics report as HTML.
"influx-summary" outputs the metrics summary as influxdb line protocol.
"influx-details" outputs the metrics details as influxdb line protocol.
-T Connection timeout in seconds for the initial connection dial. Default is 10.
-L Keepalive time in seconds. Only used if present and above 0.
-name User specified name for the test.
-tags JSON representation of user-defined string tags.
-cpus Number of used cpu cores.
-v Print the version.report, err := runner.Run(
"helloworld.Greeter.SayHello",
"localhost:50051",
runner.WithProtoFile("greeter.proto", []string{}),
runner.WithDataFromFile("data.json"),
runner.WithInsecure(true),
)
if err != nil {
fmt.Println(err.Error())
os.Exit(1)
}
printer := printer.ReportPrinter{
Out: os.Stdout,
Report: report,
}
printer.Print("pretty")Golang 1.11+ is required.
make # run all linters, tests, and produce code coverage
make lint # run all linters
make test # run tests
make cover # run tests and produce code coverage
V=1 make # more verbosity
OPEN_COVERAGE=1 make cover # open code coverage.html after running
Icon made by Freepik from www.flaticon.com is licensed by CC 3.0 BY
Apache-2.0