documented --statsd-latency-window

satori-com · Sep 22, 2016 · b19f8b0 · b19f8b0
1 parent 90c95e1
commit b19f8b0
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 2 deletions.
diff --git a/doc/tcpkali.1 b/doc/tcpkali.1
@@ -1,8 +1,8 @@
 .\"t
-.\" Automatically generated by Pandoc 1.17.1
+.\" Automatically generated by Pandoc 1.17.2
 .\"
 .ad l
-.TH "tcpkali" "1" "2016\-08\-24" "TCPKali user manual" "Version 0.9"
+.TH "tcpkali" "1" "2016\-08\-24" "TCPKali user manual" "Version 0.9.x"
 .nh \" Turn off hyphenation by default.
 .SH NAME
 .PP
@@ -378,6 +378,16 @@ Metric namespace.
 Default is "tcpkali".
 .RS
 .RE
+.TP
+.B \-\-statsd\-latency\-window \f[I]Time\f[]
+By default latencies are measured across the entire duration of
+tcpkali\[aq]s run (as set by \f[B]\-\-duration\f[] or \f[B]\-T\f[]).
+This option instructs tcpkali to flush latency data to StatsD every
+\f[I]Time\f[] period and start measuring latencies anew.
+The latencies that are displayed in the user interface remain being
+collected across the whole run.
+.RS
+.RE
 .SH VARIABLE UNITS
 .PP
 tcpkali recognizes a number of suffixes for numeric values.

diff --git a/doc/tcpkali.man.md b/doc/tcpkali.man.md
@@ -231,6 +231,14 @@ and the time the latency marker is observed in the downstream traffic
 --statsd-namespace *string*
 :   Metric namespace. Default is "tcpkali".
 
+--statsd-latency-window *Time*
+:   By default latencies are measured across the entire duration of
+    tcpkali's run (as set by **--duration** or **-T**).
+    This option instructs tcpkali to flush latency data to StatsD every *Time*
+    period and start measuring latencies anew.
+    The latencies that are displayed in the user interface remain being
+    collected across the whole run.
+
 # VARIABLE UNITS
 
 -----------------------------------------------------------------------