kube

package
v0.116.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 17, 2024 License: Apache-2.0 Imports: 24 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// MetadataFromPod is used to specify to extract metadata/labels/annotations from pod
	MetadataFromPod = "pod"
	// MetadataFromNamespace is used to specify to extract metadata/labels/annotations from namespace
	MetadataFromNamespace = "namespace"
	// MetadataFromNode is used to specify to extract metadata/labels/annotations from node
	MetadataFromNode       = "node"
	PodIdentifierMaxLength = 4

	ResourceSource   = "resource_attribute"
	ConnectionSource = "connection"
	K8sIPLabelName   = "k8s.pod.ip"
)

Variables

This section is empty.

Functions

func NewFakeInformer 

func NewFakeInformer(
	_ kubernetes.Interface,
	namespace string,
	labelSelector labels.Selector,
	fieldSelector fields.Selector,
) cache.SharedInformer

func NewFakeNamespaceInformer 

func NewFakeNamespaceInformer(
	_ kubernetes.Interface,
) cache.SharedInformer

func NewFakeReplicaSetInformer added in v0.78.0 

func NewFakeReplicaSetInformer(
	_ kubernetes.Interface,
	_ string,
) cache.SharedInformer

func NewNoOpInformer 

func NewNoOpInformer(
	_ kubernetes.Interface,
) cache.SharedInformer

Types

type APIClientsetProvider 

type APIClientsetProvider func(config k8sconfig.APIConfig) (kubernetes.Interface, error)

APIClientsetProvider defines a func type that initializes and return a new kubernetes Clientset object.

type Association 

type Association struct {
	Name    string
	Sources []AssociationSource
}

Association represents one association rule

type AssociationSource added in v0.55.0 

type AssociationSource struct {
	From string
	Name string
}

type Associations 

type Associations struct {
	Associations []Association
}

Associations represent a list of rules for Pod metadata associations with resources

type Client 

type Client interface {
	GetPod(PodIdentifier) (*Pod, bool)
	GetNamespace(string) (*Namespace, bool)
	GetNode(string) (*Node, bool)
	Start() error
	Stop()
}

Client defines the main interface that allows querying pods by metadata.

func New 

func New(
	set component.TelemetrySettings,
	apiCfg k8sconfig.APIConfig,
	rules ExtractionRules,
	filters Filters,
	associations []Association,
	exclude Excludes,
	newClientSet APIClientsetProvider,
	newInformer InformerProvider,
	newNamespaceInformer InformerProviderNamespace,
	newReplicaSetInformer InformerProviderReplicaSet,
	waitForMetadata bool,
	waitForMetadataTimeout time.Duration,
) (Client, error)

New initializes a new k8s Client.

type ClientProvider 

type ClientProvider func(component.TelemetrySettings, k8sconfig.APIConfig, ExtractionRules, Filters, []Association, Excludes, APIClientsetProvider, InformerProvider, InformerProviderNamespace, InformerProviderReplicaSet, bool, time.Duration) (Client, error)

ClientProvider defines a func type that returns a new Client.

type Container 

type Container struct {
	Name      string
	ImageName string
	ImageTag  string

	// Statuses is a map of container k8s.container.restart_count attribute to ContainerStatus struct.
	Statuses map[int]ContainerStatus
}

Container stores resource attributes for a specific container defined by k8s pod spec.

type ContainerStatus 

type ContainerStatus struct {
	ContainerID     string
	ImageRepoDigest string
}

ContainerStatus stores resource attributes for a particular container run defined by k8s pod status.

type Deployment added in v0.78.0 

type Deployment struct {
	Name string
	UID  string
}

Deployment represents a kubernetes deployment.

type ExcludePods 

type ExcludePods struct {
	Name *regexp.Regexp
}

ExcludePods represent a Pod name to ignore

type Excludes 

type Excludes struct {
	Pods []ExcludePods
}

Excludes represent a list of Pods to ignore

type ExtractionRules 

type ExtractionRules struct {
	CronJobName               bool
	DeploymentName            bool
	DeploymentUID             bool
	DaemonSetUID              bool
	DaemonSetName             bool
	JobUID                    bool
	JobName                   bool
	Namespace                 bool
	PodName                   bool
	PodUID                    bool
	PodHostName               bool
	PodIP                     bool
	ReplicaSetID              bool
	ReplicaSetName            bool
	StatefulSetUID            bool
	StatefulSetName           bool
	Node                      bool
	NodeUID                   bool
	StartTime                 bool
	ContainerName             bool
	ContainerID               bool
	ContainerImageName        bool
	ContainerImageRepoDigests bool
	ContainerImageTag         bool
	ClusterUID                bool

	Annotations []FieldExtractionRule
	Labels      []FieldExtractionRule
}

ExtractionRules is used to specify the information that needs to be extracted from pods and added to the spans as tags.

func (*ExtractionRules) IncludesOwnerMetadata added in v0.80.0 

func (rules *ExtractionRules) IncludesOwnerMetadata() bool

IncludesOwnerMetadata determines whether the ExtractionRules include metadata about Pod Owners

type FakeController 

type FakeController struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func (*FakeController) HasStopped 

func (c *FakeController) HasStopped() bool

func (*FakeController) HasSynced 

func (c *FakeController) HasSynced() bool

func (*FakeController) LastSyncResourceVersion 

func (c *FakeController) LastSyncResourceVersion() string

func (*FakeController) Run 

func (c *FakeController) Run(stopCh <-chan struct{})

type FakeInformer 

type FakeInformer struct {
	*FakeController
	// contains filtered or unexported fields
}

func (*FakeInformer) AddEventHandler 

func (f *FakeInformer) AddEventHandler(handler cache.ResourceEventHandler) (cache.ResourceEventHandlerRegistration, error)

func (*FakeInformer) AddEventHandlerWithResyncPeriod 

func (f *FakeInformer) AddEventHandlerWithResyncPeriod(_ cache.ResourceEventHandler, _ time.Duration) (cache.ResourceEventHandlerRegistration, error)

func (*FakeInformer) GetController 

func (f *FakeInformer) GetController() cache.Controller

func (*FakeInformer) GetStore 

func (f *FakeInformer) GetStore() cache.Store

func (*FakeInformer) IsStopped added in v0.68.0 

func (f *FakeInformer) IsStopped() bool

func (*FakeInformer) RemoveEventHandler added in v0.68.0 

func (f *FakeInformer) RemoveEventHandler(_ cache.ResourceEventHandlerRegistration) error

func (*FakeInformer) SetTransform added in v0.51.0 

func (f *FakeInformer) SetTransform(_ cache.TransformFunc) error

func (*FakeInformer) SetWatchErrorHandler 

func (f *FakeInformer) SetWatchErrorHandler(cache.WatchErrorHandler) error

type FakeNamespaceInformer 

type FakeNamespaceInformer struct {
	*FakeController
}

func (*FakeNamespaceInformer) AddEventHandler 

func (f *FakeNamespaceInformer) AddEventHandler(_ cache.ResourceEventHandler)

func (*FakeNamespaceInformer) AddEventHandlerWithResyncPeriod 

func (f *FakeNamespaceInformer) AddEventHandlerWithResyncPeriod(_ cache.ResourceEventHandler, _ time.Duration)

func (*FakeNamespaceInformer) GetController 

func (f *FakeNamespaceInformer) GetController() cache.Controller

func (*FakeNamespaceInformer) GetStore 

func (f *FakeNamespaceInformer) GetStore() cache.Store

type FakeReplicaSetInformer added in v0.78.0 

type FakeReplicaSetInformer struct {
	*FakeController
}

func (*FakeReplicaSetInformer) AddEventHandler added in v0.78.0 

func (f *FakeReplicaSetInformer) AddEventHandler(_ cache.ResourceEventHandler)

func (*FakeReplicaSetInformer) AddEventHandlerWithResyncPeriod added in v0.78.0 

func (f *FakeReplicaSetInformer) AddEventHandlerWithResyncPeriod(_ cache.ResourceEventHandler, _ time.Duration)

func (*FakeReplicaSetInformer) GetController added in v0.78.0 

func (f *FakeReplicaSetInformer) GetController() cache.Controller

func (*FakeReplicaSetInformer) GetStore added in v0.78.0 

func (f *FakeReplicaSetInformer) GetStore() cache.Store

func (*FakeReplicaSetInformer) SetTransform added in v0.78.0 

func (f *FakeReplicaSetInformer) SetTransform(_ cache.TransformFunc) error

type FieldExtractionRule 

type FieldExtractionRule struct {
	// Name is used to as the Span tag name.
	Name string
	// Key is used to lookup k8s pod fields.
	Key string
	// KeyRegex is a regular expression(full length match) used to extract a Key that matches the regex.
	KeyRegex             *regexp.Regexp
	HasKeyRegexReference bool
	// Regex is a regular expression used to extract a sub-part of a field value.
	// Full value is extracted when no regexp is provided.
	Regex *regexp.Regexp
	// From determines the kubernetes object the field should be retrieved from.
	// Currently only three values are supported,
	//  - pod
	//  - namespace
	//  - node
	From string
}

FieldExtractionRule is used to specify which fields to extract from pod fields and inject into spans as attributes.

type FieldFilter 

type FieldFilter struct {
	// Key matches the field name.
	Key string
	// Value matches the field value.
	Value string
	// Op determines the matching operation.
	// Currently only two operations are supported,
	//  - Equals
	//  - NotEquals
	Op selection.Operator
}

FieldFilter represents exactly one filter by field rule.

type Filters 

type Filters struct {
	Node      string
	Namespace string
	Fields    []FieldFilter
	Labels    []FieldFilter
}

Filters is used to instruct the client on how to filter out k8s pods. Right now only filters supported are the ones supported by k8s API itself for performance reasons. We can support adding additional custom filters in future if there is a real need.

type InformerProvider 

type InformerProvider func(
	client kubernetes.Interface,
	namespace string,
	labelSelector labels.Selector,
	fieldSelector fields.Selector,
) cache.SharedInformer

InformerProvider defines a function type that returns a new SharedInformer. It is used to allow passing custom shared informers to the watch client.

type InformerProviderNamespace 

type InformerProviderNamespace func(
	client kubernetes.Interface,
) cache.SharedInformer

InformerProviderNamespace defines a function type that returns a new SharedInformer. It is used to allow passing custom shared informers to the watch client for fetching namespace objects.

type InformerProviderNode added in v0.89.0 

type InformerProviderNode func(
	client kubernetes.Interface,
) cache.SharedInformer

InformerProviderNode defines a function type that returns a new SharedInformer. It is used to allow passing custom shared informers to the watch client for fetching node objects.

type InformerProviderReplicaSet added in v0.78.0 

type InformerProviderReplicaSet func(
	client kubernetes.Interface,
	namespace string,
) cache.SharedInformer

InformerProviderReplicaSet defines a function type that returns a new SharedInformer. It is used to allow passing custom shared informers to the watch client.

type Namespace 

type Namespace struct {
	Name         string
	NamespaceUID string
	Attributes   map[string]string
	StartTime    metav1.Time
	DeletedAt    time.Time
}

Namespace represents a kubernetes namespace.

type NoOpController 

type NoOpController struct {
	// contains filtered or unexported fields
}

func (*NoOpController) HasSynced 

func (c *NoOpController) HasSynced() bool

func (*NoOpController) IsStopped added in v0.68.0 

func (c *NoOpController) IsStopped() bool

func (*NoOpController) LastSyncResourceVersion 

func (c *NoOpController) LastSyncResourceVersion() string

func (*NoOpController) Run 

func (c *NoOpController) Run(stopCh <-chan struct{})

func (*NoOpController) SetWatchErrorHandler 

func (c *NoOpController) SetWatchErrorHandler(cache.WatchErrorHandler) error

type NoOpInformer 

type NoOpInformer struct {
	*NoOpController
}

func (*NoOpInformer) AddEventHandler 

func (f *NoOpInformer) AddEventHandler(handler cache.ResourceEventHandler) (cache.ResourceEventHandlerRegistration, error)

func (*NoOpInformer) AddEventHandlerWithResyncPeriod 

func (f *NoOpInformer) AddEventHandlerWithResyncPeriod(_ cache.ResourceEventHandler, _ time.Duration) (cache.ResourceEventHandlerRegistration, error)

func (*NoOpInformer) GetController 

func (f *NoOpInformer) GetController() cache.Controller

func (*NoOpInformer) GetStore 

func (f *NoOpInformer) GetStore() cache.Store

func (*NoOpInformer) RemoveEventHandler added in v0.68.0 

func (f *NoOpInformer) RemoveEventHandler(_ cache.ResourceEventHandlerRegistration) error

func (*NoOpInformer) SetTransform added in v0.51.0 

func (f *NoOpInformer) SetTransform(_ cache.TransformFunc) error

type Node added in v0.89.0 

type Node struct {
	Name       string
	NodeUID    string
	Attributes map[string]string
}

Node represents a kubernetes node.

type Pod 

type Pod struct {
	Name        string
	Address     string
	PodUID      string
	Attributes  map[string]string
	StartTime   *metav1.Time
	Ignore      bool
	Namespace   string
	NodeName    string
	HostNetwork bool

	// Containers specifies all containers in this pod.
	Containers PodContainers

	DeletedAt time.Time
}

Pod represents a kubernetes pod.

type PodContainers added in v0.76.1 

type PodContainers struct {
	// ByID specifies all containers in a pod by container ID.
	ByID map[string]*Container
	// ByName specifies all containers in a pod by container name (k8s.container.name).
	ByName map[string]*Container
}

PodContainers specifies a list of pod containers. It is not safe for concurrent use.

type PodIdentifier 

type PodIdentifier [PodIdentifierMaxLength]PodIdentifierAttribute

PodIdentifier is a custom type to represent Pod identification

func (*PodIdentifier) IsNotEmpty added in v0.55.0 

func (p *PodIdentifier) IsNotEmpty() bool

IsNotEmpty checks if PodIdentifier is empty or not

type PodIdentifierAttribute added in v0.55.0 

type PodIdentifierAttribute struct {
	Source AssociationSource
	Value  string
}

PodIdentifierAttribute represents AssociationSource with matching value for pod

func PodIdentifierAttributeFromConnection added in v0.55.0 

func PodIdentifierAttributeFromConnection(value string) PodIdentifierAttribute

PodIdentifierAttributeFromSource builds PodIdentifierAttribute for connection with given value

func PodIdentifierAttributeFromResourceAttribute added in v0.55.0 

func PodIdentifierAttributeFromResourceAttribute(key string, value string) PodIdentifierAttribute

PodIdentifierAttributeFromSource builds PodIdentifierAttribute for given resource_attribute name and value

func PodIdentifierAttributeFromSource added in v0.55.0 

func PodIdentifierAttributeFromSource(source AssociationSource, value string) PodIdentifierAttribute

PodIdentifierAttributeFromSource builds PodIdentifierAttribute using AssociationSource and value

type ReplicaSet added in v0.78.0 

type ReplicaSet struct {
	Name       string
	Namespace  string
	UID        string
	Deployment Deployment
}

ReplicaSet represents a kubernetes replicaset.

type WatchClient 

type WatchClient struct {

	// A map containing Pod related data, used to associate them with resources.
	// Key can be either an IP address or Pod UID
	Pods         map[PodIdentifier]*Pod
	Rules        ExtractionRules
	Filters      Filters
	Associations []Association
	Exclude      Excludes

	// A map containing Namespace related data, used to associate them with resources.
	// Key is namespace name
	Namespaces map[string]*Namespace

	// A map containing Node related data, used to associate them with resources.
	// Key is node name
	Nodes map[string]*Node

	// A map containing ReplicaSets related data, used to associate them with resources.
	// Key is replicaset uid
	ReplicaSets map[string]*ReplicaSet
	// contains filtered or unexported fields
}

WatchClient is the main interface provided by this package to a kubernetes cluster.

func (*WatchClient) GetNamespace 

func (c *WatchClient) GetNamespace(namespace string) (*Namespace, bool)

GetNamespace takes a namespace and returns the namespace object the namespace is associated with.

func (*WatchClient) GetNode added in v0.89.0 

func (c *WatchClient) GetNode(nodeName string) (*Node, bool)

GetNode takes a node name and returns the node object the node name is associated with.

func (*WatchClient) GetPod 

func (c *WatchClient) GetPod(identifier PodIdentifier) (*Pod, bool)

GetPod takes an IP address or Pod UID and returns the pod the identifier is associated with.

func (*WatchClient) Start 

func (c *WatchClient) Start() error

Start registers pod event handlers and starts watching the kubernetes cluster for pod changes.

func (*WatchClient) Stop 

func (c *WatchClient) Stop()

Stop signals the the k8s watcher/informer to stop watching for new events.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.