Documentation
¶
Index ¶
- Constants
- Variables
- func AddLayer2Link(g *graph.Graph, node1 *graph.Node, node2 *graph.Node, metadata graph.Metadata) (*graph.Edge, error)
- func AddLink(g *graph.Graph, node1 *graph.Node, node2 *graph.Node, relationType string, ...) (*graph.Edge, error)
- func AddOwnershipLink(g *graph.Graph, parent *graph.Node, child *graph.Node, metadata graph.Metadata) (*graph.Edge, error)
- func GetOwnershipLink(g *graph.Graph, parent *graph.Node, child *graph.Node) *graph.Edge
- func HaveLayer2Link(g *graph.Graph, node1 *graph.Node, node2 *graph.Node) bool
- func HaveLink(g *graph.Graph, node1 *graph.Node, node2 *graph.Node, relationType string) bool
- func HaveOwnershipLink(g *graph.Graph, parent *graph.Node, child *graph.Node) bool
- func InterfaceMetricMetadataDecoder(raw json.RawMessage) (common.Getter, error)
- func IsInterfaceUp(node *graph.Node) bool
- func IsOwnershipLinked(g *graph.Graph, node *graph.Node) bool
- func Layer2Metadata() graph.Metadata
- func NamespaceFromNode(g *graph.Graph, n *graph.Node) (string, string, error)
- func NeighborMetadataDecoder(raw json.RawMessage) (common.Getter, error)
- func NewLink(g *graph.Graph, node1 *graph.Node, node2 *graph.Node, relationType string, ...) (*graph.Edge, error)
- func NewNetNSContextByNode(g *graph.Graph, n *graph.Node) (*common.NetNSContext, error)
- func OwnershipMetadata() graph.Metadata
- func RoutingTablesMetadataDecoder(raw json.RawMessage) (common.Getter, error)
- type HostNodeTIDMap
- type InterfaceMetric
- func (im *InterfaceMetric) Add(m common.Metric) common.Metric
- func (im *InterfaceMetric) GetLast() int64
- func (im *InterfaceMetric) GetStart() int64
- func (im *InterfaceMetric) IsZero() bool
- func (im *InterfaceMetric) SetLast(last int64)
- func (im *InterfaceMetric) SetStart(start int64)
- func (im *InterfaceMetric) Split(cut int64) (common.Metric, common.Metric)
- func (im *InterfaceMetric) Sub(m common.Metric) common.Metric
- type Neighbor
- type Neighbors
- type NextHop
- type Prefix
- type Route
- type RoutingTable
- type RoutingTables
- type SchemaValidator
- type TIDMapper
Constants ¶
const ( OwnershipLink = "ownership" Layer2Link = "layer2" )
ErrNetworkPathNotFound
Variables ¶
var ( // IPv4DefaultRoute default IPv4 route IPv4DefaultRoute = net.IPNet{IP: net.IPv4zero, Mask: net.CIDRMask(0, 8*net.IPv4len)} // IPv6DefaultRoute default IPv6 route IPv6DefaultRoute = net.IPNet{IP: net.IPv6zero, Mask: net.CIDRMask(0, 8*net.IPv6len)} )
ErrInvalidSchema is return when a JSON schema is invalid
Functions ¶
func AddLayer2Link ¶ added in v0.12.0
func AddLayer2Link(g *graph.Graph, node1 *graph.Node, node2 *graph.Node, metadata graph.Metadata) (*graph.Edge, error)
AddLayer2Link links the parent and the child node
func AddLink ¶ added in v0.22.0
func AddLink(g *graph.Graph, node1 *graph.Node, node2 *graph.Node, relationType string, metadata graph.Metadata) (*graph.Edge, error)
AddLink links the parent and the child node with the specified relation type and metadata
func AddOwnershipLink ¶ added in v0.12.0
func AddOwnershipLink(g *graph.Graph, parent *graph.Node, child *graph.Node, metadata graph.Metadata) (*graph.Edge, error)
AddOwnershipLink Link between the parent and the child node, the child can have only one parent, previous will be overwritten
func GetOwnershipLink ¶ added in v0.18.0
GetOwnershipLink get ownership Link between the parent and the child node or nil
func HaveLayer2Link ¶ added in v0.12.0
HaveLayer2Link returns true if parent and child have the same layer 2
func HaveLink ¶ added in v0.22.0
HaveLink returns true if parent and child are linked
func HaveOwnershipLink ¶ added in v0.12.0
HaveOwnershipLink returns true if parent and child have an ownership link
func InterfaceMetricMetadataDecoder ¶ added in v0.21.0
func InterfaceMetricMetadataDecoder(raw json.RawMessage) (common.Getter, error)
InterfaceMetricMetadataDecoder implements a json message raw decoder
func IsInterfaceUp ¶ added in v0.21.0
IsInterfaceUp returns whether an interface has the flag UP set
func IsOwnershipLinked ¶ added in v0.13.0
IsOwnershipLinked checks whether the node has an OwnershipLink
func Layer2Metadata ¶ added in v0.12.0
Layer2Metadata returns metadata for a layer2 link
func NamespaceFromNode ¶ added in v0.12.0
NamespaceFromNode returns the namespace name and the path of a node in the graph
func NeighborMetadataDecoder ¶ added in v0.24.0
func NeighborMetadataDecoder(raw json.RawMessage) (common.Getter, error)
NeighborMetadataDecoder implements a json message raw decoder
func NewLink ¶ added in v0.23.0
func NewLink(g *graph.Graph, node1 *graph.Node, node2 *graph.Node, relationType string, metadata graph.Metadata) (*graph.Edge, error)
NewLink creates a link between a parent and a child node with the specified relation type and metadata
func NewNetNSContextByNode ¶ added in v0.8.0
NewNetNSContextByNode creates a new network namespace context based on the node
func OwnershipMetadata ¶ added in v0.12.0
OwnershipMetadata returns metadata for an ownership link
Types ¶
type HostNodeTIDMap ¶ added in v0.9.0
HostNodeTIDMap a map that store the value node TID and the key node host
func BuildHostNodeTIDMap ¶ added in v0.9.0
func BuildHostNodeTIDMap(nodes []*graph.Node) HostNodeTIDMap
BuildHostNodeTIDMap creates a new node and host (key) map
type InterfaceMetric ¶ added in v0.16.0
type InterfaceMetric struct {
Collisions int64 `json:"Collisions,omitempty"`
Multicast int64 `json:"Multicast,omitempty"`
RxBytes int64 `json:"RxBytes,omitempty"`
RxCompressed int64 `json:"RxCompressed,omitempty"`
RxCrcErrors int64 `json:"RxCrcErrors,omitempty"`
RxDropped int64 `json:"RxDropped,omitempty"`
RxErrors int64 `json:"RxErrors,omitempty"`
RxFifoErrors int64 `json:"RxFifoErrors,omitempty"`
RxFrameErrors int64 `json:"RxFrameErrors,omitempty"`
RxLengthErrors int64 `json:"RxLengthErrors,omitempty"`
RxMissedErrors int64 `json:"RxMissedErrors,omitempty"`
RxOverErrors int64 `json:"RxOverErrors,omitempty"`
RxPackets int64 `json:"RxPackets,omitempty"`
TxAbortedErrors int64 `json:"TxAbortedErrors,omitempty"`
TxBytes int64 `json:"TxBytes,omitempty"`
TxCarrierErrors int64 `json:"TxCarrierErrors,omitempty"`
TxCompressed int64 `json:"TxCompressed,omitempty"`
TxDropped int64 `json:"TxDropped,omitempty"`
TxErrors int64 `json:"TxErrors,omitempty"`
TxFifoErrors int64 `json:"TxFifoErrors,omitempty"`
TxHeartbeatErrors int64 `json:"TxHeartbeatErrors,omitempty"`
TxPackets int64 `json:"TxPackets,omitempty"`
TxWindowErrors int64 `json:"TxWindowErrors,omitempty"`
Start int64 `json:"Start,omitempty"`
Last int64 `json:"Last,omitempty"`
}
InterfaceMetric the interface packets counters easyjson:json gendecoder
func (*InterfaceMetric) Add ¶ added in v0.16.0
func (im *InterfaceMetric) Add(m common.Metric) common.Metric
Add sum two metrics and return a new Metrics object
func (*InterfaceMetric) GetLast ¶ added in v0.16.0
func (im *InterfaceMetric) GetLast() int64
GetLast returns last time
func (*InterfaceMetric) GetStart ¶ added in v0.16.0
func (im *InterfaceMetric) GetStart() int64
GetStart returns start time
func (*InterfaceMetric) IsZero ¶ added in v0.16.0
func (im *InterfaceMetric) IsZero() bool
IsZero returns true if all the values are equal to zero
func (*InterfaceMetric) SetLast ¶ added in v0.16.0
func (im *InterfaceMetric) SetLast(last int64)
SetLast set last tome
func (*InterfaceMetric) SetStart ¶ added in v0.16.0
func (im *InterfaceMetric) SetStart(start int64)
SetStart set start time
func (*InterfaceMetric) Split ¶ added in v0.18.0
Split splits a metric into two parts
type Neighbor ¶ added in v0.24.0
type Neighbor struct {
Flags []string `json:"Flags,omitempty"`
MAC string `json:"MAC,omitempty"`
IP net.IP `json:"IP,omitempty"`
State []string `json:"State,omitempty"`
Vlan int64 `json:"Vlan,omitempty"`
VNI int64 `json:"VNI,omitempty"`
IfIndex int64
}
Neighbor describes a member of the forwarding database easyjson:json gendecoder
type Neighbors ¶ added in v0.24.0
type Neighbors []*Neighbor
Neighbors describes a list of neighbors easyjson:json gendecoder
type NextHop ¶ added in v0.24.0
type NextHop struct {
Priority int64 `json:"Priority"`
IP net.IP `json:"IP,omitempty"`
MAC string `json:"MAC,omitempty"`
IfIndex int64 `json:"IfIndex"`
}
NextHop describes a next hop easyjson:json gendecoder
type Prefix ¶ added in v0.24.0
Prefix describes prefix
func (*Prefix) IsDefaultRoute ¶ added in v0.24.0
IsDefaultRoute return whether the given cidr is a default route
func (*Prefix) MarshalJSON ¶ added in v0.24.0
MarshalJSON custom marshal function
type Route ¶ added in v0.24.0
type Route struct {
Protocol int64 `json:"Protocol"`
Prefix Prefix `json:"Prefix"`
NextHops []*NextHop `json:"NextHops"`
}
Route describes a route easyjson:json gendecoder
func (*Route) GetNextHop ¶ added in v0.24.0
GetNextHop returns the nexthop for the given ip and ifindex
type RoutingTable ¶ added in v0.24.0
type RoutingTable struct {
ID int64 `json:"ID"`
Src net.IP `json:"Src"`
Routes []*Route `json:"Routes"`
}
RoutingTable describes a list of Routes easyjson:json gendecoder
type RoutingTables ¶ added in v0.24.0
type RoutingTables []*RoutingTable
RoutingTables describes a list of routing table easyjson:json gendecoder
type SchemaValidator ¶ added in v0.20.1
type SchemaValidator struct {
// contains filtered or unexported fields
}
SchemaValidator validates graph nodes and edges using a JSON schema
func NewSchemaValidator ¶ added in v0.20.1
func NewSchemaValidator() (*SchemaValidator, error)
NewSchemaValidator returns a new JSON schema validator for graph nodes and edges. based on JSON schema bundled with go-bindata
func (*SchemaValidator) ValidateEdge ¶ added in v0.20.1
func (v *SchemaValidator) ValidateEdge(edge *graph.Edge) error
ValidateEdge valides a graph edge
func (*SchemaValidator) ValidateNode ¶ added in v0.20.1
func (v *SchemaValidator) ValidateNode(node *graph.Node) error
ValidateNode valides a graph node
type TIDMapper ¶ added in v0.6.0
type TIDMapper struct {
graph.DefaultGraphListener
Graph *graph.Graph
// contains filtered or unexported fields
}
TIDMapper describes the hostID nodes stored in a graph the mapper will broadcast node event to the registered listeners
func NewTIDMapper ¶ added in v0.6.0
NewTIDMapper creates a new node mapper in the graph g
func (*TIDMapper) OnEdgeAdded ¶ added in v0.6.0
OnEdgeAdded event
func (*TIDMapper) OnEdgeDeleted ¶ added in v0.12.0
OnEdgeDeleted event
func (*TIDMapper) OnEdgeUpdated ¶ added in v0.6.0
OnEdgeUpdated event
func (*TIDMapper) OnNodeAdded ¶ added in v0.6.0
OnNodeAdded evetn
func (*TIDMapper) OnNodeUpdated ¶ added in v0.6.0
OnNodeUpdated event
Source Files
¶
- metrics.go
- neighbors.go
- nexthop.go
- routes.go
- tid.go
- topology.go
- validator.go