summaryrefslogtreecommitdiffstats
path: root/api/stats.go
blob: 9c3a16fc17153d539b525935764f19142a5e95b6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
package api

// SystemStats represents global system statistics.
type SystemStats struct {
	VectorRate     float64
	InputRate      float64
	LastUpdate     float64
	LastStatsClear float64
	Heartbeat      float64
}

// NodeStats represents per node statistics.
type NodeStats struct {
	Nodes []NodeCounters
}

// NodeCounters represents node counters.
type NodeCounters struct {
	NodeIndex uint32
	NodeName  string // requires VPP 19.04+

	Clocks   uint64
	Vectors  uint64
	Calls    uint64
	Suspends uint64
}

// InterfaceStats represents per interface statistics.
type InterfaceStats struct {
	Interfaces []InterfaceCounters
}

// InterfaceCounters represents interface counters.
type InterfaceCounters struct {
	InterfaceIndex uint32
	InterfaceName  string // requires VPP 19.04+

	RxPackets uint64
	RxBytes   uint64
	RxErrors  uint64
	TxPackets uint64
	TxBytes   uint64
	TxErrors  uint64

	RxUnicast     [2]uint64 // packets[0], bytes[1]
	RxMulticast   [2]uint64 // packets[0], bytes[1]
	RxBroadcast   [2]uint64 // packets[0], bytes[1]
	TxUnicastMiss [2]uint64 // packets[0], bytes[1]
	TxMulticast   [2]uint64 // packets[0], bytes[1]
	TxBroadcast   [2]uint64 // packets[0], bytes[1]

	Drops   uint64
	Punts   uint64
	IP4     uint64
	IP6     uint64
	RxNoBuf uint64
	RxMiss  uint64
}

// ErrorStats represents statistics per error counter.
type ErrorStats struct {
	Errors []ErrorCounter
}

// ErrorCounter represents error counter.
type ErrorCounter struct {
	CounterName string
	Value       uint64
}

// StatsProvider provides the methods for getting statistics.
type StatsProvider interface {
	GetSystemStats() (*SystemStats, error)
	GetNodeStats() (*NodeStats, error)
	GetInterfaceStats() (*InterfaceStats, error)
	GetErrorStats(names ...string) (*ErrorStats, error)
}