mirror of
https://github.com/tailscale/tailscale.git
synced 2024-11-29 21:15:39 +00:00
97b6d3e917
They're not needed for the sockstats logger, and they're somewhat expensive to return (since they involve the creation of a map per label). We now have a separate GetInterfaces() method that returns them instead (which we can still use in the PeerAPI debug endpoint). If changing sockstatlog to sample at 10,000 Hz (instead of the default of 10Hz), the CPU usage would go up to 59% on a iPhone XS. Removing the per-interface stats drops it to 20% (a no-op implementation of Get that returns a fixed value is 16%). Updates tailscale/corp#9230 Updates #3363 Signed-off-by: Mihai Parparita <mihai@tailscale.com>
119 lines
4.1 KiB
Go
119 lines
4.1 KiB
Go
// Copyright (c) Tailscale Inc & AUTHORS
|
|
// SPDX-License-Identifier: BSD-3-Clause
|
|
|
|
// Package sockstats collects statistics about network sockets used by
|
|
// the Tailscale client. The context where sockets are used must be
|
|
// instrumented with the WithSockStats() function.
|
|
//
|
|
// Only available on POSIX platforms when built with Tailscale's fork of Go.
|
|
package sockstats
|
|
|
|
import (
|
|
"context"
|
|
|
|
"tailscale.com/net/interfaces"
|
|
)
|
|
|
|
// SockStats contains statistics for sockets instrumented with the
|
|
// WithSockStats() function
|
|
type SockStats struct {
|
|
Stats map[Label]SockStat
|
|
CurrentInterfaceCellular bool
|
|
}
|
|
|
|
// SockStat contains the sent and received bytes for a socket instrumented with
|
|
// the WithSockStats() function.
|
|
type SockStat struct {
|
|
TxBytes uint64
|
|
RxBytes uint64
|
|
}
|
|
|
|
// Label is an identifier for a socket that stats are collected for. A finite
|
|
// set of values that may be used to label a socket to encourage grouping and
|
|
// to make storage more efficient.
|
|
type Label uint8
|
|
|
|
//go:generate go run golang.org/x/tools/cmd/stringer -type Label -trimprefix Label
|
|
|
|
// Labels are named after the package and function/struct that uses the socket.
|
|
// Values may be persisted and thus existing entries should not be re-numbered.
|
|
const (
|
|
LabelControlClientAuto Label = 0 // control/controlclient/auto.go
|
|
LabelControlClientDialer Label = 1 // control/controlhttp/client.go
|
|
LabelDERPHTTPClient Label = 2 // derp/derphttp/derphttp_client.go
|
|
LabelLogtailLogger Label = 3 // logtail/logtail.go
|
|
LabelDNSForwarderDoH Label = 4 // net/dns/resolver/forwarder.go
|
|
LabelDNSForwarderUDP Label = 5 // net/dns/resolver/forwarder.go
|
|
LabelNetcheckClient Label = 6 // net/netcheck/netcheck.go
|
|
LabelPortmapperClient Label = 7 // net/portmapper/portmapper.go
|
|
LabelMagicsockConnUDP4 Label = 8 // wgengine/magicsock/magicsock.go
|
|
LabelMagicsockConnUDP6 Label = 9 // wgengine/magicsock/magicsock.go
|
|
)
|
|
|
|
// WithSockStats instruments a context so that sockets created with it will
|
|
// have their statistics collected.
|
|
func WithSockStats(ctx context.Context, label Label) context.Context {
|
|
return withSockStats(ctx, label)
|
|
}
|
|
|
|
// Get returns the current socket statistics.
|
|
func Get() *SockStats {
|
|
return get()
|
|
}
|
|
|
|
// InterfaceSockStats contains statistics for sockets instrumented with the
|
|
// WithSockStats() function, broken down by interface. The statistics may be a
|
|
// subset of the total if interfaces were added after the instrumented socket
|
|
// was created.
|
|
type InterfaceSockStats struct {
|
|
Stats map[Label]InterfaceSockStat
|
|
Interfaces []string
|
|
}
|
|
|
|
// InterfaceSockStat contains the per-interface sent and received bytes for a
|
|
// socket instrumented with the WithSockStats() function.
|
|
type InterfaceSockStat struct {
|
|
TxBytesByInterface map[string]uint64
|
|
RxBytesByInterface map[string]uint64
|
|
}
|
|
|
|
// GetWithInterfaces is a variant of Get that returns the current socket
|
|
// statistics broken down by interface. It is slightly more expensive than Get.
|
|
func GetInterfaces() *InterfaceSockStats {
|
|
return getInterfaces()
|
|
}
|
|
|
|
// ValidationSockStats contains external validation numbers for sockets
|
|
// instrumented with WithSockStats. It may be a subset of the all sockets,
|
|
// depending on what externa measurement mechanisms the platform supports.
|
|
type ValidationSockStats struct {
|
|
Stats map[Label]ValidationSockStat
|
|
}
|
|
|
|
// ValidationSockStat contains the validation bytes for a socket instrumented
|
|
// with WithSockStats.
|
|
type ValidationSockStat struct {
|
|
TxBytes uint64
|
|
RxBytes uint64
|
|
}
|
|
|
|
// GetValidation is a variant of Get that returns external validation numbers
|
|
// for stats. It is more expensive than Get and should be used in debug
|
|
// interfaces only.
|
|
func GetValidation() *ValidationSockStats {
|
|
return getValidation()
|
|
}
|
|
|
|
// LinkMonitor is the interface for the parts of wgengine/mointor's Mon that we
|
|
// need, to avoid the dependency.
|
|
type LinkMonitor interface {
|
|
InterfaceState() *interfaces.State
|
|
RegisterChangeCallback(interfaces.ChangeFunc) (unregister func())
|
|
}
|
|
|
|
// SetLinkMonitor configures the sockstats package to monitor the active
|
|
// interface, so that per-interface stats can be collected.
|
|
func SetLinkMonitor(lm LinkMonitor) {
|
|
setLinkMonitor(lm)
|
|
}
|