Affected by 
Documentation
¶
Index ¶
Constants ¶
View Source
const ( KubeletSubsystem = "kubelet" NodeNameKey = "node_name" NodeLabelKey = "node" PodWorkerDurationKey = "pod_worker_duration_seconds" PodStartDurationKey = "pod_start_duration_seconds" PodStartSLIDurationKey = "pod_start_sli_duration_seconds" CgroupManagerOperationsKey = "cgroup_manager_duration_seconds" PodWorkerStartDurationKey = "pod_worker_start_duration_seconds" PodStatusSyncDurationKey = "pod_status_sync_duration_seconds" PLEGRelistDurationKey = "pleg_relist_duration_seconds" PLEGDiscardEventsKey = "pleg_discard_events" PLEGRelistIntervalKey = "pleg_relist_interval_seconds" PLEGLastSeenKey = "pleg_last_seen_seconds" EvictionsKey = "evictions" EvictionStatsAgeKey = "eviction_stats_age_seconds" PreemptionsKey = "preemptions" 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" VolumeStatsHealthStatusAbnormalKey = "volume_stats_health_status_abnormal" RunningPodsKey = "running_pods" RunningContainersKey = "running_containers" // Metrics keys of remote runtime operations RuntimeOperationsKey = "runtime_operations_total" RuntimeOperationsDurationKey = "runtime_operations_duration_seconds" RuntimeOperationsErrorsKey = "runtime_operations_errors_total" // Metrics keys of device plugin operations DevicePluginRegistrationCountKey = "device_plugin_registration_total" DevicePluginAllocationDurationKey = "device_plugin_alloc_duration_seconds" // Metrics keys of pod resources operations PodResourcesEndpointRequestsTotalKey = "pod_resources_endpoint_requests_total" PodResourcesEndpointRequestsListKey = "pod_resources_endpoint_requests_list" PodResourcesEndpointRequestsGetAllocatableKey = "pod_resources_endpoint_requests_get_allocatable" PodResourcesEndpointErrorsListKey = "pod_resources_endpoint_errors_list" PodResourcesEndpointErrorsGetAllocatableKey = "pod_resources_endpoint_errors_get_allocatable" // Metrics keys for RuntimeClass RunPodSandboxDurationKey = "run_podsandbox_duration_seconds" RunPodSandboxErrorsKey = "run_podsandbox_errors_total" // Metrics to keep track of total number of Pods and Containers started StartedPodsTotalKey = "started_pods_total" StartedPodsErrorsTotalKey = "started_pods_errors_total" StartedContainersTotalKey = "started_containers_total" StartedContainersErrorsTotalKey = "started_containers_errors_total" // Metrics to track HostProcess container usage by this kubelet StartedHostProcessContainersTotalKey = "started_host_process_containers_total" StartedHostProcessContainersErrorsTotalKey = "started_host_process_containers_errors_total" // Metrics to track ephemeral container usage by this kubelet ManagedEphemeralContainersKey = "managed_ephemeral_containers" // Metrics to track the CPU manager behavior CPUManagerPinningRequestsTotalKey = "cpu_manager_pinning_requests_total" CPUManagerPinningErrorsTotalKey = "cpu_manager_pinning_errors_total" // Metrics to track the Topology manager behavior TopologyManagerAdmissionRequestsTotalKey = "topology_manager_admission_requests_total" TopologyManagerAdmissionErrorsTotalKey = "topology_manager_admission_errors_total" // Values used in metric labels Container = "container" InitContainer = "init_container" EphemeralContainer = "ephemeral_container" )
This const block defines the metric names for the kubelet metrics.
Variables ¶
View Source
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 Histogram 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: metrics.ExponentialBuckets(1, 2, 5), 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: metrics.DefBuckets, StabilityLevel: metrics.ALPHA, }, []string{"operation_type"}, ) // PodStartDuration is a Histogram that tracks the duration (in seconds) it takes for a single pod to run since it's // first time seen by kubelet. PodStartDuration = metrics.NewHistogram( &metrics.HistogramOpts{ Subsystem: KubeletSubsystem, Name: PodStartDurationKey, Help: "Duration in seconds from kubelet seeing a pod for the first time to the pod starting to run", Buckets: metrics.DefBuckets, StabilityLevel: metrics.ALPHA, }, ) // PodStartSLIDuration is a Histogram that tracks the duration (in seconds) it takes for a single pod to run, // excluding the time for image pulling. This metric should reflect the "Pod startup latency SLI" definition // ref: https://github.com/kubernetes/community/blob/master/sig-scalability/slos/pod_startup_latency.md // // The histogram bucket boundaries for pod startup latency metrics, measured in seconds. These are hand-picked // so as to be roughly exponential but still round numbers in everyday units. This is to minimise the number // of buckets while allowing accurate measurement of thresholds which might be used in SLOs // e.g. x% of pods start up within 30 seconds, or 15 minutes, etc. PodStartSLIDuration = metrics.NewHistogramVec( &metrics.HistogramOpts{ Subsystem: KubeletSubsystem, Name: PodStartSLIDurationKey, Help: "Duration in seconds to start a pod, excluding time to pull images and run init containers, measured from pod creation timestamp to when all its containers are reported as started and observed via watch", Buckets: []float64{0.5, 1, 2, 3, 4, 5, 6, 8, 10, 20, 30, 45, 60, 120, 180, 240, 300, 360, 480, 600, 900, 1200, 1800, 2700, 3600}, StabilityLevel: metrics.ALPHA, }, []string{}, ) // 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: metrics.DefBuckets, StabilityLevel: metrics.ALPHA, }, []string{"operation_type"}, ) // PodWorkerStartDuration is a Histogram that tracks the duration (in seconds) it takes from kubelet seeing a pod to starting a worker. PodWorkerStartDuration = metrics.NewHistogram( &metrics.HistogramOpts{ Subsystem: KubeletSubsystem, Name: PodWorkerStartDurationKey, Help: "Duration in seconds from kubelet seeing a pod to starting a worker.", Buckets: metrics.DefBuckets, StabilityLevel: metrics.ALPHA, }, ) // PodStatusSyncDuration is a Histogram that tracks the duration (in seconds) in takes from the time a pod // status is generated to the time it is synced with the apiserver. If multiple status changes are generated // on a pod before it is written to the API, the latency is from the first update to the last event. PodStatusSyncDuration = metrics.NewHistogram( &metrics.HistogramOpts{ Subsystem: KubeletSubsystem, Name: PodStatusSyncDurationKey, Help: "Duration in seconds to sync a pod status update. Measures time from detection of a change to pod status until the API is successfully updated for that pod, even if multiple intevening changes to pod status occur.", Buckets: []float64{0.010, 0.050, 0.100, 0.500, 1, 5, 10, 20, 30, 45, 60}, 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: metrics.DefBuckets, StabilityLevel: metrics.ALPHA, }, ) // PLEGDiscardEvents is a Counter that tracks the number of discarding events in the Kubelet's Pod Lifecycle Event Generator (PLEG). PLEGDiscardEvents = metrics.NewCounter( &metrics.CounterOpts{ Subsystem: KubeletSubsystem, Name: PLEGDiscardEventsKey, Help: "The number of discard events in PLEG.", StabilityLevel: metrics.ALPHA, }, ) // 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: metrics.DefBuckets, StabilityLevel: metrics.ALPHA, }, ) // PLEGLastSeen is a Gauge giving the Unix timestamp when the Kubelet's // Pod Lifecycle Event Generator (PLEG) was last seen active. PLEGLastSeen = metrics.NewGauge( &metrics.GaugeOpts{ Subsystem: KubeletSubsystem, Name: PLEGLastSeenKey, Help: "Timestamp in seconds when PLEG was last seen active.", 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: metrics.ExponentialBuckets(.005, 2.5, 14), 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: metrics.DefBuckets, StabilityLevel: metrics.ALPHA, }, []string{"eviction_signal"}, ) // Preemptions is a Counter that tracks the cumulative number of pod preemptions initiated by the kubelet. // Broken down by preemption signal. A preemption is only recorded for one resource, the sum of all signals // is the number of preemptions on the given node. Preemptions = metrics.NewCounterVec( &metrics.CounterOpts{ Subsystem: KubeletSubsystem, Name: PreemptionsKey, Help: "Cumulative number of pod preemptions by preemption resource", StabilityLevel: metrics.ALPHA, }, []string{"preemption_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: metrics.DefBuckets, StabilityLevel: metrics.ALPHA, }, []string{"resource_name"}, ) // PodResourcesEndpointRequestsTotalCount is a Counter that tracks the cumulative number of requests to the PodResource endpoints. // Broken down by server API version. PodResourcesEndpointRequestsTotalCount = metrics.NewCounterVec( &metrics.CounterOpts{ Subsystem: KubeletSubsystem, Name: PodResourcesEndpointRequestsTotalKey, Help: "Cumulative number of requests to the PodResource endpoint. Broken down by server api version.", StabilityLevel: metrics.ALPHA, }, []string{"server_api_version"}, ) // PodResourcesEndpointRequestsListCount is a Counter that tracks the number of requests to the PodResource List() endpoint. // Broken down by server API version. PodResourcesEndpointRequestsListCount = metrics.NewCounterVec( &metrics.CounterOpts{ Subsystem: KubeletSubsystem, Name: PodResourcesEndpointRequestsListKey, Help: "Number of requests to the PodResource List endpoint. Broken down by server api version.", StabilityLevel: metrics.ALPHA, }, []string{"server_api_version"}, ) // PodResourcesEndpointRequestsGetAllocatableCount is a Counter that tracks the number of requests to the PodResource GetAllocatableResources() endpoint. // Broken down by server API version. PodResourcesEndpointRequestsGetAllocatableCount = metrics.NewCounterVec( &metrics.CounterOpts{ Subsystem: KubeletSubsystem, Name: PodResourcesEndpointRequestsGetAllocatableKey, Help: "Number of requests to the PodResource GetAllocatableResources endpoint. Broken down by server api version.", StabilityLevel: metrics.ALPHA, }, []string{"server_api_version"}, ) // PodResourcesEndpointErrorsListCount is a Counter that tracks the number of errors returned by he PodResource List() endpoint. // Broken down by server API version. PodResourcesEndpointErrorsListCount = metrics.NewCounterVec( &metrics.CounterOpts{ Subsystem: KubeletSubsystem, Name: PodResourcesEndpointErrorsListKey, Help: "Number of requests to the PodResource List endpoint which returned error. Broken down by server api version.", StabilityLevel: metrics.ALPHA, }, []string{"server_api_version"}, ) // PodResourcesEndpointErrorsGetAllocatableCount is a Counter that tracks the number of errors returned by the PodResource GetAllocatableResources() endpoint. // Broken down by server API version. PodResourcesEndpointErrorsGetAllocatableCount = metrics.NewCounterVec( &metrics.CounterOpts{ Subsystem: KubeletSubsystem, Name: PodResourcesEndpointErrorsGetAllocatableKey, Help: "Number of requests to the PodResource GetAllocatableResources endpoint which returned error. Broken down by server api version.", StabilityLevel: metrics.ALPHA, }, []string{"server_api_version"}, ) // RunPodSandboxDuration is a Histogram that tracks the duration (in seconds) it takes to run Pod Sandbox operations. // Broken down by RuntimeClass.Handler. RunPodSandboxDuration = metrics.NewHistogramVec( &metrics.HistogramOpts{ Subsystem: KubeletSubsystem, Name: RunPodSandboxDurationKey, Help: "Duration in seconds of the run_podsandbox operations. Broken down by RuntimeClass.Handler.", Buckets: metrics.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.Handler. RunPodSandboxErrors = metrics.NewCounterVec( &metrics.CounterOpts{ Subsystem: KubeletSubsystem, Name: RunPodSandboxErrorsKey, Help: "Cumulative number of the run_podsandbox operation errors by RuntimeClass.Handler.", StabilityLevel: metrics.ALPHA, }, []string{"runtime_handler"}, ) // RunningPodCount is a gauge that tracks the number of Pods currently with a running sandbox // It is used to expose the kubelet internal state: how many pods have running containers in the container runtime, and mainly for debugging purpose. RunningPodCount = metrics.NewGauge( &metrics.GaugeOpts{ Subsystem: KubeletSubsystem, Name: RunningPodsKey, Help: "Number of pods that have a running pod sandbox", StabilityLevel: metrics.ALPHA, }, ) // RunningContainerCount is a gauge that tracks the number of containers currently running RunningContainerCount = metrics.NewGaugeVec( &metrics.GaugeOpts{ Subsystem: KubeletSubsystem, Name: RunningContainersKey, Help: "Number of containers currently running", StabilityLevel: metrics.ALPHA, }, []string{"container_state"}, ) // StartedPodsTotal is a counter that tracks pod sandbox creation operations StartedPodsTotal = metrics.NewCounter( &metrics.CounterOpts{ Subsystem: KubeletSubsystem, Name: StartedPodsTotalKey, Help: "Cumulative number of pods started", StabilityLevel: metrics.ALPHA, }, ) // StartedPodsErrorsTotal is a counter that tracks the number of errors creating pod sandboxes StartedPodsErrorsTotal = metrics.NewCounter( &metrics.CounterOpts{ Subsystem: KubeletSubsystem, Name: StartedPodsErrorsTotalKey, Help: "Cumulative number of errors when starting pods", StabilityLevel: metrics.ALPHA, }, ) // StartedContainersTotal is a counter that tracks the number of container creation operations StartedContainersTotal = metrics.NewCounterVec( &metrics.CounterOpts{ Subsystem: KubeletSubsystem, Name: StartedContainersTotalKey, Help: "Cumulative number of containers started", StabilityLevel: metrics.ALPHA, }, []string{"container_type"}, ) // StartedContainersTotal is a counter that tracks the number of errors creating containers StartedContainersErrorsTotal = metrics.NewCounterVec( &metrics.CounterOpts{ Subsystem: KubeletSubsystem, Name: StartedContainersErrorsTotalKey, Help: "Cumulative number of errors when starting containers", StabilityLevel: metrics.ALPHA, }, []string{"container_type", "code"}, ) // StartedHostProcessContainersTotal is a counter that tracks the number of hostprocess container creation operations StartedHostProcessContainersTotal = metrics.NewCounterVec( &metrics.CounterOpts{ Subsystem: KubeletSubsystem, Name: StartedHostProcessContainersTotalKey, Help: "Cumulative number of hostprocess containers started. This metric will only be collected on Windows and requires WindowsHostProcessContainers feature gate to be enabled.", StabilityLevel: metrics.ALPHA, }, []string{"container_type"}, ) // StartedHostProcessContainersErrorsTotal is a counter that tracks the number of errors creating hostprocess containers StartedHostProcessContainersErrorsTotal = metrics.NewCounterVec( &metrics.CounterOpts{ Subsystem: KubeletSubsystem, Name: StartedHostProcessContainersErrorsTotalKey, Help: "Cumulative number of errors when starting hostprocess containers. This metric will only be collected on Windows and requires WindowsHostProcessContainers feature gate to be enabled.", StabilityLevel: metrics.ALPHA, }, []string{"container_type", "code"}, ) // ManagedEphemeralContainers is a gauge that indicates how many ephemeral containers are managed by this kubelet. ManagedEphemeralContainers = metrics.NewGauge( &metrics.GaugeOpts{ Subsystem: KubeletSubsystem, Name: ManagedEphemeralContainersKey, Help: "Current number of ephemeral containers in pods managed by this kubelet.", StabilityLevel: metrics.ALPHA, }, ) // GracefulShutdownStartTime is a gauge that records the time at which the kubelet started graceful shutdown. GracefulShutdownStartTime = metrics.NewGauge( &metrics.GaugeOpts{ Subsystem: KubeletSubsystem, Name: "graceful_shutdown_start_time_seconds", Help: "Last graceful shutdown start time since unix epoch in seconds", StabilityLevel: metrics.ALPHA, }, ) // GracefulShutdownEndTime is a gauge that records the time at which the kubelet completed graceful shutdown. GracefulShutdownEndTime = metrics.NewGauge( &metrics.GaugeOpts{ Subsystem: KubeletSubsystem, Name: "graceful_shutdown_end_time_seconds", Help: "Last graceful shutdown start time since unix epoch in seconds", StabilityLevel: metrics.ALPHA, }, ) LifecycleHandlerHTTPFallbacks = metrics.NewCounter( &metrics.CounterOpts{ Subsystem: KubeletSubsystem, Name: "lifecycle_handler_http_fallbacks_total", Help: "The number of times lifecycle handlers successfully fell back to http from https.", StabilityLevel: metrics.ALPHA, }, ) // CPUManagerPinningRequestsTotal tracks the number of times the pod spec will cause the cpu manager to pin cores CPUManagerPinningRequestsTotal = metrics.NewCounter( &metrics.CounterOpts{ Subsystem: KubeletSubsystem, Name: CPUManagerPinningRequestsTotalKey, Help: "The number of cpu core allocations which required pinning.", StabilityLevel: metrics.ALPHA, }, ) // CPUManagerPinningErrorsTotal tracks the number of times the pod spec required the cpu manager to pin cores, but the allocation failed CPUManagerPinningErrorsTotal = metrics.NewCounter( &metrics.CounterOpts{ Subsystem: KubeletSubsystem, Name: CPUManagerPinningErrorsTotalKey, Help: "The number of cpu core allocations which required pinning failed.", StabilityLevel: metrics.ALPHA, }, ) // TopologyManagerAdmissionRequestsTotal tracks the number of times the pod spec will cause the topology manager to admit a pod TopologyManagerAdmissionRequestsTotal = metrics.NewCounter( &metrics.CounterOpts{ Subsystem: KubeletSubsystem, Name: TopologyManagerAdmissionRequestsTotalKey, Help: "The number of admission requests where resources have to be aligned.", StabilityLevel: metrics.ALPHA, }, ) // TopologyManagerAdmissionErrorsTotal tracks the number of times the pod spec required the topology manager to admit a pod, but the admission failed TopologyManagerAdmissionErrorsTotal = metrics.NewCounter( &metrics.CounterOpts{ Subsystem: KubeletSubsystem, Name: TopologyManagerAdmissionErrorsTotalKey, Help: "The number of admission request failures where resources could not be aligned.", StabilityLevel: metrics.ALPHA, }, ) )
Functions ¶
func GetGather ¶ added in v1.17.0
GetGather returns the gatherer. It used by test case outside current package.
func Register ¶
func Register(collectors ...metrics.StableCollector)
Register registers all metrics.
func SetNodeName ¶ added in v1.14.0
SetNodeName sets the NodeName Gauge to 1.
func SinceInSeconds ¶ added in v1.14.0
SinceInSeconds gets the time since the specified start in seconds.
Types ¶
This section is empty.
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.