diff --git a/content/en/docs/reference/instrumentation/metrics.md b/content/en/docs/reference/instrumentation/metrics.md index 0cc90d8d78..4b5ae9fc9a 100644 --- a/content/en/docs/reference/instrumentation/metrics.md +++ b/content/en/docs/reference/instrumentation/metrics.md @@ -6,16 +6,16 @@ description: >- Details of the metric data that Kubernetes components export. --- -## Metrics (v1.27) +## Metrics (v1.28) - - + + This page details the metrics that different Kubernetes components export. You can query the metrics endpoint for these components using an HTTP scrape, and fetch the current metrics data in Prometheus format. ### List of Stable Kubernetes Metrics -Stable metrics observe strict API contracts and no labels can be added or removed from stable metrics during their lifetime. +Stable metrics observe strict API contracts and no labels can be added or removed from stable metrics during their lifetime. @@ -225,8 +225,7 @@ Stable metrics observe strict API contracts and no labels can be added or remove ### List of Beta Kubernetes Metrics -Beta metrics observe a looser API contract than its stable counterparts. No labels can be removed from beta metrics during their lifetime, however, labels can be added while the metric is in the beta stage. This offers the assurance that beta metrics will honor existing dashboards and alerts, while allowing for amendments in the future. - +Beta metrics observe a looser API contract than its stable counterparts. No labels can be removed from beta metrics during their lifetime, however, labels can be added while the metric is in the beta stage. This offers the assurance that beta metrics will honor existing dashboards and alerts, while allowing for amendments in the future.
@@ -242,12 +241,103 @@ Beta metrics observe a looser API contract than its stable counterparts. No labe + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
apiserver_flowcontrol_current_executing_requestsBETAGaugeNumber of requests in initial (for a WATCH) or any (for a non-WATCH) execution stage in the API Priority and Fairness subsystem
flow_schema
priority_level
apiserver_flowcontrol_current_executing_seatsBETAGaugeConcurrency (number of seats) occupied by the currently executing (initial stage for a WATCH, any stage otherwise) requests in the API Priority and Fairness subsystem
flow_schema
priority_level
apiserver_flowcontrol_current_inqueue_requestsBETAGaugeNumber of requests currently pending in queues of the API Priority and Fairness subsystem
flow_schema
priority_level
apiserver_flowcontrol_dispatched_requests_totalBETACounterNumber of requests executed by API Priority and Fairness subsystem
flow_schema
priority_level
apiserver_flowcontrol_nominal_limit_seatsBETAGaugeNominal number of execution seats configured for each priority level
priority_level
apiserver_flowcontrol_rejected_requests_totalBETACounterNumber of requests rejected by API Priority and Fairness subsystem
flow_schema
priority_level
reason
apiserver_flowcontrol_request_wait_duration_secondsBETAHistogramLength of time a request spent waiting in its queue
execute
flow_schema
priority_level
disabled_metrics_totalBETACounterThe count of disabled metrics.
hidden_metrics_totalBETACounterThe count of hidden metrics.
kubernetes_feature_enabledBETAGaugeThis metric records the data about the stage and enablement of a k8s feature.
name
stage
kubernetes_healthcheckBETAGaugeThis metric records the result of a single healthcheck.
name
type
kubernetes_healthchecks_totalBETACounterThis metric records the results of all healthcheck.
name
status
type
registered_metrics_totalBETACounterThe count of registered metrics broken by stability level and deprecation version.
deprecated_version
stability_level
### List of Alpha Kubernetes Metrics -Alpha metrics do not have any API guarantees. These metrics must be used at your own risk, subsequent versions of Kubernetes may remove these metrics altogether, or mutate the API in such a way that breaks existing dashboards and alerts. +Alpha metrics do not have any API guarantees. These metrics must be used at your own risk, subsequent versions of Kubernetes may remove these metrics altogether, or mutate the API in such a way that breaks existing dashboards and alerts. @@ -312,11 +402,25 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your - + - - + + + + + + + + + + + + + + + + @@ -431,7 +535,21 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your - + + + + + + + + + + + + + + + @@ -494,6 +612,27 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your + + + + + + + + + + + + + + + + + + + + + @@ -543,20 +682,6 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your - - - - - - - - - - - - - - @@ -613,13 +738,6 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your - - - - - - - @@ -655,13 +773,6 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your - - - - - - - @@ -683,27 +794,20 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your - - - - - - - - + - + - + @@ -725,13 +829,6 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your - - - - - - - @@ -844,6 +941,13 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your + + + + + + + @@ -871,7 +975,7 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your - + @@ -921,6 +1025,13 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your + + + + + + + @@ -931,7 +1042,7 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your - + @@ -1019,11 +1130,11 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your - + - + @@ -1082,6 +1193,20 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your + + + + + + + + + + + + + + @@ -1208,6 +1333,13 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your + + + + + + + @@ -1369,6 +1501,20 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your + + + + + + + + + + + + + + @@ -1495,20 +1641,6 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your - - - - - - - - - - - - - - @@ -1967,14 +2099,14 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your - + - + @@ -2083,6 +2215,34 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -2104,6 +2264,13 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your + + + + + + + @@ -2121,7 +2288,7 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your - + @@ -2167,27 +2334,6 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your - - - - - - - - - - - - - - - - - - - - - @@ -2237,6 +2383,20 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your + + + + + + + + + + + + + + @@ -2321,6 +2481,13 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your + + + + + + + @@ -2346,14 +2513,14 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your - + - + @@ -2384,6 +2551,13 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your + + + + + + + @@ -2468,6 +2642,13 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your + + + + + + + @@ -2531,6 +2712,20 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your + + + + + + + + + + + + + + @@ -2601,13 +2796,6 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your - - - - - - -
crd
group
reason
version
apiserver_admission_admission_match_condition_evaluation_errors_total
apiserver_admission_match_condition_evaluation_errors_total ALPHA CounterAdmission match condition evaluation errors count, identified by name of resource containing the match condition and broken out for each admission type (validating or mutating).
name
type
Admission match condition evaluation errors count, identified by name of resource containing the match condition and broken out for each kind containing matchConditions (webhook or policy), operation and admission type (validate or admit).
kind
name
operation
type
apiserver_admission_match_condition_evaluation_secondsALPHAHistogramAdmission match condition evaluation time in seconds, identified by name and broken out for each kind containing matchConditions (webhook or policy), operation and type (validate or admit).
kind
name
operation
type
apiserver_admission_match_condition_exclusions_totalALPHACounterAdmission match condition evaluation exclusions count, identified by name of resource containing the match condition and broken out for each kind containing matchConditions (webhook or policy), operation and admission type (validate or admit).
kind
name
operation
type
apiserver_admission_step_admission_duration_seconds_summary
apiserver_crd_webhook_conversion_duration_seconds
apiserver_conversion_webhook_duration_secondsALPHAHistogramConversion webhook request latency
failure_type
result
apiserver_conversion_webhook_request_totalALPHACounterCounter for conversion webhook requests with success/failure and failure error type
failure_type
result
apiserver_crd_conversion_webhook_duration_seconds ALPHA Histogram CRD webhook conversion duration in seconds
protocol
transport
apiserver_encryption_config_controller_automatic_reload_failures_totalALPHACounterTotal number of failed automatic reloads of encryption configuration.
apiserver_encryption_config_controller_automatic_reload_last_timestamp_secondsALPHAGaugeTimestamp of the last successful or failed automatic reload of encryption configuration.
status
apiserver_encryption_config_controller_automatic_reload_success_totalALPHACounterTotal number of successful automatic reloads of encryption configuration.
apiserver_envelope_encryption_dek_cache_fill_percent ALPHA Gauge
grpc_status_code
method_name
provider_name
apiserver_flowcontrol_current_executing_requestsALPHAGaugeNumber of requests in initial (for a WATCH) or any (for a non-WATCH) execution stage in the API Priority and Fairness subsystem
flow_schema
priority_level
apiserver_flowcontrol_current_inqueue_requestsALPHAGaugeNumber of requests currently pending in queues of the API Priority and Fairness subsystem
flow_schema
priority_level
apiserver_flowcontrol_current_limit_seats ALPHA Gauge
priority_level
apiserver_flowcontrol_dispatched_requests_totalALPHACounterNumber of requests executed by API Priority and Fairness subsystem
flow_schema
priority_level
apiserver_flowcontrol_epoch_advance_total ALPHA Counter
bound
priority_level
apiserver_flowcontrol_nominal_limit_seatsALPHAGaugeNominal number of execution seats configured for each priority level
priority_level
apiserver_flowcontrol_priority_level_request_utilization ALPHA TimingRatioHistogram
phase
request_kind
apiserver_flowcontrol_rejected_requests_totalALPHACounterNumber of requests rejected by API Priority and Fairness subsystem
flow_schema
priority_level
reason
apiserver_flowcontrol_request_concurrency_in_use ALPHA Gauge Concurrency (number of seats) occupied by the currently executing (initial stage for a WATCH, any stage otherwise) requests in the API Priority and Fairness subsystem
flow_schema
priority_level
1.31.0
apiserver_flowcontrol_request_concurrency_limit ALPHA GaugeShared concurrency limit in the API Priority and Fairness subsystemNominal number of execution seats configured for each priority level
priority_level
1.30.0
apiserver_flowcontrol_request_dispatch_no_accommodation_total ALPHA Counter
flow_schema
priority_level
apiserver_flowcontrol_request_wait_duration_secondsALPHAHistogramLength of time a request spent waiting in its queue
execute
flow_schema
priority_level
apiserver_flowcontrol_seat_fair_frac ALPHA Gauge
code_path
apiserver_rerouted_request_totalALPHACounterTotal number of requests that were proxied to a peer kube apiserver because the local apiserver was not capable of serving it
code
apiserver_selfrequest_total ALPHA CounterTotal size of the storage database file physically allocated in bytes.
endpoint
1.28.0
apiserver_storage_decode_errors_total ALPHA Counter
resource
apiserver_storage_size_bytesALPHACustomSize of the storage database file physically allocated in bytes.
cluster
apiserver_storage_transformation_duration_seconds ALPHA Histogram
apiserver_storage_transformation_operations_total ALPHA CounterTotal number of transformations.Total number of transformations. Successful transformation will have a status 'OK' and a varied status string when the transformation fails. This status and transformation_type fields may be used for alerting on encryption/decryption failure using transformation_type from_storage for decryption and to_storage for encryption
status
transformation_type
transformer_prefix
attachdetach_controller_forced_detaches
attach_detach_controller_attachdetach_controller_forced_detaches ALPHA Counter Number of times the A/D Controller performed a forced detach
reason
attachdetach_controller_total_volumes
status
authorization_attempts_totalALPHACounterCounter of authorization attempts broken down by result. It can be either 'allowed', 'denied', 'no-opinion' or 'error'.
result
authorization_duration_secondsALPHAHistogramAuthorization duration in seconds broken out by result.
result
cloud_provider_webhook_request_duration_seconds ALPHA Histogram
container
pod
namespace
container_swap_usage_bytesALPHACustomCurrent amount of the container swap usage in bytes. Reported only on non-windows systems
container
pod
namespace
csi_operations_seconds ALPHA Histogram
operation
type
etcd_request_errors_totalALPHACounterEtcd failed request counts for each operation and object type.
operation
type
etcd_requests_totalALPHACounterEtcd request counts for each operation and object type.
operation
type
etcd_version_info ALPHA Gauge
kube_apiserver_nodeport_allocator_allocation_errors_totalALPHACounterNumber of errors trying to allocate NodePort
scope
kube_apiserver_nodeport_allocator_allocation_totalALPHACounterNumber of NodePort allocations
scope
kube_apiserver_nodeport_allocator_available_ports ALPHA Gauge
kubelet_started_host_process_containers_errors_total ALPHA CounterCumulative number of errors when starting hostprocess containers. This metric will only be collected on Windows and requires WindowsHostProcessContainers feature gate to be enabled.Cumulative number of errors when starting hostprocess containers. This metric will only be collected on Windows.
code
container_type
kubelet_started_host_process_containers_total ALPHA CounterCumulative number of hostprocess containers started. This metric will only be collected on Windows and requires WindowsHostProcessContainers feature gate to be enabled.Cumulative number of hostprocess containers started. This metric will only be collected on Windows.
container_type
kubeproxy_proxy_healthz_totalALPHACounterCumulative proxy healthz HTTP status
code
kubeproxy_proxy_livez_totalALPHACounterCumulative proxy livez HTTP status
code
kubeproxy_sync_full_proxy_rules_duration_secondsALPHAHistogramSyncProxyRules latency in seconds for full resyncs
kubeproxy_sync_partial_proxy_rules_duration_secondsALPHAHistogramSyncProxyRules latency in seconds for partial resyncs
kubeproxy_sync_proxy_rules_duration_seconds ALPHA Histogram
kubeproxy_sync_proxy_rules_iptables_lastALPHAGaugeNumber of iptables rules written by kube-proxy in last sync
table
kubeproxy_sync_proxy_rules_iptables_partial_restore_failures_total ALPHA Counter
kubeproxy_sync_proxy_rules_iptables_total ALPHA GaugeNumber of proxy iptables rules programmedTotal number of iptables rules owned by kube-proxy
table
build_date
compiler
git_commit
git_tree_state
git_version
go_version
major
minor
platform
kubernetes_feature_enabledALPHAGaugeThis metric records the data about the stage and enablement of a k8s feature.
name
stage
kubernetes_healthcheckALPHAGaugeThis metric records the result of a single healthcheck.
name
type
kubernetes_healthchecks_totalALPHACounterThis metric records the results of all healthcheck.
name
status
type
leader_election_master_status ALPHA Gauge
zone
node_controller_cloud_provider_taint_removal_delay_secondsALPHAHistogramNumber of seconds after node creation when NodeController removed the cloud-provider taint of a single node.
node_controller_initial_node_sync_delay_secondsALPHAHistogramNumber of seconds after node creation when NodeController finished the initial synchronization of a single node.
node_cpu_usage_seconds_total ALPHA Custom
node_swap_usage_bytesALPHACustomCurrent swap usage of the node in bytes. Reported only on non-windows systems
number_of_l4_ilbs ALPHA GaugeALPHA Counter Number of errors encountered when forcefully deleting the pods since the Pod GC Controller started.
namespace
reason
pod_gc_collector_force_delete_pods_total ALPHA Counter Number of pods that are being forcefully deleted since the Pod GC Controller started.
namespace
reason
pod_memory_working_set_bytes
request_operation
resource
subresource
pod_swap_usage_bytesALPHACustomCurrent amount of the pod swap usage in bytes. Reported only on non-windows systems
pod
namespace
prober_probe_duration_seconds ALPHA Histogram
rest_client_dns_resolution_duration_secondsALPHAHistogramDNS resolver latency in seconds. Broken down by host.
host
rest_client_exec_plugin_call_total ALPHA Counter
host
verb
rest_client_transport_cache_entriesALPHAGaugeNumber of transport entries in the internal cache.
rest_client_transport_create_calls_totalALPHACounterNumber of calls to get a new transport, partitioned by the result of the operation hit: obtained from the cache, miss: created and added to the cache, uncacheable: created and not cached
result
retroactive_storageclass_errors_total ALPHA Counter
type
scheduler_scheduler_goroutinesALPHAGaugeNumber of running goroutines split by the work they do such as binding. This metric is replaced by the \"goroutines\" metric.
work
1.26.0
scheduler_scheduling_algorithm_duration_seconds ALPHA Histogram