Skip to content

Commit

Permalink
documentation on --message-marker
Browse files Browse the repository at this point in the history
  • Loading branch information
Lev Walkin committed Jan 20, 2017
1 parent ad855ab commit 4dc1496
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 2 deletions.
12 changes: 11 additions & 1 deletion doc/tcpkali.1
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,7 @@ T}
T{
message.marker
T}@T{
Indicate a message boundary for latency measurement.
Produce a message timestamp for message rate and latency measurements.
T}
T{
ws.continuation, ws.ping, ws.pong, ws.text, ws.binary
Expand Down Expand Up @@ -369,6 +369,16 @@ Mean and maximum values can be reported using
Default is \f[C]95,99,99.5\f[].
.RS
.RE
.TP
.B \-\-message\-marker
Passive mode detection or message markers.
Given this option, tcpkali will detect the \\{message.marker} byte
sequences and will calculate message rate (in messages per second) and
message arrival latency.
In the active mode, message rate calculation is implicitly enabled by
using the \\{message.marker} expression.
.RS
.RE
.SS STATSD OPTIONS
.TP
.B \-\-statsd
Expand Down
10 changes: 9 additions & 1 deletion doc/tcpkali.man.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,8 @@ Expression Description

re Randomized expression, for each message.

message.marker Indicate a message boundary for latency measurement.
message.marker Produce a message timestamp for message rate and latency
measurements.

ws.continuation, Specify WebSocket frame types.
ws.ping, ws.pong, Refer to RFC 6455, section 11.8.
Expand Down Expand Up @@ -225,6 +226,13 @@ and the time the latency marker is observed in the downstream traffic
Mean and maximum values can be reported using **--latency-percentiles 50,100**.
Default is `95,99,99.5`.

--message-marker
: Passive mode detection or message markers. Given this option, tcpkali
will detect the \\{message.marker} byte sequences and will calculate
message rate (in messages per second) and message arrival latency.
In the active mode, message rate calculation is implicitly enabled by
using the \\{message.marker} expression.

## STATSD OPTIONS

--statsd
Expand Down

0 comments on commit 4dc1496

Please sign in to comment.