metrics

Documentation

Index

• Constants
• type BGPAddressFamilyMetrics
• type BGPMetrics
• type BGPPeerMetrics
• type BMPMetrics
• type BMPRouterMetrics

Constants

const (
	StateDown        = 0
	StateIdle        = 1
	StateConnect     = 2
	StateActive      = 3
	StateOpenSent    = 4
	StateOpenConfirm = 5
	StateEstablished = 6
)

Types

type BGPAddressFamilyMetrics

type BGPAddressFamilyMetrics struct {
	// AFI is the identifier for the address family
	AFI uint16

	// SAFI is the identifier for the sub address family
	SAFI uint8

	// RoutesReceived is the number of routes we recevied
	RoutesReceived uint64

	// RoutesAccepted is the number of routes we sent
	RoutesSent uint64
}

BGPAddressFamilyMetrics provides metrics on AFI/SAFI level for one session

type BGPMetrics

type BGPMetrics struct {
	// Peers is the collection of per peer metrics
	Peers []*BGPPeerMetrics
}

BGPMetrics provides metrics for a single BGP server instance

type BGPPeerMetrics

type BGPPeerMetrics struct {
	// IP is the remote IP of the peer
	IP *bnet.IP

	// ASN is the ASN of the peer
	ASN uint32

	// LocalASN is our local ASN
	LocalASN uint32

	// VRF is the name of the VRF the peer is configured in
	VRF string

	// Since is the time the session was established
	Since time.Time

	// State of the BGP session (Down = 0, Idle = 1, Connect = 2, Active = 3, OpenSent = 4, OpenConfirm = 5, Established = 6)
	State uint8

	// Up returns if the session is established
	Up bool

	// UpdatesReceived is the number of update messages received on this session
	UpdatesReceived uint64

	// UpdatesReceived is the number of update messages we sent on this session
	UpdatesSent uint64

	// AddressFamilies provides metrics on AFI/SAFI level
	AddressFamilies []*BGPAddressFamilyMetrics
}

BGPPeerMetrics provides metrics for one BGP session

type BMPMetrics

type BMPMetrics struct {
	Routers []*BMPRouterMetrics
}

BMPMetrics contains per router BMP metrics

type BMPRouterMetrics

type BMPRouterMetrics struct {
	// Routers IP Address
	Address net.IP

	// SysName of the monitored router
	SysName string

	// Status of TCP session
	Established bool

	// Count of received RouteMonitoringMessages
	RouteMonitoringMessages uint64

	// Count of received StatisticsReportMessages
	StatisticsReportMessages uint64

	// Count of received PeerDownNotificationMessages
	PeerDownNotificationMessages uint64

	// Count of received PeerUpNotificationMessages
	PeerUpNotificationMessages uint64

	// Count of received InitiationMessages
	InitiationMessages uint64

	// Count of received TerminationMessages
	TerminationMessages uint64

	// Count of received RouteMirroringMessages
	RouteMirroringMessages uint64

	// VRFMetrics represent per VRF metrics
	VRFMetrics []*vrf_metrics.VRFMetrics

	// PeerMetrics contains BGP per peer metrics
	PeerMetrics []*BGPPeerMetrics
}

BMPRouterMetrics contains a routers BMP metrics