net/tstun: instrument Wrapper with statistics gathering (#5847)

If Wrapper.StatisticsEnable is enabled,
then per-connection counters are maintained.
If enabled, Wrapper.StatisticsExtract must be periodically called
otherwise there is unbounded memory growth.

Signed-off-by: Joe Tsai <joetsai@digital-static.net>
This commit is contained in:
Joe Tsai
2022-10-05 12:24:30 -07:00
committed by GitHub
parent a37ee8483f
commit 24ebf161e8
3 changed files with 58 additions and 0 deletions

View File

@ -22,8 +22,10 @@ import (
"golang.zx2c4.com/wireguard/tun"
"gvisor.dev/gvisor/pkg/tcpip/stack"
"tailscale.com/disco"
"tailscale.com/net/flowtrack"
"tailscale.com/net/packet"
"tailscale.com/net/tsaddr"
"tailscale.com/net/tunstats"
"tailscale.com/syncs"
"tailscale.com/tstime/mono"
"tailscale.com/types/ipproto"
@ -166,6 +168,12 @@ type Wrapper struct {
// disableTSMPRejected disables TSMP rejected responses. For tests.
disableTSMPRejected bool
// stats maintains per-connection counters.
stats struct {
enabled atomic.Bool
tunstats.Statistics
}
}
// tunReadResult is the result of a TUN read, or an injected result pretending to be a TUN read.
@ -560,6 +568,9 @@ func (t *Wrapper) Read(buf []byte, offset int) (int, error) {
}
}
if t.stats.enabled.Load() {
t.stats.UpdateTx(buf[offset:][:n])
}
t.noteActivity()
return n, nil
}
@ -690,6 +701,9 @@ func (t *Wrapper) Write(buf []byte, offset int) (int, error) {
}
func (t *Wrapper) tdevWrite(buf []byte, offset int) (int, error) {
if t.stats.enabled.Load() {
t.stats.UpdateRx(buf[offset:])
}
if t.isTAP {
return t.tapWrite(buf, offset)
}
@ -829,6 +843,18 @@ func (t *Wrapper) Unwrap() tun.Device {
return t.tdev
}
// StatisticsEnable enables per-connections packet counters.
// StatisticsExtract must be called periodically to avoid unbounded memory use.
func (t *Wrapper) StatisticsEnable(enable bool) {
t.stats.enabled.Store(enable)
}
// StatisticsExtract extracts and resets the counters for all active connections.
// It must be called periodically otherwise the memory used is unbounded.
func (t *Wrapper) StatisticsExtract() map[flowtrack.Tuple]tunstats.Counts {
return t.stats.Extract()
}
var (
metricPacketIn = clientmetric.NewCounter("tstun_in_from_wg")
metricPacketInDrop = clientmetric.NewCounter("tstun_in_from_wg_drop")