summaryrefslogtreecommitdiffhomepage
path: root/wgengine/netstack/debug.go
blob: 1259f63a9999c106dfb20cbbe62276b93f2513e7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
// Copyright (c) Tailscale Inc & AUTHORS
// SPDX-License-Identifier: BSD-3-Clause

package netstack

import (
	"html/template"
	"net/http"
	"net/netip"
	"slices"
	"time"

	xmaps "golang.org/x/exp/maps"
	"gvisor.dev/gvisor/pkg/tcpip"
)

var tcpForwarderTemplate = template.Must(template.New("").Parse(`
<html>
	<head>
		<meta name="viewport" content="width=device-width, initial-scale=1">
		<style>
		body { font-family: monospace; font-size: 12; }
		td { padding: 0.3em; }
		</style>
	</head>
	<body>
	<h1>TCP Forwarder</h1>

	<h2>TCP Statistics</h2>
	<table border=1>
		<tr>
			<th>Metric</th>
			<th>Value</th>
		</tr>
		{{ range .Stats }}
		<tr><td>{{ .Key }}</td><td>{{ .Value }}</td></tr>
		{{ end }}
	</table>

	<h2>In-Flight Outbound Connections</h2>
	<table border=1>
		<tr>
			<th>Start Time</th>
			<th>Client IP</th>
			<th>Remote IP</th>
		</tr>
		{{ range .InFlightDials }}
		<tr>
			<td>{{ .Start.Format "2006-01-02T15:04:05Z07:00" }} ({{ printf "%.2f" .DurationSecs }} seconds ago)</td>
			<td>{{ .ClientIP }}</td>
			<td>{{ .RemoteAddr }}</td>
		</tr>
		{{ end }}
	</table>
</body>
</html>
`))

// DebugTCPForwarder writes debug information about this netstack
// implementation's current TCP forwarder in HTML format.
func (ns *Impl) DebugTCPForwarder(w http.ResponseWriter, r *http.Request) {
	// Grab data while holding the mutex
	ns.tcpDebugMu.Lock()
	tcpDials := xmaps.Values(ns.inFlightDials)
	ns.tcpDebugMu.Unlock()

	slices.SortFunc(tcpDials, func(a, b tcpDialInfo) int {
		return a.start.Compare(b.start)
	})

	type templateDataStats struct {
		Key   string
		Value uint64
	}
	type templateDataDial struct {
		Start        time.Time
		DurationSecs float64
		ClientIP     netip.Addr
		RemoteAddr   netip.AddrPort
	}
	type templateData struct {
		Stats         []templateDataStats
		InFlightDials []templateDataDial
	}

	var data templateData

	// Statistics from gVisor
	tcpStats := ns.ipstack.Stats().TCP
	tcpMetrics := []struct {
		name  string
		field *tcpip.StatCounter
	}{
		{"Active Connection Openings", tcpStats.ActiveConnectionOpenings},
		{"Passive Connection Openings", tcpStats.PassiveConnectionOpenings},
		{"Established Connections", tcpStats.CurrentEstablished},
		{"Connected Connections", tcpStats.CurrentConnected},
		{"Dropped In-Flight Forwarder Connections", tcpStats.ForwardMaxInFlightDrop},
		{"Established Resets", tcpStats.EstablishedResets},
		{"Established Timeout", tcpStats.EstablishedTimedout},
		{"Failed Connection Attempts", tcpStats.FailedConnectionAttempts},
		{"Retransmits", tcpStats.Retransmits},
		{"Timeouts", tcpStats.Timeouts},
		{"Checksum Errors", tcpStats.ChecksumErrors},
		{"Failed Port Reservations", tcpStats.FailedPortReservations},
	}
	for _, metric := range tcpMetrics {
		data.Stats = append(data.Stats, templateDataStats{
			Key:   metric.name,
			Value: metric.field.Value(),
		})
	}

	// Any in-flight DialContext calls in the TCP forwarding path.
	now := time.Now()
	for _, dial := range tcpDials {
		elapsed := now.Sub(dial.start)
		data.InFlightDials = append(data.InFlightDials, templateDataDial{
			Start:        dial.start,
			DurationSecs: elapsed.Seconds(),
			ClientIP:     dial.clientRemoteIP,
			RemoteAddr:   dial.dialAddr,
		})
	}

	w.Header().Set("Content-Type", "text/html; charset=utf-8")
	w.Header().Set("Cache-Control", "no-cache")
	tcpForwarderTemplate.Execute(w, &data)
}