Skip to content

feat: add option to speedtest to dump a pcap of network traffic #11848

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions cli/speedtest.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,13 @@ package cli
import (
"context"
"fmt"
"os"
"time"

"github.com/jedib0t/go-pretty/v6/table"
"golang.org/x/xerrors"
tsspeedtest "tailscale.com/net/speedtest"
"tailscale.com/wgengine/capture"

"cdr.dev/slog"
"cdr.dev/slog/sloggers/sloghuman"
Expand All @@ -21,6 +23,7 @@ func (r *RootCmd) speedtest() *clibase.Cmd {
direct bool
duration time.Duration
direction string
pcapFile string
)
client := new(codersdk.Client)
cmd := &clibase.Cmd{
Expand Down Expand Up @@ -63,6 +66,7 @@ func (r *RootCmd) speedtest() *clibase.Cmd {
return err
}
defer conn.Close()

if direct {
ticker := time.NewTicker(time.Second)
defer ticker.Stop()
Expand Down Expand Up @@ -95,6 +99,19 @@ func (r *RootCmd) speedtest() *clibase.Cmd {
} else {
conn.AwaitReachable(ctx)
}

if pcapFile != "" {
s := capture.New()
conn.InstallCaptureHook(s.LogPacket)
f, err := os.OpenFile(pcapFile, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0o644)
if err != nil {
return err
}
defer f.Close()
unregister := s.RegisterOutput(f)
defer unregister()
}

var tsDir tsspeedtest.Direction
switch direction {
case "up":
Expand Down Expand Up @@ -146,6 +163,12 @@ func (r *RootCmd) speedtest() *clibase.Cmd {
Default: tsspeedtest.DefaultDuration.String(),
Value: clibase.DurationOf(&duration),
},
{
Description: "Specifies a file to write a network capture to.",
Flag: "pcap-file",
Default: "",
Value: clibase.StringOf(&pcapFile),
},
}
return cmd
}
3 changes: 3 additions & 0 deletions cli/testdata/coder_speedtest_--help.golden
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ OPTIONS:
Specifies whether to run in reverse mode where the client receives and
the server sends.

--pcap-file string
Specifies a file to write a network capture to.

-t, --time duration (default: 5s)
Specifies the duration to monitor traffic.

Expand Down
8 changes: 8 additions & 0 deletions docs/cli/speedtest.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions tailnet/conn.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ import (
tslogger "tailscale.com/types/logger"
"tailscale.com/types/netlogtype"
"tailscale.com/wgengine"
"tailscale.com/wgengine/capture"
"tailscale.com/wgengine/magicsock"
"tailscale.com/wgengine/netstack"
"tailscale.com/wgengine/router"
Expand Down Expand Up @@ -310,6 +311,12 @@ type Conn struct {
trafficStats *connstats.Statistics
}

func (c *Conn) InstallCaptureHook(f capture.Callback) {
c.mutex.Lock()
defer c.mutex.Unlock()
c.wireguardEngine.InstallCaptureHook(f)
}

func (c *Conn) MagicsockSetDebugLoggingEnabled(enabled bool) {
c.magicConn.SetDebugLoggingEnabled(enabled)
}
Expand Down