@ -1,11 +1,9 @@
// Copyright (c) Tailscale Inc & AUTHORS
// Copyright (c) Tailscale Inc & AUTHORS
// SPDX-License-Identifier: BSD-3-Clause
// SPDX-License-Identifier: BSD-3-Clause
//go:build !ts_omit_ connstats
//go:build !ts_omit_ netlog && !ts_omit_logtail
// Package connstats maintains statistics about connections
package netlog
// flowing through a TUN device (which operate at the IP layer).
package connstats
import ( import (
"context"
"context"
@ -20,10 +18,10 @@ import (
"tailscale.com/types/netlogtype"
"tailscale.com/types/netlogtype"
) )
// S tatistics maintains counters for every connection.
// s tatistics maintains counters for every connection.
// All methods are safe for concurrent use.
// All methods are safe for concurrent use.
// The zero value is ready for use.
// The zero value is ready for use.
type S tatistics struct { type s tatistics struct {
maxConns int // immutable once set
maxConns int // immutable once set
mu sync . Mutex
mu sync . Mutex
@ -42,13 +40,13 @@ type connCnts struct {
physical map [ netlogtype . Connection ] netlogtype . Counts
physical map [ netlogtype . Connection ] netlogtype . Counts
} }
// N ewStatistics creates a data structure for tracking connection statistics
// n ewStatistics creates a data structure for tracking connection statistics
// that periodically dumps the virtual and physical connection counts
// that periodically dumps the virtual and physical connection counts
// depending on whether the maxPeriod or maxConns is exceeded.
// depending on whether the maxPeriod or maxConns is exceeded.
// The dump function is called from a single goroutine.
// The dump function is called from a single goroutine.
// Shutdown must be called to cleanup resources.
// Shutdown must be called to cleanup resources.
func N ewStatistics( maxPeriod time . Duration , maxConns int , dump func ( start , end time . Time , virtual , physical map [ netlogtype . Connection ] netlogtype . Counts ) ) * S tatistics { func n ewStatistics( maxPeriod time . Duration , maxConns int , dump func ( start , end time . Time , virtual , physical map [ netlogtype . Connection ] netlogtype . Counts ) ) * s tatistics {
s := & S tatistics{ maxConns : maxConns }
s := & s tatistics{ maxConns : maxConns }
s . connCntsCh = make ( chan connCnts , 256 )
s . connCntsCh = make ( chan connCnts , 256 )
s . shutdownCtx , s . shutdown = context . WithCancel ( context . Background ( ) )
s . shutdownCtx , s . shutdown = context . WithCancel ( context . Background ( ) )
s . group . Go ( func ( ) error {
s . group . Go ( func ( ) error {
@ -85,7 +83,7 @@ func NewStatistics(maxPeriod time.Duration, maxConns int, dump func(start, end t
// UpdateTxVirtual updates the counters for a transmitted IP packet
// UpdateTxVirtual updates the counters for a transmitted IP packet
// The source and destination of the packet directly correspond with
// The source and destination of the packet directly correspond with
// the source and destination in netlogtype.Connection.
// the source and destination in netlogtype.Connection.
func ( s * S tatistics) UpdateTxVirtual ( b [ ] byte ) { func ( s * s tatistics) UpdateTxVirtual ( b [ ] byte ) {
var p packet . Parsed
var p packet . Parsed
p . Decode ( b )
p . Decode ( b )
s . UpdateVirtual ( p . IPProto , p . Src , p . Dst , 1 , len ( b ) , false )
s . UpdateVirtual ( p . IPProto , p . Src , p . Dst , 1 , len ( b ) , false )
@ -94,7 +92,7 @@ func (s *Statistics) UpdateTxVirtual(b []byte) {
// UpdateRxVirtual updates the counters for a received IP packet.
// UpdateRxVirtual updates the counters for a received IP packet.
// The source and destination of the packet are inverted with respect to
// The source and destination of the packet are inverted with respect to
// the source and destination in netlogtype.Connection.
// the source and destination in netlogtype.Connection.
func ( s * S tatistics) UpdateRxVirtual ( b [ ] byte ) { func ( s * s tatistics) UpdateRxVirtual ( b [ ] byte ) {
var p packet . Parsed
var p packet . Parsed
p . Decode ( b )
p . Decode ( b )
s . UpdateVirtual ( p . IPProto , p . Dst , p . Src , 1 , len ( b ) , true )
s . UpdateVirtual ( p . IPProto , p . Dst , p . Src , 1 , len ( b ) , true )
@ -105,7 +103,7 @@ var (
tailscaleServiceIPv6 = tsaddr . TailscaleServiceIPv6 ( )
tailscaleServiceIPv6 = tsaddr . TailscaleServiceIPv6 ( )
) )
func ( s * S tatistics) UpdateVirtual ( proto ipproto . Proto , src , dst netip . AddrPort , packets , bytes int , receive bool ) { func ( s * s tatistics) UpdateVirtual ( proto ipproto . Proto , src , dst netip . AddrPort , packets , bytes int , receive bool ) {
// Network logging is defined as traffic between two Tailscale nodes.
// Network logging is defined as traffic between two Tailscale nodes.
// Traffic with the internal Tailscale service is not with another node
// Traffic with the internal Tailscale service is not with another node
// and should not be logged. It also happens to be a high volume
// and should not be logged. It also happens to be a high volume
@ -137,7 +135,7 @@ func (s *Statistics) UpdateVirtual(proto ipproto.Proto, src, dst netip.AddrPort,
// The src is always a Tailscale IP address, representing some remote peer.
// The src is always a Tailscale IP address, representing some remote peer.
// The dst is a remote IP address and port that corresponds
// The dst is a remote IP address and port that corresponds
// with some physical peer backing the Tailscale IP address.
// with some physical peer backing the Tailscale IP address.
func ( s * S tatistics) UpdateTxPhysical ( src netip . Addr , dst netip . AddrPort , packets , bytes int ) { func ( s * s tatistics) UpdateTxPhysical ( src netip . Addr , dst netip . AddrPort , packets , bytes int ) {
s . UpdatePhysical ( 0 , netip . AddrPortFrom ( src , 0 ) , dst , packets , bytes , false )
s . UpdatePhysical ( 0 , netip . AddrPortFrom ( src , 0 ) , dst , packets , bytes , false )
} }
@ -145,11 +143,11 @@ func (s *Statistics) UpdateTxPhysical(src netip.Addr, dst netip.AddrPort, packet
// The src is always a Tailscale IP address, representing some remote peer.
// The src is always a Tailscale IP address, representing some remote peer.
// The dst is a remote IP address and port that corresponds
// The dst is a remote IP address and port that corresponds
// with some physical peer backing the Tailscale IP address.
// with some physical peer backing the Tailscale IP address.
func ( s * S tatistics) UpdateRxPhysical ( src netip . Addr , dst netip . AddrPort , packets , bytes int ) { func ( s * s tatistics) UpdateRxPhysical ( src netip . Addr , dst netip . AddrPort , packets , bytes int ) {
s . UpdatePhysical ( 0 , netip . AddrPortFrom ( src , 0 ) , dst , packets , bytes , true )
s . UpdatePhysical ( 0 , netip . AddrPortFrom ( src , 0 ) , dst , packets , bytes , true )
} }
func ( s * S tatistics) UpdatePhysical ( proto ipproto . Proto , src , dst netip . AddrPort , packets , bytes int , receive bool ) { func ( s * s tatistics) UpdatePhysical ( proto ipproto . Proto , src , dst netip . AddrPort , packets , bytes int , receive bool ) {
conn := netlogtype . Connection { Proto : proto , Src : src , Dst : dst }
conn := netlogtype . Connection { Proto : proto , Src : src , Dst : dst }
s . mu . Lock ( )
s . mu . Lock ( )
@ -170,7 +168,7 @@ func (s *Statistics) UpdatePhysical(proto ipproto.Proto, src, dst netip.AddrPort
// preInsertConn updates the maps to handle insertion of a new connection.
// preInsertConn updates the maps to handle insertion of a new connection.
// It reports false if insertion is not allowed (i.e., after shutdown).
// It reports false if insertion is not allowed (i.e., after shutdown).
func ( s * S tatistics) preInsertConn ( ) bool { func ( s * s tatistics) preInsertConn ( ) bool {
// Check whether insertion of a new connection will exceed maxConns.
// Check whether insertion of a new connection will exceed maxConns.
if len ( s . virtual ) + len ( s . physical ) == s . maxConns && s . maxConns > 0 {
if len ( s . virtual ) + len ( s . physical ) == s . maxConns && s . maxConns > 0 {
// Extract the current statistics and send it to the serializer.
// Extract the current statistics and send it to the serializer.
@ -192,13 +190,13 @@ func (s *Statistics) preInsertConn() bool {
return s . shutdownCtx . Err ( ) == nil
return s . shutdownCtx . Err ( ) == nil
} }
func ( s * S tatistics) extract ( ) connCnts { func ( s * s tatistics) extract ( ) connCnts {
s . mu . Lock ( )
s . mu . Lock ( )
defer s . mu . Unlock ( )
defer s . mu . Unlock ( )
return s . extractLocked ( )
return s . extractLocked ( )
} }
func ( s * S tatistics) extractLocked ( ) connCnts { func ( s * s tatistics) extractLocked ( ) connCnts {
if len ( s . virtual ) + len ( s . physical ) == 0 {
if len ( s . virtual ) + len ( s . physical ) == 0 {
return connCnts { }
return connCnts { }
}
}
@ -210,7 +208,7 @@ func (s *Statistics) extractLocked() connCnts {
// TestExtract synchronously extracts the current network statistics map
// TestExtract synchronously extracts the current network statistics map
// and resets the counters. This should only be used for testing purposes.
// and resets the counters. This should only be used for testing purposes.
func ( s * S tatistics) TestExtract ( ) ( virtual , physical map [ netlogtype . Connection ] netlogtype . Counts ) { func ( s * s tatistics) TestExtract ( ) ( virtual , physical map [ netlogtype . Connection ] netlogtype . Counts ) {
cc := s . extract ( )
cc := s . extract ( )
return cc . virtual , cc . physical
return cc . virtual , cc . physical
} }
@ -218,7 +216,7 @@ func (s *Statistics) TestExtract() (virtual, physical map[netlogtype.Connection]
// Shutdown performs a final flush of statistics.
// Shutdown performs a final flush of statistics.
// Statistics for any subsequent calls to Update will be dropped.
// Statistics for any subsequent calls to Update will be dropped.
// It is safe to call Shutdown concurrently and repeatedly.
// It is safe to call Shutdown concurrently and repeatedly.
func ( s * S tatistics) Shutdown ( context . Context ) error { func ( s * s tatistics) Shutdown ( context . Context ) error {
s . shutdown ( )
s . shutdown ( )
return s . group . Wait ( )
return s . group . Wait ( )
} }
Joe Tsai
2 months ago
committed by