Skip to content

Commit

Permalink
Updating man page for tcpconnlat to include min duration arguments and
Browse files Browse the repository at this point in the history
flag to print bpf program. Also fixed naming in tcpconnlat man page.

Added more examples in tcpconnlat_example.txt to show min duration
usage.
  • Loading branch information
dpayne committed Jan 18, 2018
1 parent ce0cf92 commit 7b7e34a
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 6 deletions.
29 changes: 23 additions & 6 deletions man/man8/tcpconnlat.8
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.TH tcpconnect 8 "2016-02-19" "USER COMMANDS"
.TH tcpconnlat 8 "2016-02-19" "USER COMMANDS"
.SH NAME
tcpconnect \- Trace TCP active connection latency. Uses Linux eBPF/bcc.
tcpconnlat \- Trace TCP active connection latency. Uses Linux eBPF/bcc.
.SH SYNOPSIS
.B tcpconnect [\-h] [\-t] [\-p PID]
.B tcpconnlat [\-h] [\-t] [\-p PID] [-m MIN_MS] [-u MIN_US] [-v]
.SH DESCRIPTION
This tool traces active TCP connections
(eg, via a connect() syscall), and shows the latency (time) for the connection
Expand Down Expand Up @@ -30,19 +30,36 @@ Include a timestamp column.
.TP
\-p PID
Trace this process ID only (filtered in-kernel).
.TP
\-m MIN_NS
Minimum duration to trace, in milliseconds.
.TP
\-u MIN_US
Minimum duration to trace, in microseconds.
.TP
\-v
Print the resulting BPF program, for debugging purposes.
.SH EXAMPLES
.TP
Trace all active TCP connections, and show connection latency (SYN->response round trip):
#
.B tcpconnect
.B tcpconnlat
.TP
Include timestamps:
#
.B tcpconnect \-t
.B tcpconnlat \-t
.TP
Trace PID 181 only:
#
.B tcpconnect \-p 181
.B tcpconnlat \-p 181
.TP
Trace connects with latency longer than 10 ms:
#
.B tcpconnlat \-m 10
.TP
Print the BPF program:
#
.B tcpconnlat \-v
.SH FIELDS
.TP
TIME(s)
Expand Down
3 changes: 3 additions & 0 deletions tools/tcpconnlat_example.txt
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,6 @@ examples:
./tcpconnlat # trace all TCP connect()s
./tcpconnlat -t # include timestamps
./tcpconnlat -p 181 # only trace PID 181
./tcpconnlat -m 1 # only show connects longer than 1 ms
./tcpconnlat -u 100 # only show connects longer than 100 us
./tcpconnlat -v # Show the BPF program

0 comments on commit 7b7e34a

Please sign in to comment.