kubelet

Documentation

Index

• Constants
• Variables
• func MetricsData(logger *zap.Logger, summary *stats.Summary, metadata Metadata, ...) []pmetric.Metrics
• func SetPersistentVolumeLabels(rb *metadata.ResourceBuilder, pv v1.PersistentVolumeSource)
• func ValidateMetadataLabelsConfig(labels []MetadataLabel) error
• type HTTPRestClient
  • func NewRestClient(client kube.Client) *HTTPRestClient
  • func (c *HTTPRestClient) Pods() ([]byte, error)
  • func (c *HTTPRestClient) StatsSummary() ([]byte, error)
• type Metadata
  • func NewMetadata(labels []MetadataLabel, podsMetadata *v1.PodList, nodeCap NodeCapacity, ...) Metadata
• type MetadataLabel
• type MetadataProvider
  • func NewMetadataProvider(rc RestClient) *MetadataProvider
  • func (p *MetadataProvider) Pods() (*v1.PodList, error)
• type MetricGroup
• type NodeCapacity
• type RestClient
• type StatsProvider
  • func NewStatsProvider(rc RestClient) *StatsProvider
  • func (p *StatsProvider) StatsSummary() (*stats.Summary, error)

Constants

const (
	ContainerMetricGroup = MetricGroup("container")
	PodMetricGroup       = MetricGroup("pod")
	NodeMetricGroup      = MetricGroup("node")
	VolumeMetricGroup    = MetricGroup("volume")
)

Values for MetricGroup enum.

Variables

var ValidMetricGroups = map[MetricGroup]bool{
	ContainerMetricGroup: true,
	PodMetricGroup:       true,
	NodeMetricGroup:      true,
	VolumeMetricGroup:    true,
}

ValidMetricGroups map of valid metrics.

Functions

func MetricsData

func MetricsData(
	logger *zap.Logger, summary *stats.Summary,
	metadata Metadata,
	metricGroupsToCollect map[MetricGroup]bool,
	mbs *metadata.MetricsBuilders,
) []pmetric.Metrics

func SetPersistentVolumeLabels

func SetPersistentVolumeLabels(rb *metadata.ResourceBuilder, pv v1.PersistentVolumeSource)

func ValidateMetadataLabelsConfig

func ValidateMetadataLabelsConfig(labels []MetadataLabel) error

ValidateMetadataLabelsConfig validates that provided list of metadata labels is supported

Types

type HTTPRestClient

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

HTTPRestClient is a thin wrapper around a kubelet client, encapsulating endpoints and their corresponding http methods. The endpoints /stats/container /spec/ are excluded because they require cadvisor. The /metrics endpoint is excluded because it returns Prometheus data.

func NewRestClient

func NewRestClient(client kube.Client) *HTTPRestClient

func (*HTTPRestClient) Pods

func (c *HTTPRestClient) Pods() ([]byte, error)

func (*HTTPRestClient) StatsSummary

func (c *HTTPRestClient) StatsSummary() ([]byte, error)

type Metadata

type Metadata struct {
	Labels                    map[MetadataLabel]bool
	PodsMetadata              *v1.PodList
	DetailedPVCResourceSetter func(rb *metadata.ResourceBuilder, volCacheID, volumeClaim, namespace string) error
	// contains filtered or unexported fields
}

func NewMetadata

func NewMetadata(labels []MetadataLabel, podsMetadata *v1.PodList, nodeCap NodeCapacity,
	detailedPVCResourceSetter func(rb *metadata.ResourceBuilder, volCacheID, volumeClaim, namespace string) error,
) Metadata

type MetadataLabel

type MetadataLabel string

const (
	MetadataLabelContainerID MetadataLabel = conventions.AttributeContainerID
	MetadataLabelVolumeType  MetadataLabel = labelVolumeType
)

Values for MetadataLabel enum.

type MetadataProvider

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

MetadataProvider wraps a RestClient, returning an unmarshaled metadata.

func NewMetadataProvider

func NewMetadataProvider(rc RestClient) *MetadataProvider

func (*MetadataProvider) Pods

func (p *MetadataProvider) Pods() (*v1.PodList, error)

Pods calls the /pods endpoint and unmarshals the results into a v1.PodList struct.

type MetricGroup

type MetricGroup string

type NodeCapacity

type NodeCapacity struct {
	Name string
	// node's CPU capacity in cores
	CPUCapacity float64
	// node's Memory capacity in bytes
	MemoryCapacity float64
}

type RestClient

type RestClient interface {
	StatsSummary() ([]byte, error)
	Pods() ([]byte, error)
}

RestClient is swappable for testing.

type StatsProvider

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

StatsProvider wraps a RestClient, returning an unmarshaled stats.Summary struct from the kubelet API.

func NewStatsProvider

func NewStatsProvider(rc RestClient) *StatsProvider

func (*StatsProvider) StatsSummary

func (p *StatsProvider) StatsSummary() (*stats.Summary, error)

StatsSummary calls the /stats/summary kubelet endpoint and unmarshals the results into a stats.Summary struct.