Skip to content

Commit

Permalink
tools: add tcptracer (#762)
Browse files Browse the repository at this point in the history
* tools: add tcptracer

This allows tracking TCP connections by tracking TCP connects, closes
and accepts.

This is different from existing tools like tcpconnect or tcpaccept in
that:

* It includes more information like network namespace or source ports
for tcpconnects or remote ports for tcpaccepts
* It traces tcp_close allowing to see when a connection ends
* It only shows information about established connections

* tcptracer: add to README

* tcptracer: add example

* tcptracer: add man page
  • Loading branch information
iaguis authored and goldshtn committed Mar 30, 2017
1 parent 4bb6d7f commit f37434b
Show file tree
Hide file tree
Showing 4 changed files with 779 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ pair of .c and .py files, and some are directories of files.
- tools/[tcplife](tools/tcplife.py): Trace TCP sessions and summarize lifespan. [Examples](tools/tcplife_example.txt).
- tools/[tcpretrans](tools/tcpretrans.py): Trace TCP retransmits and TLPs. [Examples](tools/tcpretrans_example.txt).
- tools/[tcptop](tools/tcptop.py): Summarize TCP send/recv throughput by host. Top for TCP. [Examples](tools/tcptop_example.txt).
- tools/[tcptracer](tools/tcptracer.py): Trace TCP established connections (connect(), accept(), close()). [Examples](tools/tcptracer_example.txt).
- tools/[tplist](tools/tplist.py): Display kernel tracepoints or USDT probes and their formats. [Examples](tools/tplist_example.txt).
- tools/[trace](tools/trace.py): Trace arbitrary functions, with filters. [Examples](tools/trace_example.txt).
- tools/[ttysnoop](tools/ttysnoop.py): Watch live output from a tty or pts device. [Examples](tools/ttysnoop_example.txt).
Expand Down
98 changes: 98 additions & 0 deletions man/man8/tcptracer.8
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
.TH tcptracer 8 "2017-03-27" "USER COMMANDS"
.SH NAME
tcptracer \- Trace TCP established connections. Uses Linux eBPF/bcc.
.SH SYNOPSIS
.B tcptracer [\-h] [\-v] [\-p PID] [\-N NETNS]
.SH DESCRIPTION
This tool traces established TCP connections that open and close while tracing,
and prints a line of output per connect, accept and close events. This includes
the type of event, PID, IP addresses and ports.

This tool works by using kernel dynamic tracing, and will need to be updated if
the kernel implementation changes. Only established TCP connections are traced,
so it is expected that the overhead of this tool is rather low.

Since this uses BPF, only the root user can use this tool.
.SH REQUIREMENTS
CONFIG_BPF and bcc.
.SH OPTIONS
.TP
\-h
Print usage message.
.TP
\-v
Print full lines, with long event type names and network namespace numbers.
.TP
\-p PID
Trace this process ID only (filtered in-kernel).
.TP
\-N NETNS
Trace this network namespace only (filtered in-kernel).
.TP
.SH EXAMPLES
.TP
Trace all TCP established connections:
#
.B tcptracer
.TP
Trace all TCP established connections with verbose lines:
#
.B tcptracer \-v
.TP
Trace PID 181 only:
#
.B tcptracer \-p 181
.TP
Trace connections in network namespace 4026531969 only:
#
.B tcptracer \-N 4026531969
.SH FIELDS
.TP
TYPE
Type of event. In non-verbose mode: C for connect, A for accept, X for close.
.TP
PID
Process ID
.TP
COMM
Process name
.TP
IP
IP address family (4 or 6)
.TP
SADDR
Source IP address.
.TP
DADDR
Destination IP address.
.TP
SPORT
Source port.
.TP
DPORT
Destination port.
.TP
NETNS
Network namespace where the event originated.
.SH OVERHEAD
This traces the kernel inet accept function, and the TCP connect, close,
and set state functions. However, it only prints information for connections
that are established, so it shouldn't have a huge overhead.

As always, test and understand this tools overhead for your types of workloads
before production use.
.SH SOURCE
This is from bcc.
.IP
https://github.com/iovisor/bcc
.PP
Also look in the bcc distribution for a companion _examples.txt file containing
example usage, output, and commentary for this tool.
.SH OS
Linux
.SH STABILITY
Unstable - in development.
.SH AUTHOR
Iago López Galeiras
.SH SEE ALSO
tcpaccept(8), tcpconnect(8), tcptop(8), tcplife(8)
Loading

0 comments on commit f37434b

Please sign in to comment.