diff --git a/doc/h2load.1 b/doc/h2load.1 index 0618a081..4d46d085 100644 --- a/doc/h2load.1 +++ b/doc/h2load.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "H2LOAD" "1" "January 29, 2015" "0.7.4-DEV" "nghttp2" +.TH "H2LOAD" "1" "February 01, 2015" "0.7.4-DEV" "nghttp2" .SH NAME h2load \- HTTP/2 benchmarking tool . @@ -131,6 +131,77 @@ Display version information and exit. .B \-h, \-\-help Display this help and exit. .UNINDENT +.SH OUTPUT +.INDENT 0.0 +.TP +.B requests +.INDENT 7.0 +.TP +.B total +The number of requests h2load was instructed to make. +.TP +.B started +The number of requests h2load has started. +.TP +.B done +The number of requests completed. +.TP +.B succeeded +The number of requests completed successfully. Only HTTP status +code 2xx or3xx are considered as success. +.TP +.B failed +The number of requests failed, including HTTP level failures +(non\-successful HTTP status code). +.TP +.B errored +The number of requests failed, except for HTTP level failures. +status code. This is the subset of the number reported in +\fBfailed\fP and most likely the network level failures or stream +was reset by RST_STREAM. +.UNINDENT +.TP +.B status codes +The number of status code h2load received. +.TP +.B traffic +.INDENT 7.0 +.TP +.B total +The number of bytes received from the server "on the wire". If +requests were made via TLS, this value is the number of decrpyted +bytes. +.TP +.B headers +The number of response header bytes from the server without +decompression. For HTTP/2, this is the sum of the payload of +HEADERS frame. For SPDY, this is the sum of the payload of +SYN_REPLY frame. +.TP +.B data +The number of response body bytes received from the server. +.UNINDENT +.TP +.B time for request +.INDENT 7.0 +.TP +.B min +The minimum time taken for request and response. +.TP +.B max +The maximum time taken for request and response. +.TP +.B mean +The mean time taken for request and response. +.TP +.B sd +The standard deviation of the time for request and response. +.TP +.B +/\- sd +The fraction of the number of requests within standard deviation +range (mean +/\- sd) against total number of successful requests. +.UNINDENT +.UNINDENT .SH SEE ALSO .sp \fInghttp(1)\fP, \fInghttpd(1)\fP, \fInghttpx(1)\fP diff --git a/doc/h2load.1.rst b/doc/h2load.1.rst index ac447ebe..39eb1f47 100644 --- a/doc/h2load.1.rst +++ b/doc/h2load.1.rst @@ -96,6 +96,57 @@ OPTIONS: Display this help and exit. +OUTPUT +------ + +requests + total + The number of requests h2load was instructed to make. + started + The number of requests h2load has started. + done + The number of requests completed. + succeeded + The number of requests completed successfully. Only HTTP status + code 2xx or3xx are considered as success. + failed + The number of requests failed, including HTTP level failures + (non-successful HTTP status code). + errored + The number of requests failed, except for HTTP level failures. + status code. This is the subset of the number reported in + ``failed`` and most likely the network level failures or stream + was reset by RST_STREAM. + +status codes + The number of status code h2load received. + +traffic + total + The number of bytes received from the server "on the wire". If + requests were made via TLS, this value is the number of decrpyted + bytes. + headers + The number of response header bytes from the server without + decompression. For HTTP/2, this is the sum of the payload of + HEADERS frame. For SPDY, this is the sum of the payload of + SYN_REPLY frame. + data + The number of response body bytes received from the server. + +time for request + min + The minimum time taken for request and response. + max + The maximum time taken for request and response. + mean + The mean time taken for request and response. + sd + The standard deviation of the time for request and response. + +/- sd + The fraction of the number of requests within standard deviation + range (mean +/- sd) against total number of successful requests. + SEE ALSO -------- diff --git a/doc/nghttp.1 b/doc/nghttp.1 index c332bace..1efdcd69 100644 --- a/doc/nghttp.1 +++ b/doc/nghttp.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NGHTTP" "1" "January 29, 2015" "0.7.4-DEV" "nghttp2" +.TH "NGHTTP" "1" "February 01, 2015" "0.7.4-DEV" "nghttp2" .SH NAME nghttp \- HTTP/2 experimental client . diff --git a/doc/nghttpd.1 b/doc/nghttpd.1 index 3fb6b259..bf22985d 100644 --- a/doc/nghttpd.1 +++ b/doc/nghttpd.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NGHTTPD" "1" "January 29, 2015" "0.7.4-DEV" "nghttp2" +.TH "NGHTTPD" "1" "February 01, 2015" "0.7.4-DEV" "nghttp2" .SH NAME nghttpd \- HTTP/2 experimental server . diff --git a/doc/nghttpx.1 b/doc/nghttpx.1 index fc75063c..39b560ed 100644 --- a/doc/nghttpx.1 +++ b/doc/nghttpx.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH "NGHTTPX" "1" "January 29, 2015" "0.7.4-DEV" "nghttp2" +.TH "NGHTTPX" "1" "February 01, 2015" "0.7.4-DEV" "nghttp2" .SH NAME nghttpx \- HTTP/2 experimental proxy .