RSDK-9885: Add network stats to ftdc. (viamrobotics#4768)

Author: dgottlieb

ftdc/cmd/parser.go

@@ -156,6 +156,10 @@ var ratioMetricToFields = map[string]ratioMetric{
 	"SystemCPU": {"SystemCPUSecs", "ElapsedTimeSecs"},
 	// PerSec ratios use an empty string denominator.
 	"HeadersProcessedPerSec": {"HeadersProcessed", ""},
+	"TxPacketsPerSec":        {"TxPackets", ""},
+	"RxPacketsPerSec":        {"RxPackets", ""},
+	"TxBytesPerSec":          {"TxBytes", ""},
+	"RxBytesPerSec":          {"RxBytes", ""},
 }
 
 // ratioReading is a reading of two metrics described by `ratioMetric`. This is what will be graphed.
@@ -359,7 +363,10 @@ func (gpw *gnuplotWriter) CompileAndClose() string {
 	// We're making separate graphs instead of a single big graph. The graphs will be arranged in a
 	// rectangle with 1 column and X rows. Where X is the number of metrics.  Add some margins for
 	// aesthetics.
-	writelnf(gnuFile, "set multiplot layout %v,1 margins 0.05,0.9, 0.05,0.9 spacing screen 0, char 5", len(gpw.metricFiles))
+	//
+	// The first margin is the left-hand margin. We set it a bit bigger to allow for larger numbers
+	// for labeling the Y-axis values.
+	writelnf(gnuFile, "set multiplot layout %v,1 margins 0.10,0.9, 0.05,0.9 spacing screen 0, char 5", len(gpw.metricFiles))
 
 	//  Axis labeling/formatting/type information.
 	writeln(gnuFile, "set timefmt '%s'")

ftdc/sys/net.go

@@ -0,0 +1,74 @@
+package sys
+
+import (
+	"github.com/prometheus/procfs"
+)
+
+type netStatser struct {
+	fs procfs.FS
+}
+
+// NewNetUsage returns an object that can interpreted as an `ftdc.Statser`.
+//
+//nolint:revive
+func NewNetUsage() (*netStatser, error) {
+	fs, err := procfs.NewDefaultFS()
+	if err != nil {
+		return nil, err
+	}
+
+	return &netStatser{fs}, nil
+}
+
+type netDevLine struct {
+	RxBytes   uint64
+	RxPackets uint64
+	RxErrors  uint64
+	RxDropped uint64
+	TxBytes   uint64
+	TxPackets uint64
+	TxErrors  uint64
+	TxDropped uint64
+}
+
+type ifaceStats struct {
+	TxQueueLength uint64
+	RxQueueLength uint64
+	UsedSockets   uint64
+	Drops         uint64
+}
+
+type networkStats struct {
+	Ifaces map[string]netDevLine
+	TCP    ifaceStats
+	UDP    ifaceStats
+}
+
+func (netStatser *netStatser) Stats() any {
+	ret := networkStats{
+		Ifaces: make(map[string]netDevLine),
+	}
+	if dev, err := netStatser.fs.NetDev(); err == nil {
+		for ifaceName, stats := range dev {
+			ret.Ifaces[ifaceName] = netDevLine{
+				stats.RxBytes, stats.RxPackets, stats.RxErrors, stats.RxDropped,
+				stats.TxBytes, stats.TxPackets, stats.TxErrors, stats.TxDropped,
+			}
+		}
+	}
+
+	if netTCPSummary, err := netStatser.fs.NetTCPSummary(); err == nil {
+		ret.TCP.TxQueueLength = netTCPSummary.TxQueueLength
+		ret.TCP.RxQueueLength = netTCPSummary.RxQueueLength
+		ret.TCP.UsedSockets = netTCPSummary.UsedSockets
+	}
+
+	if netUDPSummary, err := netStatser.fs.NetUDPSummary(); err == nil {
+		ret.UDP.TxQueueLength = netUDPSummary.TxQueueLength
+		ret.UDP.RxQueueLength = netUDPSummary.RxQueueLength
+		ret.UDP.UsedSockets = netUDPSummary.UsedSockets
+		ret.UDP.Drops = *netUDPSummary.Drops
+	}
+
+	return ret
+}

robot/impl/local_robot.go

@@ -377,6 +377,9 @@ func newWithResources(
 		if statser, err := sys.NewSelfSysUsageStatser(); err == nil {
 			ftdcWorker.Add("proc.viam-server", statser)
 		}
+		if statser, err := sys.NewNetUsage(); err == nil {
+			ftdcWorker.Add("net", statser)
+		}
 	}
 
 	closeCtx, cancel := context.WithCancel(ctx)