ebpf

Documentation

Index

• Constants
• func ReadFrom(reader io.Reader) (*NetFlowRecordT, error)
• type FlowFetcher
  • func NewFlowFetcher(_, _ int, _, _ bool) (*FlowFetcher, error)
  • func (m *FlowFetcher) Close() error
  • func (m *FlowFetcher) LookupAndDeleteMap() map[NetFlowId][]NetFlowMetrics
  • func (m *FlowFetcher) ReadRingBuf() (ringbuf.Record, error)
  • func (m *FlowFetcher) Register(_ ifaces.Interface) error
• type IPAddr
  • func (ia *IPAddr) IP() net.IP
  • func (ia *IPAddr) IntEncodeV4() uint32
  • func (ia *IPAddr) MarshalJSON() ([]byte, error)
• type MacAddr
  • func (m *MacAddr) MarshalJSON() ([]byte, error)
  • func (m *MacAddr) String() string
• type Record
  • func NewRecord(key NetFlowId, metrics NetFlowMetrics, currentTime time.Time, ...) *Record

Constants

const MacLen = 6

Functions

func ReadFrom

func ReadFrom(reader io.Reader) (*NetFlowRecordT, error)

ReadFrom reads a Record from a binary source, in LittleEndian order

Types

type FlowFetcher

type FlowFetcher struct {
}

func NewFlowFetcher

func NewFlowFetcher(_, _ int, _, _ bool) (*FlowFetcher, error)

func (*FlowFetcher) Close

func (m *FlowFetcher) Close() error

func (*FlowFetcher) LookupAndDeleteMap

func (m *FlowFetcher) LookupAndDeleteMap() map[NetFlowId][]NetFlowMetrics

func (*FlowFetcher) ReadRingBuf

func (m *FlowFetcher) ReadRingBuf() (ringbuf.Record, error)

func (*FlowFetcher) Register

func (m *FlowFetcher) Register(_ ifaces.Interface) error

type IPAddr

type IPAddr [net.IPv6len]uint8

IPAddr encodes v4 and v6 IPs with a fixed length. IPv4 addresses are encoded as IPv6 addresses with prefix ::ffff/96 as described in https://datatracker.ietf.org/doc/html/rfc4038#section-4.2 (same behavior as Go's net.IP type)

func (*IPAddr) IP

func (ia *IPAddr) IP() net.IP

IP returns the net.IP equivalent object

func (*IPAddr) IntEncodeV4

func (ia *IPAddr) IntEncodeV4() uint32

IntEncodeV4 encodes an IPv4 address as an integer (in network encoding, big endian). It assumes that the passed IP is already IPv4. Otherwise it would just encode the last 4 bytes of an IPv6 address

func (*IPAddr) MarshalJSON

func (ia *IPAddr) MarshalJSON() ([]byte, error)

type MacAddr

type MacAddr [MacLen]uint8

func (*MacAddr) MarshalJSON

func (m *MacAddr) MarshalJSON() ([]byte, error)

func (*MacAddr) String

func (m *MacAddr) String() string

type Record

type Record struct {
	NetFlowRecordT
	// TODO: redundant field from RecordMetrics. Reorganize structs
	TimeFlowStart time.Time
	TimeFlowEnd   time.Time
	Interface     string
	// Duplicate tells whether this flow has another duplicate so it has to be excluded from
	// any metrics' aggregation (e.g. bytes/second rates between two pods).
	// The reason for this field is that the same flow can be observed from multiple interfaces,
	// so the agent needs to choose only a view of the same flow and mark the others as
	// "exclude from aggregation". Otherwise rates, sums, etc... values would be multiplied by the
	// number of interfaces this flow is observed from.
	Duplicate bool

	// AgentIP provides information about the source of the flow (the Agent that traced it)
	AgentIP string

	Metadata map[string]string
}

Record contains accumulated metrics from a flow, with extra metadata that is added from the user space

func NewRecord

func NewRecord(
	key NetFlowId,
	metrics NetFlowMetrics,
	currentTime time.Time,
	monotonicCurrentTime uint64,
) *Record