types

Documentation

Index

• func EventString(i interface{}) string
• func Init(nodeName string)
• func MustAddVirtualL3EndpointColumn[Event any](cols *columns.Columns[Event], attr columns.Attributes, ...)
• func MustAddVirtualL4EndpointColumn[Event any](cols *columns.Columns[Event], attr columns.Attributes, ...)
• type CommonData
  • func (c *CommonData) GetContainer() string
  • func (c *CommonData) GetNamespace() string
  • func (c *CommonData) GetNode() string
  • func (c *CommonData) GetPod() string
  • func (c *CommonData) SetContainerInfo(pod, namespace, container string)
  • func (c *CommonData) SetNode(node string)
• type EndpointKind
• type Event
  • func Debug(msg string) Event
  • func Err(msg string) Event
  • func Info(msg string) Event
  • func Warn(msg string) Event
  • func (e Event) GetBaseEvent() *Event
  • func (e *Event) GetMessage() string
  • func (e *Event) GetType() EventType
• type EventType
• type L3Endpoint
  • func (e *L3Endpoint) String() string
• type L4Endpoint
  • func (e *L4Endpoint) String() string
• type Time
  • func (t Time) String() string
• type WithMountNsID
  • func (e *WithMountNsID) GetMountNSID() uint64
• type WithNetNsID
  • func (e *WithNetNsID) GetNetNSID() uint64

Functions

func EventString

func EventString(i interface{}) string

func Init

func Init(nodeName string)

func MustAddVirtualL3EndpointColumn

func MustAddVirtualL3EndpointColumn[Event any](
	cols *columns.Columns[Event],
	attr columns.Attributes,
	getEndpoint func(*Event) L3Endpoint,
)

func MustAddVirtualL4EndpointColumn

func MustAddVirtualL4EndpointColumn[Event any](
	cols *columns.Columns[Event],
	attr columns.Attributes,
	getEndpoint func(*Event) L4Endpoint,
)

Types

type CommonData

type CommonData struct {
	// Node where the event comes from
	Node string `json:"node,omitempty" column:"node,template:node" columnTags:"kubernetes"`

	// Pod namespace where the event comes from, or empty for host-level
	// event
	Namespace string `json:"namespace,omitempty" column:"namespace,template:namespace" columnTags:"kubernetes"`

	// Pod where the event comes from, or empty for host-level event
	Pod string `json:"pod,omitempty" column:"pod,template:pod" columnTags:"kubernetes"`

	// Container where the event comes from, or empty for host-level or
	// pod-level event
	Container string `json:"container,omitempty" column:"container,template:container" columnTags:"kubernetes,runtime"`

	// HostNetwork is true if the container uses the host network namespace
	HostNetwork bool `json:"hostNetwork,omitempty" column:"hostnetwork,hide"`
}

func (*CommonData) GetContainer

func (c *CommonData) GetContainer() string

func (*CommonData) GetNamespace

func (c *CommonData) GetNamespace() string

func (*CommonData) GetNode

func (c *CommonData) GetNode() string

func (*CommonData) GetPod

func (c *CommonData) GetPod() string

func (*CommonData) SetContainerInfo

func (c *CommonData) SetContainerInfo(pod, namespace, container string)

func (*CommonData) SetNode

func (c *CommonData) SetNode(node string)

type EndpointKind

type EndpointKind string

const (
	EndpointKindPod     EndpointKind = "pod"
	EndpointKindService EndpointKind = "svc"
	EndpointKindRaw     EndpointKind = "raw"
)

type Event

type Event struct {
	CommonData

	// Timestamp in nanoseconds since January 1, 1970 UTC. An int64 is big
	// enough to represent time between the year 1678 and 2262.
	Timestamp Time `json:"timestamp,omitempty" column:"timestamp,template:timestamp,stringer"`

	// Type indicates the kind of this event
	Type EventType `json:"type"`

	// Message when Type is ERR, WARN, DEBUG or INFO
	Message string `json:"message,omitempty"`
}

func Debug

func Debug(msg string) Event

func Err

func Err(msg string) Event

func Info

func Info(msg string) Event

func Warn

func Warn(msg string) Event

func (Event) GetBaseEvent

func (e Event) GetBaseEvent() *Event

GetBaseEvent is needed to implement commonutils.BaseElement and snapshot.SnapshotEvent interfaces.

func (*Event) GetMessage

func (e *Event) GetMessage() string

func (*Event) GetType

func (e *Event) GetType() EventType

type EventType

type EventType string

const (
	// Indicates a generic event produced by a gadget. Gadgets extend
	// the base event to contain the specific data the gadget provides
	NORMAL EventType = "normal"

	// Event is an error message
	ERR EventType = "err"

	// Event is a warning message
	WARN EventType = "warn"

	// Event is a debug message
	DEBUG EventType = "debug"

	// Event is a info message
	INFO EventType = "info"

	// Indicates the tracer in the node is now is able to produce events
	READY EventType = "ready"
)

type L3Endpoint

type L3Endpoint struct {
	// Addr is filled by the gadget
	Addr string `json:"addr,omitempty" column:"addr,hide,template:ipaddr"`

	// Namespace, Name, Kind and PodLabels get populated by the KubeIPResolver operator
	Namespace string            `json:"namespace,omitempty" column:"ns,template:namespace,hide"`
	Name      string            `json:"podname,omitempty" column:"name,hide"`
	Kind      EndpointKind      `json:"kind,omitempty" column:"kind,hide"`
	PodLabels map[string]string `json:"podlabels,omitempty" column:"podLabels,hide"`
}

func (*L3Endpoint) String

func (e *L3Endpoint) String() string

type L4Endpoint

type L4Endpoint struct {
	L3Endpoint
	// Port is filled by the gadget
	Port uint16 `json:"port" column:"port,hide,template:ipport"`
}

func (*L4Endpoint) String

func (e *L4Endpoint) String() string

type Time

type Time int64

func (Time) String

func (t Time) String() string

type WithMountNsID

type WithMountNsID struct {
	MountNsID uint64 `json:"mountnsid,omitempty" column:"mntns,template:ns"`
}

func (*WithMountNsID) GetMountNSID

func (e *WithMountNsID) GetMountNSID() uint64

type WithNetNsID

type WithNetNsID struct {
	NetNsID uint64 `json:"netnsid,omitempty" column:"netns,template:ns"`
}

func (*WithNetNsID) GetNetNSID

func (e *WithNetNsID) GetNetNSID() uint64