TheArchive/tailscale
1
0
Fork 0
mirror of https://github.com/tailscale/tailscale.git synced 2025-02-18 02:48:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

net/sockstats: pass in logger to sockstats.WithSockStats

Browse Source 
Using log.Printf may end up being printed out to the console, which
is not desirable. I noticed this when I was investigating some client
logs with `sockstats: trace "NetcheckClient" was overwritten by another`.
That turns to be harmless/expected (the netcheck client will fall back
to the DERP client in some cases, which does its own sockstats trace).

However, the log output could be visible to users if running the
`tailscale netcheck` CLI command, which would be needlessly confusing.

Updates tailscale/corp#9230

Signed-off-by: Mihai Parparita <mihai@tailscale.com>
This commit is contained in:
Mihai Parparita 2023-04-12 18:23:22 -07:00 committed by Mihai Parparita
parent 782ccb5655
commit edb02b63f8
11 changed files with 22 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
control/controlclient/auto.go
View File

@ -121,10 +121,10 @@ func NewNoStart(opts Options) (_ *Auto, err error) {
statusFunc: opts.Status, statusFunc: opts.Status,
} }
c.authCtx, c.authCancel = context.WithCancel(context.Background()) c.authCtx, c.authCancel = context.WithCancel(context.Background())
c.authCtx = sockstats.WithSockStats(c.authCtx, sockstats.LabelControlClientAuto) c.authCtx = sockstats.WithSockStats(c.authCtx, sockstats.LabelControlClientAuto, opts.Logf)
c.mapCtx, c.mapCancel = context.WithCancel(context.Background()) c.mapCtx, c.mapCancel = context.WithCancel(context.Background())
c.mapCtx = sockstats.WithSockStats(c.mapCtx, sockstats.LabelControlClientAuto) c.mapCtx = sockstats.WithSockStats(c.mapCtx, sockstats.LabelControlClientAuto, opts.Logf)
c.unregisterHealthWatch = health.RegisterWatcher(direct.ReportHealthChange) c.unregisterHealthWatch = health.RegisterWatcher(direct.ReportHealthChange)
return c, nil return c, nil
@ -244,7 +244,7 @@ func (c *Auto) cancelAuth() {
} }
if !c.closed { if !c.closed {
c.authCtx, c.authCancel = context.WithCancel(context.Background()) c.authCtx, c.authCancel = context.WithCancel(context.Background())
c.authCtx = sockstats.WithSockStats(c.authCtx, sockstats.LabelControlClientAuto) c.authCtx = sockstats.WithSockStats(c.authCtx, sockstats.LabelControlClientAuto, c.logf)
} }
c.mu.Unlock() c.mu.Unlock()
} }
@ -255,7 +255,7 @@ func (c *Auto) cancelMapLocked() {
} }
if !c.closed { if !c.closed {
c.mapCtx, c.mapCancel = context.WithCancel(context.Background()) c.mapCtx, c.mapCancel = context.WithCancel(context.Background())
c.mapCtx = sockstats.WithSockStats(c.mapCtx, sockstats.LabelControlClientAuto) c.mapCtx = sockstats.WithSockStats(c.mapCtx, sockstats.LabelControlClientAuto, c.logf)
} }
} }

2
control/controlhttp/client.go
View File

@ -273,7 +273,7 @@ func (a *Dialer) dialHost(ctx context.Context, addr netip.Addr) (*ClientConn, er
ctx, cancel := context.WithCancel(ctx) ctx, cancel := context.WithCancel(ctx)
defer cancel() defer cancel()
ctx = sockstats.WithSockStats(ctx, sockstats.LabelControlClientDialer) ctx = sockstats.WithSockStats(ctx, sockstats.LabelControlClientDialer, a.logf)
// u80 and u443 are the URLs we'll try to hit over HTTP or HTTPS, // u80 and u443 are the URLs we'll try to hit over HTTP or HTTPS,
// respectively, in order to do the HTTP upgrade to a net.Conn over which // respectively, in order to do the HTTP upgrade to a net.Conn over which

2
derp/derphttp/derphttp_client.go
View File

@ -632,7 +632,7 @@ func (c *Client) dialNode(ctx context.Context, n *tailcfg.DERPNode) (net.Conn, e
ctx, cancel := context.WithTimeout(ctx, dialNodeTimeout) ctx, cancel := context.WithTimeout(ctx, dialNodeTimeout)
defer cancel() defer cancel()
ctx = sockstats.WithSockStats(ctx, sockstats.LabelDERPHTTPClient) ctx = sockstats.WithSockStats(ctx, sockstats.LabelDERPHTTPClient, c.logf)
nwait := 0 nwait := 0
startDial := func(dstPrimary, proto string) { startDial := func(dstPrimary, proto string) {

2
logtail/logtail.go
View File

@ -435,7 +435,7 @@ func (l *Logger) awaitInternetUp(ctx context.Context) {
// origlen of -1 indicates that the body is not compressed. // origlen of -1 indicates that the body is not compressed.
func (l *Logger) upload(ctx context.Context, body []byte, origlen int) (uploaded bool, err error) { func (l *Logger) upload(ctx context.Context, body []byte, origlen int) (uploaded bool, err error) {
const maxUploadTime = 45 * time.Second const maxUploadTime = 45 * time.Second
ctx = sockstats.WithSockStats(ctx, l.sockstatsLabel) ctx = sockstats.WithSockStats(ctx, l.sockstatsLabel, l.Logf)
ctx, cancel := context.WithTimeout(ctx, maxUploadTime) ctx, cancel := context.WithTimeout(ctx, maxUploadTime)
defer cancel() defer cancel()

4
net/dns/resolver/forwarder.go
View File

@ -408,7 +408,7 @@ func (f *forwarder) getKnownDoHClientForProvider(urlBase string) (c *http.Client
const dohType = "application/dns-message" const dohType = "application/dns-message"
func (f *forwarder) sendDoH(ctx context.Context, urlBase string, c *http.Client, packet []byte) ([]byte, error) { func (f *forwarder) sendDoH(ctx context.Context, urlBase string, c *http.Client, packet []byte) ([]byte, error) {
ctx = sockstats.WithSockStats(ctx, sockstats.LabelDNSForwarderDoH) ctx = sockstats.WithSockStats(ctx, sockstats.LabelDNSForwarderDoH, f.logf)
metricDNSFwdDoH.Add(1) metricDNSFwdDoH.Add(1)
req, err := http.NewRequestWithContext(ctx, "POST", urlBase, bytes.NewReader(packet)) req, err := http.NewRequestWithContext(ctx, "POST", urlBase, bytes.NewReader(packet))
if err != nil { if err != nil {
@ -488,7 +488,7 @@ func (f *forwarder) sendUDP(ctx context.Context, fq *forwardQuery, rr resolverAn
return nil, fmt.Errorf("unrecognized resolver type %q", rr.name.Addr) return nil, fmt.Errorf("unrecognized resolver type %q", rr.name.Addr)
} }
metricDNSFwdUDP.Add(1) metricDNSFwdUDP.Add(1)
ctx = sockstats.WithSockStats(ctx, sockstats.LabelDNSForwarderUDP) ctx = sockstats.WithSockStats(ctx, sockstats.LabelDNSForwarderUDP, f.logf)
ln, err := f.packetListener(ipp.Addr()) ln, err := f.packetListener(ipp.Addr())
if err != nil { if err != nil {

2
net/netcheck/netcheck.go
View File

@ -787,7 +787,7 @@ func (c *Client) GetReport(ctx context.Context, dm *tailcfg.DERPMap) (_ *Report,
ctx, cancel := context.WithTimeout(ctx, overallProbeTimeout) ctx, cancel := context.WithTimeout(ctx, overallProbeTimeout)
defer cancel() defer cancel()
ctx = sockstats.WithSockStats(ctx, sockstats.LabelNetcheckClient) ctx = sockstats.WithSockStats(ctx, sockstats.LabelNetcheckClient, c.logf)
if dm == nil { if dm == nil {
return nil, errors.New("netcheck: GetReport: DERP map is nil") return nil, errors.New("netcheck: GetReport: DERP map is nil")

2
net/portmapper/portmapper.go
View File

@ -249,7 +249,7 @@ func (c *Client) upnpPort() uint16 {
} }
func (c *Client) listenPacket(ctx context.Context, network, addr string) (nettype.PacketConn, error) { func (c *Client) listenPacket(ctx context.Context, network, addr string) (nettype.PacketConn, error) {
ctx = sockstats.WithSockStats(ctx, sockstats.LabelPortmapperClient) ctx = sockstats.WithSockStats(ctx, sockstats.LabelPortmapperClient, c.logf)
// When running under testing conditions, we bind the IGD server // When running under testing conditions, we bind the IGD server
// to localhost, and may be running in an environment where our // to localhost, and may be running in an environment where our

5
net/sockstats/sockstats.go
View File

@ -12,6 +12,7 @@ import (
"context" "context"
"tailscale.com/net/interfaces" "tailscale.com/net/interfaces"
"tailscale.com/types/logger"
) )
// SockStats contains statistics for sockets instrumented with the // SockStats contains statistics for sockets instrumented with the
@ -54,8 +55,8 @@ const (
// WithSockStats instruments a context so that sockets created with it will // WithSockStats instruments a context so that sockets created with it will
// have their statistics collected. // have their statistics collected.
func WithSockStats(ctx context.Context, label Label) context.Context { func WithSockStats(ctx context.Context, label Label, logf logger.Logf) context.Context {
return withSockStats(ctx, label) return withSockStats(ctx, label, logf)
} }
// Get returns the current socket statistics. // Get returns the current socket statistics.

4
net/sockstats/sockstats_noop.go
View File

@ -7,11 +7,13 @@ package sockstats
import ( import (
"context" "context"
"tailscale.com/types/logger"
) )
const IsAvailable = false const IsAvailable = false
func withSockStats(ctx context.Context, label Label) context.Context { func withSockStats(ctx context.Context, label Label, logf logger.Logf) context.Context {
return ctx return ctx
} }

6
net/sockstats/sockstats_tsgo.go
View File

@ -8,7 +8,6 @@ package sockstats
import ( import (
"context" "context"
"fmt" "fmt"
"log"
"math" "math"
"net" "net"
"strings" "strings"
@ -18,6 +17,7 @@ import (
"time" "time"
"tailscale.com/net/interfaces" "tailscale.com/net/interfaces"
"tailscale.com/types/logger"
"tailscale.com/util/clientmetric" "tailscale.com/util/clientmetric"
) )
@ -71,7 +71,7 @@ func init() {
sockStats.radioHighMetric.DisableDeltas() sockStats.radioHighMetric.DisableDeltas()
} }
func withSockStats(ctx context.Context, label Label) context.Context { func withSockStats(ctx context.Context, label Label, logf logger.Logf) context.Context {
sockStats.mu.Lock() sockStats.mu.Lock()
defer sockStats.mu.Unlock() defer sockStats.mu.Unlock()
counters, ok := sockStats.countersByLabel[label] counters, ok := sockStats.countersByLabel[label]
@ -157,7 +157,7 @@ func withSockStats(ctx context.Context, label Label) context.Context {
} }
} }
willOverwrite := func(trace *net.SockTrace) { willOverwrite := func(trace *net.SockTrace) {
log.Printf("sockstats: trace %q was overwritten by another", label) logf("sockstats: trace %q was overwritten by another", label)
} }
return net.WithSockTrace(ctx, &net.SockTrace{ return net.WithSockTrace(ctx, &net.SockTrace{

4
wgengine/magicsock/magicsock.go
View File

@ -3226,9 +3226,9 @@ func (c *Conn) ReSTUN(why string) {
func (c *Conn) listenPacket(network string, port uint16) (nettype.PacketConn, error) { func (c *Conn) listenPacket(network string, port uint16) (nettype.PacketConn, error) {
ctx := context.Background() // unused without DNS name to resolve ctx := context.Background() // unused without DNS name to resolve
if network == "udp4" { if network == "udp4" {
ctx = sockstats.WithSockStats(ctx, sockstats.LabelMagicsockConnUDP4) ctx = sockstats.WithSockStats(ctx, sockstats.LabelMagicsockConnUDP4, c.logf)
} else { } else {
ctx = sockstats.WithSockStats(ctx, sockstats.LabelMagicsockConnUDP6) ctx = sockstats.WithSockStats(ctx, sockstats.LabelMagicsockConnUDP6, c.logf)
} }
addr := net.JoinHostPort("", fmt.Sprint(port)) addr := net.JoinHostPort("", fmt.Sprint(port))
if c.testOnlyPacketListener != nil { if c.testOnlyPacketListener != nil {