netstat_freebsd: add support for some IPv4 metrics

Metrics added:
- ip4_transmit_packets_total
- ip4_transmit_raw_packets_total
- ip4_receive_packets_total
- ip4_receive_fragments_total
- ip4_forward_total
- ip4_fast_forward_total
- ip4_delivered_total

Signed-off-by: Danilo Egea Gondolfo <danilo@FreeBSD.org>
This commit is contained in:
Danilo Egea Gondolfo 2025-04-27 14:20:04 +01:00
parent f0dbecf061
commit 5068195d94
2 changed files with 115 additions and 3 deletions

View file

@ -33,6 +33,7 @@ import (
#include <netinet/tcp.h>
#include <netinet/tcp_var.h>
#include <netinet/udp.h>
#include <netinet/ip_var.h>
*/
import "C"
@ -40,14 +41,45 @@ var (
sysctlRaw = unix.SysctlRaw
tcpSendTotal = "bsdNetstatTcpSendPacketsTotal"
tcpRecvTotal = "bsdNetstatTcpRecvPacketsTotal"
ipv4SendTotal = "bsdNetstatIPv4SendPacketsTotal"
ipv4RawSendTotal = "bsdNetstatIPv4RawSendPacketsTotal"
ipv4RecvTotal = "bsdNetstatIPv4RecvPacketsTotal"
ipv4RecvFragmentsTotal = "bsdNetstatIPv4RecvFragmentsTotal"
ipv4ForwardTotal = "bsdNetstatIPv4ForwardTotal"
ipv4FastForwardTotal = "bsdNetstatIPv4FastForwardTotal"
ipv4DeliveredTotal = "bsdNetstatIPv4DeliveredTotal"
counterMetrics = map[string]*prometheus.Desc{
// TCP stats
tcpSendTotal: prometheus.NewDesc(
prometheus.BuildFQName(namespace, "netstat", "tcp_transmit_packets_total"),
"TCP packets sent", nil, nil),
tcpRecvTotal: prometheus.NewDesc(
prometheus.BuildFQName(namespace, "netstat", "tcp_receive_packets_total"),
"TCP packets received", nil, nil),
// IPv4 stats
ipv4SendTotal: prometheus.NewDesc(
prometheus.BuildFQName(namespace, "netstat", "ip4_transmit_packets_total"),
"IPv4 packets sent from this host", nil, nil),
ipv4RawSendTotal: prometheus.NewDesc(
prometheus.BuildFQName(namespace, "netstat", "ip4_transmit_raw_packets_total"),
"IPv4 raw packets generated", nil, nil),
ipv4RecvTotal: prometheus.NewDesc(
prometheus.BuildFQName(namespace, "netstat", "ip4_receive_packets_total"),
"IPv4 packets received", nil, nil),
ipv4RecvFragmentsTotal: prometheus.NewDesc(
prometheus.BuildFQName(namespace, "netstat", "ip4_receive_fragments_total"),
"IPv4 fragments received", nil, nil),
ipv4ForwardTotal: prometheus.NewDesc(
prometheus.BuildFQName(namespace, "netstat", "ip4_forward_total"),
"IPv4 packets forwarded", nil, nil),
ipv4FastForwardTotal: prometheus.NewDesc(
prometheus.BuildFQName(namespace, "netstat", "ip4_fast_forward_total"),
"IPv4 packets fast forwarded", nil, nil),
ipv4DeliveredTotal: prometheus.NewDesc(
prometheus.BuildFQName(namespace, "netstat", "ip4_delivered_total"),
"IPv4 packets delivered to the upper layer (packets for this host)", nil, nil),
}
)
@ -81,6 +113,34 @@ func (netstatMetric *NetstatTCPData) GetData() (NetstatMetrics, error) {
}, nil
}
type NetstatIPv4Data NetstatData
func NewIPv4Stat() *NetstatIPv4Data {
return &NetstatIPv4Data{
structSize: int(unsafe.Sizeof(C.struct_ipstat{})),
sysctl: "net.inet.ip.stats",
}
}
func (netstatMetric *NetstatIPv4Data) GetData() (NetstatMetrics, error) {
data, err := getData(netstatMetric.sysctl, netstatMetric.structSize)
if err != nil {
return nil, err
}
ipStats := *(*C.struct_ipstat)(unsafe.Pointer(&data[0]))
return NetstatMetrics{
ipv4SendTotal: float64(ipStats.ips_localout),
ipv4RawSendTotal: float64(ipStats.ips_rawout),
ipv4RecvTotal: float64(ipStats.ips_total),
ipv4RecvFragmentsTotal: float64(ipStats.ips_fragments),
ipv4ForwardTotal: float64(ipStats.ips_forward),
ipv4FastForwardTotal: float64(ipStats.ips_fastforward),
ipv4DeliveredTotal: float64(ipStats.ips_delivered),
}, nil
}
func getData(queryString string, expectedSize int) ([]byte, error) {
data, err := sysctlRaw(queryString)
if err != nil {
@ -120,12 +180,21 @@ func (c *netStatCollector) Update(ch chan<- prometheus.Metric) error {
return err
}
ipv4Stats, err := NewIPv4Stat().GetData()
if err != nil {
return err
}
allStats := make(map[string]float64)
for k, v := range tcpStats {
allStats[k] = v
}
for k, v := range ipv4Stats {
allStats[k] = v
}
for metricKey, metricData := range counterMetrics {
ch <- prometheus.MustNewConstMetric(
metricData,
@ -148,6 +217,19 @@ func getFreeBSDDataMock(sysctl string) []byte {
size := int(unsafe.Sizeof(C.struct_tcpstat{}))
return unsafe.Slice((*byte)(unsafe.Pointer(&tcpStats)), size)
} else if sysctl == "net.inet.ip.stats" {
ipStats := C.struct_ipstat{
ips_localout: 1234,
ips_rawout: 1235,
ips_total: 1236,
ips_fragments: 1237,
ips_forward: 1238,
ips_fastforward: 1239,
ips_delivered: 1240,
}
size := int(unsafe.Sizeof(C.struct_ipstat{}))
return unsafe.Slice((*byte)(unsafe.Pointer(&ipStats)), size)
}
return make([]byte, 0, 0)

View file

@ -62,6 +62,36 @@ func TestGetTCPMetrics(t *testing.T) {
}
}
func TestGetIPv4Metrics(t *testing.T) {
testSetup()
ipv4Data, err := NewIPv4Stat().GetData()
if err != nil {
t.Fatal("unexpected error:", err)
}
sndTotal := ipv4Data[ipv4SendTotal]
rcvTotal := ipv4Data[ipv4RecvTotal]
forwardTotal := ipv4Data[ipv4ForwardTotal]
deliveredTotal := ipv4Data[ipv4DeliveredTotal]
if got, want := sndTotal, float64(1234); got != want {
t.Errorf("unexpected sndTotal value: want %f, got %f", want, got)
}
if got, want := rcvTotal, float64(1236); got != want {
t.Errorf("unexpected rcvTotal value: want %f, got %f", want, got)
}
if got, want := forwardTotal, float64(1238); got != want {
t.Errorf("unexpected forwardTotal value: want %f, got %f", want, got)
}
if got, want := deliveredTotal, float64(1240); got != want {
t.Errorf("unexpected deliveredTotal value: want %f, got %f", want, got)
}
}
func TestNetStatCollectorUpdate(t *testing.T) {
ch := make(chan prometheus.Metric, len(counterMetrics))
collector := &netStatCollector{