metrics

Documentation

Index

• Constants
• Variables
• func Register(containerCache kubecontainer.RuntimeCache, collectors ...prometheus.Collector)
• func SetActiveConfig(source *corev1.NodeConfigSource) error
• func SetAssignedConfig(source *corev1.NodeConfigSource) error
• func SetConfigError(err bool)
• func SetLastKnownGoodConfig(source *corev1.NodeConfigSource) error
• func SetNodeName(name types.NodeName)
• func SinceInMicroseconds(start time.Time) float64
• func SinceInSeconds(start time.Time) float64

Constants

const (
	KubeletSubsystem                     = "kubelet"
	NodeNameKey                          = "node_name"
	NodeLabelKey                         = "node"
	PodWorkerDurationKey                 = "pod_worker_duration_seconds"
	PodStartDurationKey                  = "pod_start_duration_seconds"
	CgroupManagerOperationsKey           = "cgroup_manager_duration_seconds"
	PodWorkerStartDurationKey            = "pod_worker_start_duration_seconds"
	PLEGRelistDurationKey                = "pleg_relist_duration_seconds"
	PLEGDiscardEventsKey                 = "pleg_discard_events"
	PLEGRelistIntervalKey                = "pleg_relist_interval_seconds"
	EvictionsKey                         = "evictions"
	EvictionStatsAgeKey                  = "eviction_stats_age_seconds"
	DeprecatedPodWorkerLatencyKey        = "pod_worker_latency_microseconds"
	DeprecatedPodStartLatencyKey         = "pod_start_latency_microseconds"
	DeprecatedCgroupManagerOperationsKey = "cgroup_manager_latency_microseconds"
	DeprecatedPodWorkerStartLatencyKey   = "pod_worker_start_latency_microseconds"
	DeprecatedPLEGRelistLatencyKey       = "pleg_relist_latency_microseconds"
	DeprecatedPLEGRelistIntervalKey      = "pleg_relist_interval_microseconds"
	DeprecatedEvictionStatsAgeKey        = "eviction_stats_age_microseconds"
	VolumeStatsCapacityBytesKey          = "volume_stats_capacity_bytes"
	VolumeStatsAvailableBytesKey         = "volume_stats_available_bytes"
	VolumeStatsUsedBytesKey              = "volume_stats_used_bytes"
	VolumeStatsInodesKey                 = "volume_stats_inodes"
	VolumeStatsInodesFreeKey             = "volume_stats_inodes_free"
	VolumeStatsInodesUsedKey             = "volume_stats_inodes_used"
	// Metrics keys of remote runtime operations
	RuntimeOperationsKey                  = "runtime_operations_total"
	RuntimeOperationsDurationKey          = "runtime_operations_duration_seconds"
	RuntimeOperationsErrorsKey            = "runtime_operations_errors_total"
	DeprecatedRuntimeOperationsKey        = "runtime_operations"
	DeprecatedRuntimeOperationsLatencyKey = "runtime_operations_latency_microseconds"
	DeprecatedRuntimeOperationsErrorsKey  = "runtime_operations_errors"
	// Metrics keys of device plugin operations
	DevicePluginRegistrationCountKey           = "device_plugin_registration_total"
	DevicePluginAllocationDurationKey          = "device_plugin_alloc_duration_seconds"
	DeprecatedDevicePluginRegistrationCountKey = "device_plugin_registration_count"
	DeprecatedDevicePluginAllocationLatencyKey = "device_plugin_alloc_latency_microseconds"

	// Metric keys for node config
	AssignedConfigKey             = "node_config_assigned"
	ActiveConfigKey               = "node_config_active"
	LastKnownGoodConfigKey        = "node_config_last_known_good"
	ConfigErrorKey                = "node_config_error"
	ConfigSourceLabelKey          = "node_config_source"
	ConfigSourceLabelValueLocal   = "local"
	ConfigUIDLabelKey             = "node_config_uid"
	ConfigResourceVersionLabelKey = "node_config_resource_version"
	KubeletConfigKeyLabelKey      = "node_config_kubelet_key"

	// Metrics keys for RuntimeClass
	RunPodSandboxDurationKey = "run_podsandbox_duration_seconds"
	RunPodSandboxErrorsKey   = "run_podsandbox_errors_total"
)

This const block defines the metric names for the kubelet metrics.

Variables

var (
	// NodeName is a Gauge that tracks the ode's name. The count is always 1.
	NodeName = metrics.NewGaugeVec(
		&metrics.GaugeOpts{
			Subsystem:      KubeletSubsystem,
			Name:           NodeNameKey,
			Help:           "The node's name. The count is always 1.",
			StabilityLevel: metrics.ALPHA,
		},
		[]string{NodeLabelKey},
	)
	// ContainersPerPodCount is a Counter that tracks the number of containers per pod.
	ContainersPerPodCount = metrics.NewHistogram(
		&metrics.HistogramOpts{
			Subsystem:      KubeletSubsystem,
			Name:           "containers_per_pod_count",
			Help:           "The number of containers per pod.",
			Buckets:        prometheus.DefBuckets,
			StabilityLevel: metrics.ALPHA,
		},
	)
	// PodWorkerDuration is a Histogram that tracks the duration (in seconds) in takes to sync a single pod.
	// Broken down by the operation type.
	PodWorkerDuration = metrics.NewHistogramVec(
		&metrics.HistogramOpts{
			Subsystem:      KubeletSubsystem,
			Name:           PodWorkerDurationKey,
			Help:           "Duration in seconds to sync a single pod. Broken down by operation type: create, update, or sync",
			Buckets:        prometheus.DefBuckets,
			StabilityLevel: metrics.ALPHA,
		},
		[]string{"operation_type"},
	)
	// PodStartDuration is a Histogram that tracks the duration (in seconds) it takes for a single pod to go from pending to running.
	PodStartDuration = metrics.NewHistogram(
		&metrics.HistogramOpts{
			Subsystem:      KubeletSubsystem,
			Name:           PodStartDurationKey,
			Help:           "Duration in seconds for a single pod to go from pending to running.",
			Buckets:        prometheus.DefBuckets,
			StabilityLevel: metrics.ALPHA,
		},
	)
	// CgroupManagerDuration is a Histogram that tracks the duration (in seconds) it takes for cgroup manager operations to complete.
	// Broken down by method.
	CgroupManagerDuration = metrics.NewHistogramVec(
		&metrics.HistogramOpts{
			Subsystem:      KubeletSubsystem,
			Name:           CgroupManagerOperationsKey,
			Help:           "Duration in seconds for cgroup manager operations. Broken down by method.",
			Buckets:        prometheus.DefBuckets,
			StabilityLevel: metrics.ALPHA,
		},
		[]string{"operation_type"},
	)
	// PodWorkerStartDuration is a Histogram that tracks the duration (in seconds) it takes from seeing a pod to starting a worker.
	PodWorkerStartDuration = metrics.NewHistogram(
		&metrics.HistogramOpts{
			Subsystem:      KubeletSubsystem,
			Name:           PodWorkerStartDurationKey,
			Help:           "Duration in seconds from seeing a pod to starting a worker.",
			Buckets:        prometheus.DefBuckets,
			StabilityLevel: metrics.ALPHA,
		},
	)
	// PLEGRelistDuration is a Histogram that tracks the duration (in seconds) it takes for relisting pods in the Kubelet's
	// Pod Lifecycle Event Generator (PLEG).
	PLEGRelistDuration = metrics.NewHistogram(
		&metrics.HistogramOpts{
			Subsystem:      KubeletSubsystem,
			Name:           PLEGRelistDurationKey,
			Help:           "Duration in seconds for relisting pods in PLEG.",
			Buckets:        prometheus.DefBuckets,
			StabilityLevel: metrics.ALPHA,
		},
	)
	// PLEGDiscardEvents is a Histogram that tracks the duration (in seconds) it takes for discarding events in the Kubelet's
	// Pod Lifecycle Event Generator (PLEG).
	PLEGDiscardEvents = metrics.NewCounterVec(
		&metrics.CounterOpts{
			Subsystem:      KubeletSubsystem,
			Name:           PLEGDiscardEventsKey,
			Help:           "The number of discard events in PLEG.",
			StabilityLevel: metrics.ALPHA,
		},
		[]string{},
	)
	// PLEGRelistInterval is a Histogram that tracks the intervals (in seconds) between relisting in the Kubelet's
	// Pod Lifecycle Event Generator (PLEG).
	PLEGRelistInterval = metrics.NewHistogram(
		&metrics.HistogramOpts{
			Subsystem:      KubeletSubsystem,
			Name:           PLEGRelistIntervalKey,
			Help:           "Interval in seconds between relisting in PLEG.",
			Buckets:        prometheus.DefBuckets,
			StabilityLevel: metrics.ALPHA,
		},
	)
	// RuntimeOperations is a Counter that tracks the cumulative number of remote runtime operations.
	// Broken down by operation type.
	RuntimeOperations = metrics.NewCounterVec(
		&metrics.CounterOpts{
			Subsystem:      KubeletSubsystem,
			Name:           RuntimeOperationsKey,
			Help:           "Cumulative number of runtime operations by operation type.",
			StabilityLevel: metrics.ALPHA,
		},
		[]string{"operation_type"},
	)
	// RuntimeOperationsDuration is a Histogram that tracks the duration (in seconds) for remote runtime operations to complete.
	// Broken down by operation type.
	RuntimeOperationsDuration = metrics.NewHistogramVec(
		&metrics.HistogramOpts{
			Subsystem:      KubeletSubsystem,
			Name:           RuntimeOperationsDurationKey,
			Help:           "Duration in seconds of runtime operations. Broken down by operation type.",
			Buckets:        prometheus.DefBuckets,
			StabilityLevel: metrics.ALPHA,
		},
		[]string{"operation_type"},
	)
	// RuntimeOperationsErrors is a Counter that tracks the cumulative number of remote runtime operations errors.
	// Broken down by operation type.
	RuntimeOperationsErrors = metrics.NewCounterVec(
		&metrics.CounterOpts{
			Subsystem:      KubeletSubsystem,
			Name:           RuntimeOperationsErrorsKey,
			Help:           "Cumulative number of runtime operation errors by operation type.",
			StabilityLevel: metrics.ALPHA,
		},
		[]string{"operation_type"},
	)
	// Evictions is a Counter that tracks the cumulative number of pod evictions initiated by the kubelet.
	// Broken down by eviction signal.
	Evictions = metrics.NewCounterVec(
		&metrics.CounterOpts{
			Subsystem:      KubeletSubsystem,
			Name:           EvictionsKey,
			Help:           "Cumulative number of pod evictions by eviction signal",
			StabilityLevel: metrics.ALPHA,
		},
		[]string{"eviction_signal"},
	)
	// EvictionStatsAge is a Histogram that tracks the time (in seconds) between when stats are collected and when a pod is evicted
	// based on those stats. Broken down by eviction signal.
	EvictionStatsAge = metrics.NewHistogramVec(
		&metrics.HistogramOpts{
			Subsystem:      KubeletSubsystem,
			Name:           EvictionStatsAgeKey,
			Help:           "Time between when stats are collected, and when pod is evicted based on those stats by eviction signal",
			Buckets:        prometheus.DefBuckets,
			StabilityLevel: metrics.ALPHA,
		},
		[]string{"eviction_signal"},
	)
	// DevicePluginRegistrationCount is a Counter that tracks the cumulative number of device plugin registrations.
	// Broken down by resource name.
	DevicePluginRegistrationCount = metrics.NewCounterVec(
		&metrics.CounterOpts{
			Subsystem:      KubeletSubsystem,
			Name:           DevicePluginRegistrationCountKey,
			Help:           "Cumulative number of device plugin registrations. Broken down by resource name.",
			StabilityLevel: metrics.ALPHA,
		},
		[]string{"resource_name"},
	)
	// DevicePluginAllocationDuration is a Histogram that tracks the duration (in seconds) to serve a device plugin allocation request.
	// Broken down by resource name.
	DevicePluginAllocationDuration = metrics.NewHistogramVec(
		&metrics.HistogramOpts{
			Subsystem:      KubeletSubsystem,
			Name:           DevicePluginAllocationDurationKey,
			Help:           "Duration in seconds to serve a device plugin Allocation request. Broken down by resource name.",
			Buckets:        prometheus.DefBuckets,
			StabilityLevel: metrics.ALPHA,
		},
		[]string{"resource_name"},
	)
	// DeprecatedPodWorkerLatency is a Summary that tracks the latency (in microseconds) to sync a single pod.
	// Broken down by operation type. This metric is deprecated.
	DeprecatedPodWorkerLatency = metrics.NewSummaryVec(
		&metrics.SummaryOpts{
			Subsystem:      KubeletSubsystem,
			Name:           DeprecatedPodWorkerLatencyKey,
			Help:           "(Deprecated) Latency in microseconds to sync a single pod. Broken down by operation type: create, update, or sync",
			StabilityLevel: metrics.ALPHA,
		},
		[]string{"operation_type"},
	)
	// DeprecatedPodStartLatency is a Summary that tracks the latency (in microseconds) for a single pod to go from pending to running.
	// This metric is deprecated.
	DeprecatedPodStartLatency = metrics.NewSummary(
		&metrics.SummaryOpts{
			Subsystem:      KubeletSubsystem,
			Name:           DeprecatedPodStartLatencyKey,
			Help:           "(Deprecated) Latency in microseconds for a single pod to go from pending to running.",
			StabilityLevel: metrics.ALPHA,
		},
	)
	// DeprecatedCgroupManagerLatency is a Summary that tracks the latency (in microseconds) for cgroup manager operations to complete.
	// Broken down by operation type. This metric is deprecated.
	DeprecatedCgroupManagerLatency = metrics.NewSummaryVec(
		&metrics.SummaryOpts{
			Subsystem:      KubeletSubsystem,
			Name:           DeprecatedCgroupManagerOperationsKey,
			Help:           "(Deprecated) Latency in microseconds for cgroup manager operations. Broken down by method.",
			StabilityLevel: metrics.ALPHA,
		},
		[]string{"operation_type"},
	)
	// DeprecatedPodWorkerStartLatency is a Summary that tracks the latency (in microseconds) from seeing a pod to starting a worker.
	// This metric is deprecated.
	DeprecatedPodWorkerStartLatency = metrics.NewSummary(
		&metrics.SummaryOpts{
			Subsystem:      KubeletSubsystem,
			Name:           DeprecatedPodWorkerStartLatencyKey,
			Help:           "(Deprecated) Latency in microseconds from seeing a pod to starting a worker.",
			StabilityLevel: metrics.ALPHA,
		},
	)
	// DeprecatedPLEGRelistLatency is a Summary that tracks the latency (in microseconds) for relisting pods in PLEG.
	// This metric is deprecated.
	DeprecatedPLEGRelistLatency = metrics.NewSummary(
		&metrics.SummaryOpts{
			Subsystem:      KubeletSubsystem,
			Name:           DeprecatedPLEGRelistLatencyKey,
			Help:           "(Deprecated) Latency in microseconds for relisting pods in PLEG.",
			StabilityLevel: metrics.ALPHA,
		},
	)
	// DeprecatedPLEGRelistInterval is a Summary that tracks the interval (in microseconds) between relistings in PLEG.
	// This metric is deprecated.
	DeprecatedPLEGRelistInterval = metrics.NewSummary(
		&metrics.SummaryOpts{
			Subsystem:      KubeletSubsystem,
			Name:           DeprecatedPLEGRelistIntervalKey,
			Help:           "(Deprecated) Interval in microseconds between relisting in PLEG.",
			StabilityLevel: metrics.ALPHA,
		},
	)
	// DeprecatedRuntimeOperations is a Counter that tracks the cumulative number of remote runtime operations.
	// Broken down by operation type. This metric is deprecated.
	DeprecatedRuntimeOperations = metrics.NewCounterVec(
		&metrics.CounterOpts{
			Subsystem:      KubeletSubsystem,
			Name:           DeprecatedRuntimeOperationsKey,
			Help:           "(Deprecated) Cumulative number of runtime operations by operation type.",
			StabilityLevel: metrics.ALPHA,
		},
		[]string{"operation_type"},
	)
	// DeprecatedRuntimeOperationsLatency is a Summary that tracks the latency (in microseconds) of remote runtime operations
	// to complete. Broken down by operation type. This metric is deprecated.
	DeprecatedRuntimeOperationsLatency = metrics.NewSummaryVec(
		&metrics.SummaryOpts{
			Subsystem:      KubeletSubsystem,
			Name:           DeprecatedRuntimeOperationsLatencyKey,
			Help:           "(Deprecated) Latency in microseconds of runtime operations. Broken down by operation type.",
			StabilityLevel: metrics.ALPHA,
		},
		[]string{"operation_type"},
	)
	// DeprecatedRuntimeOperationsErrors is a Counter that tracks the cumulative number of remote runtime operation errors.
	// Broken down by operation type. This metric is deprecated.
	DeprecatedRuntimeOperationsErrors = metrics.NewCounterVec(
		&metrics.CounterOpts{
			Subsystem:      KubeletSubsystem,
			Name:           DeprecatedRuntimeOperationsErrorsKey,
			Help:           "(Deprecated) Cumulative number of runtime operation errors by operation type.",
			StabilityLevel: metrics.ALPHA,
		},
		[]string{"operation_type"},
	)
	// DeprecatedEvictionStatsAge is a Summary that tracks the time (in microseconds) between when stats are collected and when a pod
	// is evicted based on those stats. Broken down by eviction signal. This metric is deprecated.
	DeprecatedEvictionStatsAge = metrics.NewSummaryVec(
		&metrics.SummaryOpts{
			Subsystem:      KubeletSubsystem,
			Name:           DeprecatedEvictionStatsAgeKey,
			Help:           "(Deprecated) Time between when stats are collected, and when pod is evicted based on those stats by eviction signal",
			StabilityLevel: metrics.ALPHA,
		},
		[]string{"eviction_signal"},
	)
	// DeprecatedDevicePluginRegistrationCount is a Counter that tracks the cumulative number of device plugin registrations.
	// Broken down by resource name. This metric is deprecated.
	DeprecatedDevicePluginRegistrationCount = metrics.NewCounterVec(
		&metrics.CounterOpts{
			Subsystem:      KubeletSubsystem,
			Name:           DeprecatedDevicePluginRegistrationCountKey,
			Help:           "(Deprecated) Cumulative number of device plugin registrations. Broken down by resource name.",
			StabilityLevel: metrics.ALPHA,
		},
		[]string{"resource_name"},
	)
	// DeprecatedDevicePluginAllocationLatency is a Summary that tracks the latncy (in microseconds) for serving device plugin allocation requests.
	// Broken down by resource name. This metric is deprecated.
	DeprecatedDevicePluginAllocationLatency = metrics.NewSummaryVec(
		&metrics.SummaryOpts{
			Subsystem:      KubeletSubsystem,
			Name:           DeprecatedDevicePluginAllocationLatencyKey,
			Help:           "(Deprecated) Latency in microseconds to serve a device plugin Allocation request. Broken down by resource name.",
			StabilityLevel: metrics.ALPHA,
		},
		[]string{"resource_name"},
	)

	// AssignedConfig is a Gauge that is set 1 if the Kubelet has a NodeConfig assigned.
	AssignedConfig = metrics.NewGaugeVec(
		&metrics.GaugeOpts{
			Subsystem:      KubeletSubsystem,
			Name:           AssignedConfigKey,
			Help:           "The node's understanding of intended config. The count is always 1.",
			StabilityLevel: metrics.ALPHA,
		},
		[]string{ConfigSourceLabelKey, ConfigUIDLabelKey, ConfigResourceVersionLabelKey, KubeletConfigKeyLabelKey},
	)
	// ActiveConfig is a Gauge that is set to 1 if the Kubelet has an active NodeConfig.
	ActiveConfig = metrics.NewGaugeVec(
		&metrics.GaugeOpts{
			Subsystem:      KubeletSubsystem,
			Name:           ActiveConfigKey,
			Help:           "The config source the node is actively using. The count is always 1.",
			StabilityLevel: metrics.ALPHA,
		},
		[]string{ConfigSourceLabelKey, ConfigUIDLabelKey, ConfigResourceVersionLabelKey, KubeletConfigKeyLabelKey},
	)
	// LastKnownGoodConfig is a Gauge that is set to 1 if the Kubelet has a NodeConfig it can fall back to if there
	// are certain errors.
	LastKnownGoodConfig = metrics.NewGaugeVec(
		&metrics.GaugeOpts{
			Subsystem:      KubeletSubsystem,
			Name:           LastKnownGoodConfigKey,
			Help:           "The config source the node will fall back to when it encounters certain errors. The count is always 1.",
			StabilityLevel: metrics.ALPHA,
		},
		[]string{ConfigSourceLabelKey, ConfigUIDLabelKey, ConfigResourceVersionLabelKey, KubeletConfigKeyLabelKey},
	)
	// ConfigError is a Gauge that is set to 1 if the node is experiencing a configuration-related error.
	ConfigError = metrics.NewGauge(
		&metrics.GaugeOpts{
			Subsystem:      KubeletSubsystem,
			Name:           ConfigErrorKey,
			Help:           "This metric is true (1) if the node is experiencing a configuration-related error, false (0) otherwise.",
			StabilityLevel: metrics.ALPHA,
		},
	)
	// RunPodSandboxDuration is a Histogram that tracks the duration (in seconds) it takes to run Pod Sandbox operations.
	// Broken down by RuntimeClass.
	RunPodSandboxDuration = metrics.NewHistogramVec(
		&metrics.HistogramOpts{
			Subsystem: KubeletSubsystem,
			Name:      RunPodSandboxDurationKey,
			Help:      "Duration in seconds of the run_podsandbox operations. Broken down by RuntimeClass.",

			Buckets:        prometheus.DefBuckets,
			StabilityLevel: metrics.ALPHA,
		},
		[]string{"runtime_handler"},
	)
	// RunPodSandboxErrors is a Counter that tracks the cumulative number of Pod Sandbox operations errors.
	// Broken down by RuntimeClass.
	RunPodSandboxErrors = metrics.NewCounterVec(
		&metrics.CounterOpts{
			Subsystem:      KubeletSubsystem,
			Name:           RunPodSandboxErrorsKey,
			Help:           "Cumulative number of the run_podsandbox operation errors by RuntimeClass.",
			StabilityLevel: metrics.ALPHA,
		},
		[]string{"runtime_handler"},
	)

	// RunningPodCount is a gauge that tracks the number of Pods currently running
	RunningPodCount = metrics.NewGauge(
		&metrics.GaugeOpts{
			Subsystem:      KubeletSubsystem,
			Name:           "running_pod_count",
			Help:           "Number of pods currently running",
			StabilityLevel: metrics.ALPHA,
		},
	)
	// RunningContainerCount is a gauge that tracks the number of containers currently running
	RunningContainerCount = metrics.NewGaugeVec(
		&metrics.GaugeOpts{
			Subsystem:      KubeletSubsystem,
			Name:           "running_container_count",
			Help:           "Number of containers currently running",
			StabilityLevel: metrics.ALPHA,
		},
		[]string{"container_state"},
	)
)

Functions

func Register

func Register(containerCache kubecontainer.RuntimeCache, collectors ...prometheus.Collector)

Register registers all metrics.

func SetActiveConfig

func SetActiveConfig(source *corev1.NodeConfigSource) error

SetActiveConfig tracks labels according to the NodeConfig that is currently used by the Kubelet. It also tracks labels across metric updates so old labels can be safely deleted.

func SetAssignedConfig

func SetAssignedConfig(source *corev1.NodeConfigSource) error

SetAssignedConfig tracks labels according to the assigned NodeConfig. It also tracks labels across metric updates so old labels can be safely deleted.

func SetConfigError

func SetConfigError(err bool)

SetConfigError sets a the ConfigError metric to 1 in case any errors were encountered.

func SetLastKnownGoodConfig

func SetLastKnownGoodConfig(source *corev1.NodeConfigSource) error

SetLastKnownGoodConfig tracks labels according to the NodeConfig that was successfully applied last. It also tracks labels across metric updates so old labels can be safely deleted.

func SetNodeName

func SetNodeName(name types.NodeName)

SetNodeName sets the NodeName Gauge to 1.

func SinceInMicroseconds

func SinceInMicroseconds(start time.Time) float64

SinceInMicroseconds gets the time since the specified start in microseconds.

func SinceInSeconds

func SinceInSeconds(start time.Time) float64

SinceInSeconds gets the time since the specified start in seconds.