stats

type Class uint8

type Collector struct {
	// contains filtered or unexported fields
}

type Counters struct {
	TxPackets atomic.Uint64
	TxBytes   atomic.Uint64 // total Ethernet frame bytes, including the FCS
	TxUDP     atomic.Uint64
	TxTCP     atomic.Uint64
	TxOther   atomic.Uint64
	TxErrors  atomic.Uint64

	RxPackets atomic.Uint64
	RxBytes   atomic.Uint64
	RxUDP     atomic.Uint64
	RxTCP     atomic.Uint64
	RxOther   atomic.Uint64
	RxErrors  atomic.Uint64
	// contains filtered or unexported fields
}

type HistoryPoint struct {
	At     time.Time
	TX, RX Rates
}

type Kernel struct {
	Queues          int
	RxPackets       uint64
	TxPackets       uint64
	RxDropped       uint64
	RxRingFull      uint64
	RxFillRingEmpty uint64
	RxInvalidDescs  uint64
	TxInvalidDescs  uint64
	TxRingEmpty     uint64
	PerQueue        []KernelQueue
}

type KernelFunc func() (Kernel, error)

type KernelQueue struct {
	Queue      int
	RxPackets  uint64
	TxPackets  uint64
	RxDropped  uint64
	RxRingFull uint64
}

type Option func(*Collector)

type Rates struct {
	PPS float64

	// FrameBPS is **L2**: the Ethernet frame itself, including its 4-byte FCS.
	//
	// Note that the kernel's own netdev counters — what bwm-ng, iftop, nload
	// and `ip -s link` report — exclude the FCS by specification, so they read
	// 4 bytes per packet below this. That is about 6% at 64-byte frames and 1%
	// at IMIX, and it is a different measurement rather than a disagreement.
	FrameBPS float64

	// WireBPS is **L1**: the frame plus the 20 bytes of physical framing every
	// packet costs — 7-byte preamble, 1-byte start-frame delimiter and 12-byte
	// interframe gap. This is link utilisation, and it is the unit --bps is
	// measured in: 10G line rate means 10 Gbit/s of L1.
	WireBPS float64
}

type Snapshot struct {
	At        time.Time
	Elapsed   time.Duration
	Remaining time.Duration // 0 when the run has no duration limit
	State     State

	// TX and RX are the visible counters, measured since the last interval
	// reset. TotalTX and TotalRX are the lifetime figures, which the final
	// summary reports and which an interval reset never disturbs.
	TX, RX           Totals
	TotalTX, TotalRX Totals
	TXRate, RXRate   Rates

	// IntervalSince is when the visible counters were last reset.
	IntervalSince time.Time

	Kernel Kernel

	// Problems names queues that are dropping or stalled, ready to display.
	Problems []string

	// Transmits is false for a receive-only run, so the status line can leave
	// out a transmit half that will only ever read zero.
	Transmits bool

	// History is one point per second, oldest first, for the dashboard's
	// sparklines. It spans at most historyLen seconds.
	History []HistoryPoint
}

type State int

type Totals struct {
	Packets uint64
	// Bytes is the total Ethernet frame size, including the 4-byte FCS — the
	// same definition as --packet-size, so a run of 64-byte frames reports an
	// average frame size of 64.
	Bytes  uint64
	UDP    uint64
	TCP    uint64
	Other  uint64
	Errors uint64
	Drops  uint64
}