doc/h2load.1.rst

   1
   2 h2load(1)
   3 =========
   4
   5 SYNOPSIS
   6 --------
   7
   8 **h2load** [OPTIONS]... [URI]...
   9
  10 DESCRIPTION
  11 -----------
  12
  13 benchmarking tool for HTTP/2 and SPDY server
  14
  15 .. describe:: <URI>
  16
  17     Specify URI to access.   Multiple URIs can be specified.
  18     URIs are used  in this order for each  client.  All URIs
  19     are used, then  first URI is used and then  2nd URI, and
  20     so  on.  The  scheme, host  and port  in the  subsequent
  21     URIs, if present,  are ignored.  Those in  the first URI
  22     are used solely.
  23
  24 OPTIONS
  25 -------
  26
  27 .. option:: -n, --requests=<N>
  28
  29     Number of requests.
  30
  31     Default: ``1``
  32
  33 .. option:: -c, --clients=<N>
  34
  35     Number of concurrent clients.
  36
  37     Default: ``1``
  38
  39 .. option:: -t, --threads=<N>
  40
  41     Number of native threads.
  42
  43     Default: ``1``
  44
  45 .. option:: -i, --input-file=<FILE>
  46
  47     Path of a file with multiple URIs are seperated by EOLs.
  48     This option will disable URIs getting from command-line.
  49     If '-' is given as <FILE>, URIs will be read from stdin.
  50     URIs are used  in this order for each  client.  All URIs
  51     are used, then  first URI is used and then  2nd URI, and
  52     so  on.  The  scheme, host  and port  in the  subsequent
  53     URIs, if present,  are ignored.  Those in  the first URI
  54     are used solely.
  55
  56 .. option:: -m, --max-concurrent-streams=(auto|<N>)
  57
  58     Max concurrent streams to  issue per session.  If "auto"
  59     is given, the number of given URIs is used.
  60
  61     Default: ``auto``
  62
  63 .. option:: -w, --window-bits=<N>
  64
  65     Sets the stream level initial window size to (2\*\*<N>)-1.
  66     For SPDY, 2**<N> is used instead.
  67
  68 .. option:: -W, --connection-window-bits=<N>
  69
  70     Sets  the  connection  level   initial  window  size  to
  71     (2**<N>)-1.  For SPDY, if <N>  is strictly less than 16,
  72     this option  is ignored.   Otherwise 2\*\*<N> is  used for
  73     SPDY.
  74
  75 .. option:: -H, --header=<HEADER>
  76
  77     Add/Override a header to the requests.
  78
  79 .. option:: -p, --no-tls-proto=<PROTOID>
  80
  81     Specify ALPN identifier of the  protocol to be used when
  82     accessing http URI without SSL/TLS.
  83     Available protocols: spdy/2, spdy/3, spdy/3.1 and h2c-14
  84
  85     Default: ``h2c-14``
  86
  87 .. option:: -v, --verbose
  88
  89     Output debug information.
  90
  91 .. option:: --version
  92
  93     Display version information and exit.
  94
  95 .. option:: -h, --help
  96
  97     Display this help and exit.
  98
  99 OUTPUT
 100 ------
 101
 102 requests
 103   total
 104     The number of requests h2load was instructed to make.
 105   started
 106     The number of requests h2load has started.
 107   done
 108     The number of requests completed.
 109   succeeded
 110     The number of requests completed successfully.  Only HTTP status
 111     code 2xx or3xx are considered as success.
 112   failed
 113     The number of requests failed, including HTTP level failures
 114     (non-successful HTTP status code).
 115   errored
 116     The number of requests failed, except for HTTP level failures.
 117     status code.  This is the subset of the number reported in
 118     ``failed`` and most likely the network level failures or stream
 119     was reset by RST_STREAM.
 120
 121 status codes
 122   The number of status code h2load received.
 123
 124 traffic
 125   total
 126     The number of bytes received from the server "on the wire".  If
 127     requests were made via TLS, this value is the number of decrpyted
 128     bytes.
 129   headers
 130     The number of response header bytes from the server without
 131     decompression.  For HTTP/2, this is the sum of the payload of
 132     HEADERS frame.  For SPDY, this is the sum of the payload of
 133     SYN_REPLY frame.
 134   data
 135     The number of response body bytes received from the server.
 136
 137 time for request
 138   min
 139     The minimum time taken for request and response.
 140   max
 141     The maximum time taken for request and response.
 142   mean
 143     The mean time taken for request and response.
 144   sd
 145     The standard deviation of the time for request and response.
 146   +/- sd
 147     The fraction of the number of requests within standard deviation
 148     range (mean +/- sd) against total number of successful requests.
 149
 150 SEE ALSO
 151 --------
 152
 153 :manpage:`nghttp(1)`, :manpage:`nghttpd(1)`, :manpage:`nghttpx(1)`