Usage

  1. usage: ghz [<flags>] [<host>]
  3. Flags:
  4.   -h, --help                     Show context-sensitive help (also try --help-long and --help-man).
  5.       --config=                  Path to the JSON or TOML config file that specifies all the test run settings.
  6.       --proto=                   The Protocol Buffer .proto file.
  7.       --protoset=                The compiled protoset file. Alternative to proto. -proto takes precedence.
  8.       --call=                    A fully-qualified method name in 'package.Service/method' or 'package.Service.Method' format.
  9.   -i, --import-paths=            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.
  10.       --cacert=                  File containing trusted root certificates for verifying the server.
  11.       --cert=                    File containing client certificate (public key), to present to the server. Must also provide -key option.
  12.       --key=                     File containing client private key, to present to the server. Must also provide -cert option.
  13.       --cname=                   Server name override when validating TLS certificate - useful for self signed certs.
  14.       --skipTLS                  Skip TLS client verification of the server's certificate chain and host name.
  15.       --insecure                 Use plaintext and insecure connection.
  16.       --authority=               Value to be used as the :authority pseudo-header. Only works if -insecure is used.
  17.       --async                    Make requests asynchronous as soon as possible. Does not wait for request to finish before sending next one.
  18.   -r, --rps=0                    Requests per second (RPS) rate limit for constant load schedule. Default is no rate limit.
  19.       --load-schedule="const"    Specifies the load schedule. Options are const, step, or line. Default is const.
  20.       --load-start=0             Specifies the RPS load start value for step or line schedules.
  21.       --load-step=0              Specifies the load step value or slope value.
  22.       --load-end=0               Specifies the load end value for step or line load schedules.
  23.       --load-step-duration=0     Specifies the load step duration value for step load schedule.
  24.       --load-max-duration=0      Specifies the max load duration value for step or line load schedule.
  25.   -c, --concurrency=50           Number of request workers to run concurrently for const concurrency schedule. Default is 50.
  26.       --concurrency-schedule="const"
  27.                                  Concurrency change schedule. Options are const, step, or line. Default is const.
  28.       --concurrency-start=0      Concurrency start value for step and line concurrency schedules.
  29.       --concurrency-end=0        Concurrency end value for step and line concurrency schedules.
  30.       --concurrency-step=1       Concurrency step / slope value for step and line concurrency schedules.
  31.       --concurrency-step-duration=0
  32.                                  Specifies the concurrency step duration value for step concurrency schedule.
  33.       --concurrency-max-duration=0
  34.                                  Specifies the max concurrency adjustment duration value for step or line concurrency schedule.
  35.   -n, --total=200                Number of requests to run. Default is 200.
  36.   -t, --timeout=20s              Timeout for each request. Default is 20s, use 0 for infinite.
  37.   -z, --duration=0               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.
  38.   -x, --max-duration=0           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.
  39.       --duration-stop="close"    Specifies how duration stop is reported. Options are close, wait or ignore. Default is close.
  40.   -d, --data=                    The call data as stringified JSON. If the value is '@' then the request contents are read from stdin.
  41.   -D, --data-file=               File path for call data JSON file. Examples: /home/user/file.json or ./file.json.
  42.   -b, --binary                   The call data comes as serialized binary message or multiple count-prefixed messages read from stdin.
  43.   -B, --binary-file=             File path for the call data as serialized binary message or multiple count-prefixed messages.
  44.   -m, --metadata=                Request metadata as stringified JSON.
  45.   -M, --metadata-file=           File path for call metadata JSON file. Examples: /home/user/metadata.json or ./metadata.json.
  46.       --stream-interval=0        Interval for stream requests between message sends.
  47.       --stream-call-duration=0   Duration after which client will close the stream in each streaming call.
  48.       --stream-call-count=0      Count of messages sent, after which client will close the stream in each streaming call.
  49.       --stream-dynamic-messages  In streaming calls, regenerate and apply call template data on every message send.
  50.       --reflect-metadata=        Reflect metadata as stringified JSON used only for reflection request.
  51.   -o, --output=                  Output path. If none provided stdout is used.
  52.   -O, --format=                  Output format. One of: summary, csv, json, pretty, html, influx-summary, influx-details. Default is summary.
  53.       --skipFirst=0              Skip the first X requests when doing the results tally.
  54.       --count-errors             Count erroneous (non-OK) resoponses in stats calculations.
  55.       --connections=1            Number of connections to use. Concurrency is distributed evenly among all the connections. Default is 1.
  56.       --connect-timeout=10s      Connection timeout for the initial connection dial. Default is 10s.
  57.       --keepalive=0              Keepalive time duration. Only used if present and above 0.
  58.       --name=                    User specified name for the test.
  59.       --tags=                    JSON representation of user-defined string tags.
  60.       --cpus=12                  Number of cpu cores to use.
  61.       --debug=                   The path to debug log file.
  62.   -e, --enable-compression       Enable Gzip compression on requests.
  63.   -v, --version                  Show application version.
  65. Args:
  66.   [<host>]  Host and port to test.