From 8481804620107056321402dec0fb67428ee334c1 Mon Sep 17 00:00:00 2001 From: Mengjiao Liu Date: Mon, 28 Oct 2024 15:52:10 +0800 Subject: [PATCH] Update metrics documentation for v1.31 --- .../docs/reference/instrumentation/metrics.md | 179 +++++++++++------- 1 file changed, 107 insertions(+), 72 deletions(-) diff --git a/content/en/docs/reference/instrumentation/metrics.md b/content/en/docs/reference/instrumentation/metrics.md index a0269c06c7..6acaf5eecc 100644 --- a/content/en/docs/reference/instrumentation/metrics.md +++ b/content/en/docs/reference/instrumentation/metrics.md @@ -6,10 +6,10 @@ description: >- Details of the metric data that Kubernetes components export. --- -## Metrics (v1.30) +## Metrics (v1.31) - - + + 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. @@ -291,6 +291,20 @@ Stable metrics observe strict API contracts and no labels can be added or remove 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.
+
apiserver_cel_compilation_duration_seconds
+
CEL compilation time in seconds.
+
    +
  • BETA
    • +
  • Histogram
    • +
+
+
apiserver_cel_evaluation_duration_seconds
+
CEL evaluation time in seconds.
+
    +
  • BETA
    • +
  • Histogram
    • +
+
apiserver_flowcontrol_current_executing_requests
Number of requests in initial (for a WATCH) or any (for a non-WATCH) execution stage in the API Priority and Fairness subsystem
    @@ -340,6 +354,20 @@ Beta metrics observe a looser API contract than its stable counterparts. No labe
  • Histogram
  • executeflow_schemapriority_level
+
apiserver_validating_admission_policy_check_duration_seconds
+
Validation admission latency for individual validation expressions in seconds, labeled by policy and further including binding and enforcement action taken.
+
    +
  • BETA
    • +
  • Histogram
    • +
  • enforcement_actionerror_typepolicypolicy_binding
+
+
apiserver_validating_admission_policy_check_total
+
Validation admission policy check total, labeled by policy and further identified by binding and enforcement action taken.
+
    +
  • BETA
    • +
  • Counter
    • +
  • enforcement_actionerror_typepolicypolicy_binding
+
disabled_metrics_total
The count of disabled metrics.
    @@ -369,7 +397,7 @@ Beta metrics observe a looser API contract than its stable counterparts. No labe
  • deprecated_versionstability_level
scheduler_pod_scheduling_sli_duration_seconds
-
E2e latency for a pod being scheduled, from the time the pod enters the scheduling queue an d might involve multiple scheduling attempts.
+
E2e latency for a pod being scheduled, from the time the pod enters the scheduling queue and might involve multiple scheduling attempts.
  • BETA
  • Histogram
    • @@ -620,20 +648,6 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your
  • Counter
  • indexresource_prefix
-
apiserver_cel_compilation_duration_seconds
-
CEL compilation time in seconds.
-
    -
  • ALPHA
    • -
  • Histogram
    • -
-
-
apiserver_cel_evaluation_duration_seconds
-
CEL evaluation time in seconds.
-
    -
  • ALPHA
    • -
  • Histogram
    • -
-
apiserver_certificates_registry_csr_honored_duration_total
Total number of issued CSRs with a requested duration that was honored, sliced by signer (only kubernetes.io signer names are specifically identified)
    @@ -1215,6 +1229,13 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your
  • Counter
  • code
+
apiserver_stream_tunnel_requests_total
+
Total number of requests that were handled by the StreamTunnelProxy, which processes streaming PortForward/V2
+
    +
  • ALPHA
    • +
  • Counter
    • +
  • code
+
apiserver_terminated_watchers_total
Counter of watchers closed due to unresponsiveness broken by resource type.
    @@ -1229,26 +1250,12 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your
  • Counter
-
apiserver_validating_admission_policy_check_duration_seconds
-
Validation admission latency for individual validation expressions in seconds, labeled by policy and further including binding, state and enforcement action taken.
-
    -
  • ALPHA
    • -
  • Histogram
    • -
  • enforcement_actionpolicypolicy_bindingstate
-
-
apiserver_validating_admission_policy_check_total
-
Validation admission policy check total, labeled by policy and further identified by binding, enforcement action taken, and state.
+
apiserver_watch_cache_consistent_read_total
+
Counter for consistent reads from cache.
  • ALPHA
  • Counter
    • -
  • enforcement_actionpolicypolicy_bindingstate
-
-
apiserver_validating_admission_policy_definition_total
-
Validation admission policy count total, labeled by state and enforcement action.
-
    -
  • ALPHA
    • -
  • Counter
    • -
  • enforcement_actionstate
+
  • fallbackresourcesuccess
    • apiserver_watch_cache_events_dispatched_total
    Counter of events dispatched in watch cache broken by resource type.
    @@ -1278,6 +1285,13 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your
  • Histogram
  • resource
    • +
    apiserver_watch_cache_resource_version
    +
    Current resource version of watch cache broken by resource type.
    +
      +
    • ALPHA
      • +
    • Gauge
      • +
    • resource
    +
    apiserver_watch_events_sizes
    Watch event size distribution in bytes
      @@ -1404,20 +1418,6 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your
    • Counter
    • codewebhook
    -
    cloudprovider_gce_api_request_duration_seconds
    -
    Latency of a GCE API call
    -
      -
    • ALPHA
      • -
    • Histogram
      • -
    • regionrequestversionzone
    -
    -
    cloudprovider_gce_api_request_errors
    -
    Number of errors for an API call
    -
      -
    • ALPHA
      • -
    • Counter
      • -
    • regionrequestversionzone
    -
    container_swap_usage_bytes
    Current amount of the container swap usage in bytes. Reported only on non-windows systems
      @@ -1642,20 +1642,6 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your
    • Counter
    -
    get_token_count
    -
    Counter of total Token() requests to the alternate token source
    -
      -
    • ALPHA
      • -
    • Counter
      • -
    -
    -
    get_token_fail_count
    -
    Counter of failed Token() requests to the alternate token source
    -
      -
    • ALPHA
      • -
    • Counter
      • -
    -
    horizontal_pod_autoscaler_controller_metric_computation_duration_seconds
    The time(seconds) that the HPA controller takes to calculate one metric. The label 'action' should be either 'scale_down', 'scale_up', or 'none'. The label 'error' should be either 'spec', 'internal', or 'none'. The label 'metric_type' corresponds to HPA.spec.metrics[*].type
      @@ -1726,6 +1712,13 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your
    • Gauge
    • cidr
    +
    kube_apiserver_clusterip_allocator_allocation_duration_seconds
    +
    Duration in seconds to allocate a Cluster IP by ServiceCIDR
    +
      +
    • ALPHA
      • +
    • Histogram
      • +
    • cidr
    +
    kube_apiserver_clusterip_allocator_allocation_errors_total
    Number of errors trying to allocate Cluster IPs
      @@ -1845,6 +1838,13 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your
    • Histogram
    • operation_type
    +
    kubelet_cgroup_version
    +
    cgroup version on the hosts.
    +
      +
    • ALPHA
      • +
    • Gauge
      • +
    +
    kubelet_container_log_filesystem_used_bytes
    Bytes used by the container's logs on the filesystem.
      @@ -2412,6 +2412,20 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your
    • Gauge
    • configlifecyclestatic
    +
    kubeproxy_iptables_ct_state_invalid_dropped_packets_total
    +
    packets dropped by iptables to work around conntrack problems
    +
      +
    • ALPHA
      • +
    • Custom
      • +
    +
    +
    kubeproxy_iptables_localhost_nodeports_accepted_packets_total
    +
    Number of packets accepted on nodeports of loopback interface
    +
      +
    • ALPHA
      • +
    • Custom
      • +
    +
    kubeproxy_network_programming_duration_seconds
    In Cluster Network Programming Latency in seconds
      @@ -2510,6 +2524,20 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your
    • Gauge
    +
    kubeproxy_sync_proxy_rules_nftables_cleanup_failures_total
    +
    Cumulative proxy nftables cleanup failures
    +
      +
    • ALPHA
      • +
    • Counter
      • +
    +
    +
    kubeproxy_sync_proxy_rules_nftables_sync_failures_total
    +
    Cumulative proxy nftables sync failures
    +
      +
    • ALPHA
      • +
    • Counter
      • +
    +
    kubeproxy_sync_proxy_rules_no_local_endpoints_total
    Number of services with a Local traffic policy and no endpoints
      @@ -2650,13 +2678,6 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your
    • Custom
    -
    number_of_l4_ilbs
    -
    Number of L4 ILBs
    -
      -
    • ALPHA
      • -
    • Gauge
      • -
    • feature
    -
    plugin_manager_total_plugins
    Number of plugins in Plugin Manager
      @@ -2732,7 +2753,7 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your
      • ALPHA
      • Custom
        • -
      • namespace
      +
    • namespacestorage_classvolume_attributes_class
    pv_collector_total_pv_count
    Gauge measuring total number of persistent volumes
    @@ -2753,7 +2774,7 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your
    • ALPHA
    • Custom
      • -
    • namespace
    +
  • namespacestorage_classvolume_attributes_class
    • reconstruct_volume_operations_errors_total
    The number of volumes that failed reconstruction from the operating system during kubelet startup.
    @@ -2909,6 +2930,13 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your
  • Gauge
  • managername
    • +
    scheduler_event_handling_duration_seconds
    +
    Event handling latency in seconds.
    +
      +
    • ALPHA
      • +
    • Histogram
      • +
    • event
    +
    scheduler_goroutines
    Number of running goroutines split by the work they do such as binding.
      @@ -2937,6 +2965,13 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your
    • Histogram
    • extension_pointpluginstatus
    +
    scheduler_queueing_hint_execution_duration_seconds
    +
    Duration for running a queueing hint function of a plugin.
    +
      +
    • ALPHA
      • +
    • Histogram
      • +
    • eventhintplugin
    +
    scheduler_scheduler_cache_size
    Number of nodes, pods, and assumed (bound) pods in the scheduler cache.