diff --git a/test/instrumentation/documentation/documentation-list.yaml b/test/instrumentation/documentation/documentation-list.yaml index f110fa438cb..f29e16ef063 100644 --- a/test/instrumentation/documentation/documentation-list.yaml +++ b/test/instrumentation/documentation/documentation-list.yaml @@ -218,11 +218,6 @@ help: Number of EndpointSlices type: Gauge stabilityLevel: ALPHA -- name: resources_sync_error_total - subsystem: garbagecollector_controller - help: Number of garbage collector resources sync errors - type: Counter - stabilityLevel: ALPHA - name: sync_duration_seconds subsystem: root_ca_cert_publisher help: Number of namespace syncs happened in root ca cert publisher. @@ -270,6 +265,50 @@ - 128 - 256 - 512 +- name: resources_sync_error_total + subsystem: garbagecollector_controller + help: Number of garbage collector resources sync errors + type: Counter + stabilityLevel: ALPHA +- name: metric_computation_duration_seconds + subsystem: horizontal_pod_autoscaler_controller + help: 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 + type: Histogram + stabilityLevel: ALPHA + labels: + - action + - error + - metric_type + buckets: + - 0.001 + - 0.002 + - 0.004 + - 0.008 + - 0.016 + - 0.032 + - 0.064 + - 0.128 + - 0.256 + - 0.512 + - 1.024 + - 2.048 + - 4.096 + - 8.192 + - 16.384 +- name: metric_computation_total + subsystem: horizontal_pod_autoscaler_controller + help: Number of metric computations. The label 'action' should be either 'scale_down', + 'scale_up', or 'none'. Also, the label 'error' should be either 'spec', 'internal', + or 'none'. The label 'metric_type' corresponds to HPA.spec.metrics[*].type + type: Counter + stabilityLevel: ALPHA + labels: + - action + - error + - metric_type - name: reconciliation_duration_seconds subsystem: horizontal_pod_autoscaler_controller help: The time(seconds) that the HPA controller takes to reconcile once. The label @@ -1256,8 +1295,7 @@ - name: started_host_process_containers_errors_total subsystem: kubelet 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. + will only be collected on Windows. type: Counter stabilityLevel: ALPHA labels: @@ -1266,8 +1304,7 @@ - name: started_host_process_containers_total subsystem: kubelet help: Cumulative number of hostprocess containers started. This metric will only - be collected on Windows and requires WindowsHostProcessContainers feature gate - to be enabled. + be collected on Windows. type: Counter stabilityLevel: ALPHA labels: @@ -1565,6 +1602,48 @@ - 240 - 270 - 300 +- name: sync_full_proxy_rules_duration_seconds + subsystem: kubeproxy + help: SyncProxyRules latency in seconds for full resyncs + type: Histogram + stabilityLevel: ALPHA + buckets: + - 0.001 + - 0.002 + - 0.004 + - 0.008 + - 0.016 + - 0.032 + - 0.064 + - 0.128 + - 0.256 + - 0.512 + - 1.024 + - 2.048 + - 4.096 + - 8.192 + - 16.384 +- name: sync_partial_proxy_rules_duration_seconds + subsystem: kubeproxy + help: SyncProxyRules latency in seconds for partial resyncs + type: Histogram + stabilityLevel: ALPHA + buckets: + - 0.001 + - 0.002 + - 0.004 + - 0.008 + - 0.016 + - 0.032 + - 0.064 + - 0.128 + - 0.256 + - 0.512 + - 1.024 + - 2.048 + - 4.096 + - 8.192 + - 16.384 - name: sync_proxy_rules_duration_seconds subsystem: kubeproxy help: SyncProxyRules latency in seconds @@ -1914,15 +1993,6 @@ stabilityLevel: ALPHA labels: - type -- name: scheduler_goroutines - subsystem: scheduler - help: Number of running goroutines split by the work they do such as binding. This - metric is replaced by the \"goroutines\" metric. - type: Gauge - deprecatedVersion: 1.26.0 - stabilityLevel: ALPHA - labels: - - work - name: scheduling_algorithm_duration_seconds subsystem: scheduler help: Scheduling algorithm latency in seconds @@ -2232,25 +2302,40 @@ - 0.0512 - 0.1024 - 0.2048 -- name: apiextensions_openapi_v2_regeneration_count - help: Counter of OpenAPI v2 spec regeneration count broken down by causing CRD name - and reason. +- name: conversion_webhook_duration_seconds + namespace: apiserver + help: Conversion webhook request latency + type: Histogram + stabilityLevel: ALPHA + labels: + - failure_type + - result + buckets: + - 0.005 + - 0.01 + - 0.02 + - 0.05 + - 0.1 + - 0.2 + - 0.5 + - 1 + - 2 + - 5 + - 10 + - 20 + - 30 + - 45 + - 60 +- name: conversion_webhook_request_total + namespace: apiserver + help: Counter for conversion webhook requests with success/failure and failure error + type type: Counter stabilityLevel: ALPHA labels: - - crd - - reason -- name: apiextensions_openapi_v3_regeneration_count - help: Counter of OpenAPI v3 spec regeneration count broken down by group, version, - causing CRD and reason. - type: Counter - stabilityLevel: ALPHA - labels: - - crd - - group - - reason - - version -- name: apiserver_crd_webhook_conversion_duration_seconds + - failure_type + - result +- name: apiserver_crd_conversion_webhook_duration_seconds help: CRD webhook conversion duration in seconds type: Histogram stabilityLevel: ALPHA @@ -2275,6 +2360,24 @@ - 4.096 - 8.192 - 16.384 +- name: apiextensions_openapi_v2_regeneration_count + help: Counter of OpenAPI v2 spec regeneration count broken down by causing CRD name + and reason. + type: Counter + stabilityLevel: ALPHA + labels: + - crd + - reason +- name: apiextensions_openapi_v3_regeneration_count + help: Counter of OpenAPI v3 spec regeneration count broken down by group, version, + causing CRD and reason. + type: Counter + stabilityLevel: ALPHA + labels: + - crd + - group + - reason + - version - name: admission_match_condition_evaluation_errors_total subsystem: admission namespace: apiserver @@ -2844,6 +2947,35 @@ stabilityLevel: ALPHA labels: - status +- name: authorization_attempts_total + help: Counter of authorization attempts broken down by result. It can be either + 'allowed', 'denied', 'no-opinion' or 'error'. + type: Counter + stabilityLevel: ALPHA + labels: + - result +- name: authorization_duration_seconds + help: Authorization duration in seconds broken out by result. + type: Histogram + stabilityLevel: ALPHA + labels: + - result + buckets: + - 0.001 + - 0.002 + - 0.004 + - 0.008 + - 0.016 + - 0.032 + - 0.064 + - 0.128 + - 0.256 + - 0.512 + - 1.024 + - 2.048 + - 4.096 + - 8.192 + - 16.384 - name: field_validation_request_duration_seconds help: Response latency distribution in seconds for each field validation value type: Histogram @@ -3140,243 +3272,6 @@ - 13.1072 - 26.2144 - 52.4288 -- name: init_events_total - namespace: apiserver - help: Counter of init events processed in watch cache broken by resource type. - type: Counter - stabilityLevel: ALPHA - labels: - - resource -- name: data_key_generation_duration_seconds - subsystem: storage - namespace: apiserver - help: Latencies in seconds of data encryption key(DEK) generation operations. - type: Histogram - stabilityLevel: ALPHA - buckets: - - 5e-06 - - 1e-05 - - 2e-05 - - 4e-05 - - 8e-05 - - 0.00016 - - 0.00032 - - 0.00064 - - 0.00128 - - 0.00256 - - 0.00512 - - 0.01024 - - 0.02048 - - 0.04096 -- name: data_key_generation_failures_total - subsystem: storage - namespace: apiserver - help: Total number of failed data encryption key(DEK) generation operations. - type: Counter - stabilityLevel: ALPHA -- name: storage_db_total_size_in_bytes - subsystem: apiserver - help: Total size of the storage database file physically allocated in bytes. - type: Gauge - stabilityLevel: ALPHA - labels: - - endpoint -- name: storage_decode_errors_total - namespace: apiserver - help: Number of stored object decode errors split by object type - type: Counter - stabilityLevel: ALPHA - labels: - - resource -- name: envelope_transformation_cache_misses_total - subsystem: storage - namespace: apiserver - help: Total number of cache misses while accessing key decryption key(KEK). - type: Counter - stabilityLevel: ALPHA -- name: storage_events_received_total - subsystem: apiserver - help: Number of etcd events received split by kind. - type: Counter - stabilityLevel: ALPHA - labels: - - resource -- name: apiserver_storage_list_evaluated_objects_total - help: Number of objects tested in the course of serving a LIST request from storage - type: Counter - stabilityLevel: ALPHA - labels: - - resource -- name: apiserver_storage_list_fetched_objects_total - help: Number of objects read from storage in the course of serving a LIST request - type: Counter - stabilityLevel: ALPHA - labels: - - resource -- name: apiserver_storage_list_returned_objects_total - help: Number of objects returned for a LIST request from storage - type: Counter - stabilityLevel: ALPHA - labels: - - resource -- name: apiserver_storage_list_total - help: Number of LIST requests served from storage - type: Counter - stabilityLevel: ALPHA - labels: - - resource -- name: transformation_duration_seconds - subsystem: storage - namespace: apiserver - help: Latencies in seconds of value transformation operations. - type: Histogram - stabilityLevel: ALPHA - labels: - - transformation_type - - transformer_prefix - buckets: - - 5e-06 - - 1e-05 - - 2e-05 - - 4e-05 - - 8e-05 - - 0.00016 - - 0.00032 - - 0.00064 - - 0.00128 - - 0.00256 - - 0.00512 - - 0.01024 - - 0.02048 - - 0.04096 - - 0.08192 - - 0.16384 - - 0.32768 - - 0.65536 - - 1.31072 - - 2.62144 - - 5.24288 - - 10.48576 - - 20.97152 - - 41.94304 - - 83.88608 -- name: transformation_operations_total - subsystem: storage - namespace: apiserver - help: Total number of transformations. - type: Counter - stabilityLevel: ALPHA - labels: - - status - - transformation_type - - transformer_prefix -- name: terminated_watchers_total - namespace: apiserver - help: Counter of watchers closed due to unresponsiveness broken by resource type. - type: Counter - stabilityLevel: ALPHA - labels: - - resource -- name: events_dispatched_total - subsystem: watch_cache - namespace: apiserver - help: Counter of events dispatched in watch cache broken by resource type. - type: Counter - stabilityLevel: ALPHA - labels: - - resource -- name: events_received_total - subsystem: watch_cache - namespace: apiserver - help: Counter of events received in watch cache broken by resource type. - type: Counter - stabilityLevel: ALPHA - labels: - - resource -- name: initializations_total - subsystem: watch_cache - namespace: apiserver - help: Counter of watch cache initializations broken by resource type. - type: Counter - stabilityLevel: ALPHA - labels: - - resource -- name: etcd_bookmark_counts - help: Number of etcd bookmarks (progress notify events) split by kind. - type: Gauge - stabilityLevel: ALPHA - labels: - - resource -- name: etcd_lease_object_counts - help: Number of objects attached to a single etcd lease. - type: Histogram - stabilityLevel: ALPHA - buckets: - - 10 - - 50 - - 100 - - 500 - - 1000 - - 2500 - - 5000 -- name: etcd_request_duration_seconds - help: Etcd request latency in seconds for each operation and object type. - type: Histogram - stabilityLevel: ALPHA - labels: - - operation - - type - buckets: - - 0.005 - - 0.025 - - 0.05 - - 0.1 - - 0.2 - - 0.4 - - 0.6 - - 0.8 - - 1 - - 1.25 - - 1.5 - - 2 - - 3 - - 4 - - 5 - - 6 - - 8 - - 10 - - 15 - - 20 - - 30 - - 45 - - 60 -- name: capacity - subsystem: watch_cache - help: Total capacity of watch cache broken by resource type. - type: Gauge - stabilityLevel: ALPHA - labels: - - resource -- name: capacity_decrease_total - subsystem: watch_cache - help: Total number of watch cache capacity decrease events broken by resource type. - type: Counter - stabilityLevel: ALPHA - labels: - - resource -- name: capacity_increase_total - subsystem: watch_cache - help: Total number of watch cache capacity increase events broken by resource type. - type: Counter - stabilityLevel: ALPHA - labels: - - resource -- name: apiserver_storage_objects - help: Number of stored objects at the time of last check split by kind. - type: Gauge - stabilityLevel: STABLE - labels: - - resource - name: current_executing_requests subsystem: flowcontrol namespace: apiserver @@ -3770,6 +3665,257 @@ - 2 - 4 - 10 +- name: init_events_total + namespace: apiserver + help: Counter of init events processed in watch cache broken by resource type. + type: Counter + stabilityLevel: ALPHA + labels: + - resource +- name: data_key_generation_duration_seconds + subsystem: storage + namespace: apiserver + help: Latencies in seconds of data encryption key(DEK) generation operations. + type: Histogram + stabilityLevel: ALPHA + buckets: + - 5e-06 + - 1e-05 + - 2e-05 + - 4e-05 + - 8e-05 + - 0.00016 + - 0.00032 + - 0.00064 + - 0.00128 + - 0.00256 + - 0.00512 + - 0.01024 + - 0.02048 + - 0.04096 +- name: data_key_generation_failures_total + subsystem: storage + namespace: apiserver + help: Total number of failed data encryption key(DEK) generation operations. + type: Counter + stabilityLevel: ALPHA +- name: storage_db_total_size_in_bytes + subsystem: apiserver + help: Total size of the storage database file physically allocated in bytes. + type: Gauge + stabilityLevel: ALPHA + labels: + - endpoint +- name: storage_decode_errors_total + namespace: apiserver + help: Number of stored object decode errors split by object type + type: Counter + stabilityLevel: ALPHA + labels: + - resource +- name: envelope_transformation_cache_misses_total + subsystem: storage + namespace: apiserver + help: Total number of cache misses while accessing key decryption key(KEK). + type: Counter + stabilityLevel: ALPHA +- name: storage_events_received_total + subsystem: apiserver + help: Number of etcd events received split by kind. + type: Counter + stabilityLevel: ALPHA + labels: + - resource +- name: apiserver_storage_list_evaluated_objects_total + help: Number of objects tested in the course of serving a LIST request from storage + type: Counter + stabilityLevel: ALPHA + labels: + - resource +- name: apiserver_storage_list_fetched_objects_total + help: Number of objects read from storage in the course of serving a LIST request + type: Counter + stabilityLevel: ALPHA + labels: + - resource +- name: apiserver_storage_list_returned_objects_total + help: Number of objects returned for a LIST request from storage + type: Counter + stabilityLevel: ALPHA + labels: + - resource +- name: apiserver_storage_list_total + help: Number of LIST requests served from storage + type: Counter + stabilityLevel: ALPHA + labels: + - resource +- name: transformation_duration_seconds + subsystem: storage + namespace: apiserver + help: Latencies in seconds of value transformation operations. + type: Histogram + stabilityLevel: ALPHA + labels: + - transformation_type + - transformer_prefix + buckets: + - 5e-06 + - 1e-05 + - 2e-05 + - 4e-05 + - 8e-05 + - 0.00016 + - 0.00032 + - 0.00064 + - 0.00128 + - 0.00256 + - 0.00512 + - 0.01024 + - 0.02048 + - 0.04096 + - 0.08192 + - 0.16384 + - 0.32768 + - 0.65536 + - 1.31072 + - 2.62144 + - 5.24288 + - 10.48576 + - 20.97152 + - 41.94304 + - 83.88608 +- name: transformation_operations_total + subsystem: storage + namespace: apiserver + help: Total number of transformations. + type: Counter + stabilityLevel: ALPHA + labels: + - status + - transformation_type + - transformer_prefix +- name: terminated_watchers_total + namespace: apiserver + help: Counter of watchers closed due to unresponsiveness broken by resource type. + type: Counter + stabilityLevel: ALPHA + labels: + - resource +- name: events_dispatched_total + subsystem: watch_cache + namespace: apiserver + help: Counter of events dispatched in watch cache broken by resource type. + type: Counter + stabilityLevel: ALPHA + labels: + - resource +- name: events_received_total + subsystem: watch_cache + namespace: apiserver + help: Counter of events received in watch cache broken by resource type. + type: Counter + stabilityLevel: ALPHA + labels: + - resource +- name: initializations_total + subsystem: watch_cache + namespace: apiserver + help: Counter of watch cache initializations broken by resource type. + type: Counter + stabilityLevel: ALPHA + labels: + - resource +- name: etcd_bookmark_counts + help: Number of etcd bookmarks (progress notify events) split by kind. + type: Gauge + stabilityLevel: ALPHA + labels: + - resource +- name: etcd_lease_object_counts + help: Number of objects attached to a single etcd lease. + type: Histogram + stabilityLevel: ALPHA + buckets: + - 10 + - 50 + - 100 + - 500 + - 1000 + - 2500 + - 5000 +- name: etcd_request_duration_seconds + help: Etcd request latency in seconds for each operation and object type. + type: Histogram + stabilityLevel: ALPHA + labels: + - operation + - type + buckets: + - 0.005 + - 0.025 + - 0.05 + - 0.1 + - 0.2 + - 0.4 + - 0.6 + - 0.8 + - 1 + - 1.25 + - 1.5 + - 2 + - 3 + - 4 + - 5 + - 6 + - 8 + - 10 + - 15 + - 20 + - 30 + - 45 + - 60 +- name: etcd_request_errors_total + help: Etcd failed request counts for each operation and object type. + type: Counter + stabilityLevel: ALPHA + labels: + - operation + - type +- name: etcd_requests_total + help: Etcd request counts for each operation and object type. + type: Counter + stabilityLevel: ALPHA + labels: + - operation + - type +- name: capacity + subsystem: watch_cache + help: Total capacity of watch cache broken by resource type. + type: Gauge + stabilityLevel: ALPHA + labels: + - resource +- name: capacity_decrease_total + subsystem: watch_cache + help: Total number of watch cache capacity decrease events broken by resource type. + type: Counter + stabilityLevel: ALPHA + labels: + - resource +- name: capacity_increase_total + subsystem: watch_cache + help: Total number of watch cache capacity increase events broken by resource type. + type: Counter + stabilityLevel: ALPHA + labels: + - resource +- name: apiserver_storage_objects + help: Number of stored objects at the time of last check split by kind. + type: Gauge + stabilityLevel: STABLE + labels: + - resource - name: x509_insecure_sha1_total subsystem: webhooks namespace: apiserver @@ -4044,6 +4190,18 @@ - 1.048576e+06 - 4.194304e+06 - 1.6777216e+07 +- name: rest_client_transport_cache_entries + help: Number of transport entries in the internal cache. + type: Gauge + stabilityLevel: ALPHA +- name: rest_client_transport_create_calls_total + help: 'Number 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' + type: Counter + stabilityLevel: ALPHA + labels: + - result - name: running_managed_controllers help: Indicates where instances of a controller are currently running type: Gauge diff --git a/test/instrumentation/documentation/documentation.md b/test/instrumentation/documentation/documentation.md index 87dd830d153..adcbac0c55e 100644 --- a/test/instrumentation/documentation/documentation.md +++ b/test/instrumentation/documentation/documentation.md @@ -6,10 +6,10 @@ 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. @@ -424,7 +424,21 @@ components using an HTTP scrape, and fetch the current metrics data in Prometheu