github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-30 06:54:01 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #121686 from logicalhan/update-inst-docs

Browse Source 
update docs for v1.29 release (note this must be committed after code freeze)
This commit is contained in:
Kubernetes Prow Robot 2023-11-02 02:34:57 +01:00 committed by GitHub
commit 6b8b188149
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 238 additions and 162 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

378
test/instrumentation/documentation/documentation-list.yaml
View File

@ -466,6 +466,26 @@
help: Number of ResourceClaims creation request failures
type: Counter
stabilityLevel: ALPHA
- name: job_deletion_duration_seconds
subsystem: ttl_after_finished_controller
help: The time it took to delete the job since it became eligible for deletion
type: Histogram
stabilityLevel: ALPHA
buckets:
- 0.1
- 0.2
- 0.4
- 0.8
- 1.6
- 3.2
- 6.4
- 12.8
- 25.6
- 51.2
- 102.4
- 204.8
- 409.6
- 819.2
- name: job_pods_finished_total
subsystem: job_controller
help: The number of finished Pods that are fully tracked
@ -658,26 +678,6 @@
labels:
- node
- volume_plugin
- name: job_deletion_duration_seconds
subsystem: ttl_after_finished_controller
help: The time it took to delete the job since it became eligible for deletion
type: Histogram
stabilityLevel: ALPHA
buckets:
- 0.1
- 0.2
- 0.4
- 0.8
- 1.6
- 3.2
- 6.4
- 12.8
- 25.6
- 51.2
- 102.4
- 204.8
- 409.6
- 819.2
- name: volume_operation_total_errors
help: Total volume operation errors
type: Counter
@ -685,30 +685,6 @@
labels:
- operation_name
- plugin_name
- name: container_cpu_usage_seconds_total
help: Cumulative cpu time consumed by the container in core-seconds
type: Custom
stabilityLevel: ALPHA
labels:
- container
- pod
- namespace
- name: container_memory_working_set_bytes
help: Current working set of the container in bytes
type: Custom
stabilityLevel: ALPHA
labels:
- container
- pod
- namespace
- name: container_start_time_seconds
help: Start time of the container since unix epoch in seconds
type: Custom
stabilityLevel: ALPHA
labels:
- container
- pod
- namespace
- name: container_swap_usage_bytes
help: Current amount of the container swap usage in bytes. Reported only on non-windows
systems
@ -1352,32 +1328,10 @@
- config
- lifecycle
- static
- name: node_cpu_usage_seconds_total
help: Cumulative cpu time consumed by the node in core-seconds
type: Custom
stabilityLevel: ALPHA
- name: node_memory_working_set_bytes
help: Current working set of the node in bytes
type: Custom
stabilityLevel: ALPHA
- name: node_swap_usage_bytes
help: Current swap usage of the node in bytes. Reported only on non-windows systems
type: Custom
stabilityLevel: ALPHA
- name: pod_cpu_usage_seconds_total
help: Cumulative cpu time consumed by the pod in core-seconds
type: Custom
stabilityLevel: ALPHA
labels:
- pod
- namespace
- name: pod_memory_working_set_bytes
help: Current working set of the pod in bytes
type: Custom
stabilityLevel: ALPHA
labels:
- pod
- namespace
- name: pod_swap_usage_bytes
help: Current amount of the pod swap usage in bytes. Reported only on non-windows
systems
@ -1389,7 +1343,58 @@
- name: scrape_error
help: 1 if there was an error while getting container metrics, 0 otherwise
type: Custom
deprecatedVersion: 1.29.0
stabilityLevel: ALPHA
- name: container_cpu_usage_seconds_total
help: Cumulative cpu time consumed by the container in core-seconds
type: Custom
stabilityLevel: STABLE
labels:
- container
- pod
- namespace
- name: container_memory_working_set_bytes
help: Current working set of the container in bytes
type: Custom
stabilityLevel: STABLE
labels:
- container
- pod
- namespace
- name: container_start_time_seconds
help: Start time of the container since unix epoch in seconds
type: Custom
stabilityLevel: STABLE
labels:
- container
- pod
- namespace
- name: node_cpu_usage_seconds_total
help: Cumulative cpu time consumed by the node in core-seconds
type: Custom
stabilityLevel: STABLE
- name: node_memory_working_set_bytes
help: Current working set of the node in bytes
type: Custom
stabilityLevel: STABLE
- name: pod_cpu_usage_seconds_total
help: Cumulative cpu time consumed by the pod in core-seconds
type: Custom
stabilityLevel: STABLE
labels:
- pod
- namespace
- name: pod_memory_working_set_bytes
help: Current working set of the pod in bytes
type: Custom
stabilityLevel: STABLE
labels:
- pod
- namespace
- name: resource_scrape_error
help: 1 if there was an error while getting container metrics, 0 otherwise
type: Custom
stabilityLevel: STABLE
- name: force_cleaned_failed_volume_operation_errors_total
help: The number of volumes that failed force cleanup after their reconstruction
failed during kubelet startup.
@ -1995,6 +2000,16 @@
stabilityLevel: ALPHA
labels:
- operation
- name: legacy_auto_token_uses_total
subsystem: serviceaccount
help: Cumulative auto-generated legacy tokens used
type: Counter
stabilityLevel: ALPHA
- name: legacy_manual_token_uses_total
subsystem: serviceaccount
help: Cumulative manually created legacy tokens used
type: Counter
stabilityLevel: ALPHA
- name: legacy_tokens_total
subsystem: serviceaccount
help: Cumulative legacy service account tokens used
@ -2010,6 +2025,35 @@
help: Cumulative valid projected service account tokens used
type: Counter
stabilityLevel: ALPHA
- name: pod_scheduling_sli_duration_seconds
subsystem: scheduler
help: E2e latency for a pod being scheduled, from the time the pod enters the scheduling
queue an d might involve multiple scheduling attempts.
type: Histogram
stabilityLevel: BETA
labels:
- attempts
buckets:
- 0.01
- 0.02
- 0.04
- 0.08
- 0.16
- 0.32
- 0.64
- 1.28
- 2.56
- 5.12
- 10.24
- 20.48
- 40.96
- 81.92
- 163.84
- 327.68
- 655.36
- 1310.72
- 2621.44
- 5242.88
- name: kube_pod_resource_limit
help: Resources limit for workloads on the cluster, broken down by pod. This shows
the resource usage the scheduler and kubelet expect per pod for resources along
@ -2087,6 +2131,7 @@
help: E2e latency for a pod being scheduled which may include multiple scheduling
attempts.
type: Histogram
deprecatedVersion: 1.28.0
stabilityLevel: STABLE
labels:
- attempts
@ -2259,24 +2304,6 @@
- 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.
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: conversion_webhook_duration_seconds
namespace: apiserver
help: Conversion webhook request latency
@ -2335,6 +2362,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: match_condition_evaluation_errors_total
subsystem: admission
namespace: apiserver
@ -2642,40 +2687,6 @@
stabilityLevel: ALPHA
labels:
- code
- name: authenticated_user_requests
help: Counter of authenticated requests broken out by username.
type: Counter
stabilityLevel: ALPHA
labels:
- username
- name: authentication_attempts
help: Counter of authenticated attempts.
type: Counter
stabilityLevel: ALPHA
labels:
- result
- name: authentication_duration_seconds
help: Authentication 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: active_fetch_count
subsystem: token_cache
namespace: authentication
@ -2704,35 +2715,6 @@
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: cache_list_fetched_objects_total
namespace: apiserver
help: Number of objects read from watch cache in the course of serving a LIST request
@ -2806,24 +2788,31 @@
- name: automatic_reload_failures_total
subsystem: encryption_config_controller
namespace: apiserver
help: Total number of failed automatic reloads of encryption configuration.
help: Total number of failed automatic reloads of encryption configuration split
by apiserver identity.
type: Counter
stabilityLevel: ALPHA
labels:
- apiserver_id_hash
- name: automatic_reload_last_timestamp_seconds
subsystem: encryption_config_controller
namespace: apiserver
help: Timestamp of the last successful or failed automatic reload of encryption
configuration.
configuration split by apiserver identity.
type: Gauge
stabilityLevel: ALPHA
labels:
- apiserver_id_hash
- status
- name: automatic_reload_success_total
subsystem: encryption_config_controller
namespace: apiserver
help: Total number of successful automatic reloads of encryption configuration.
help: Total number of successful automatic reloads of encryption configuration split
by apiserver identity.
type: Counter
stabilityLevel: ALPHA
labels:
- apiserver_id_hash
- name: init_events_total
namespace: apiserver
help: Counter of init events processed in watch cache broken by resource type.
@ -3146,6 +3135,69 @@
- group
- kind
- version
- name: authenticated_user_requests
help: Counter of authenticated requests broken out by username.
type: Counter
stabilityLevel: ALPHA
labels:
- username
- name: authentication_attempts
help: Counter of authenticated attempts.
type: Counter
stabilityLevel: ALPHA
labels:
- result
- name: authentication_duration_seconds
help: Authentication 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: 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: etcd_bookmark_counts
help: Number of etcd bookmarks (progress notify events) split by kind.
type: Gauge
@ -3400,6 +3452,16 @@
- 7680
- 15360
- 30720
- name: dek_source_cache_size
subsystem: envelope_encryption
namespace: apiserver
help: Number of records in data encryption key (DEK) source cache. On a restart,
this value is an approximation of the number of decrypt RPC calls the server will
make to the KMS plugin.
type: Gauge
stabilityLevel: ALPHA
labels:
- provider_name
- name: invalid_key_id_from_status_total
subsystem: envelope_encryption
namespace: apiserver
@ -3417,6 +3479,7 @@
type: Gauge
stabilityLevel: ALPHA
labels:
- apiserver_id_hash
- key_id_hash
- provider_name
- transformation_type
@ -3427,15 +3490,18 @@
type: Gauge
stabilityLevel: ALPHA
labels:
- apiserver_id_hash
- key_id_hash
- provider_name
- name: key_id_hash_total
subsystem: envelope_encryption
namespace: apiserver
help: Number of times a keyID is used split by transformation type and provider.
help: Number of times a keyID is used split by transformation type, provider, and
apiserver identity.
type: Counter
stabilityLevel: ALPHA
labels:
- apiserver_id_hash
- key_id_hash
- provider_name
- transformation_type
@ -3470,6 +3536,16 @@
- 13.1072
- 26.2144
- 52.4288
- name: current_inqueue_seats
subsystem: flowcontrol
namespace: apiserver
help: Number of seats currently pending in queues of the API Priority and Fairness
subsystem
type: Gauge
stabilityLevel: ALPHA
labels:
- flow_schema
- priority_level
- name: current_limit_seats
subsystem: flowcontrol
namespace: apiserver

22
test/instrumentation/documentation/documentation.md
View File

@ -8,7 +8,7 @@ description: >-
## Metrics (v1.29)
<!-- (auto-generated 2023 Sep 06) -->
<!-- (auto-generated 2023 Nov 01) -->
<!-- (auto-generated v1.29) -->
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.
@ -635,25 +635,25 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">protocol</span><span class="metric_label">transport</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_encryption_config_controller_automatic_reload_failures_total</div>
<div class="metric_help">Total number of failed automatic reloads of encryption configuration.</div>
<div class="metric_help">Total number of failed automatic reloads of encryption configuration split by apiserver identity.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">apiserver_id_hash</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_encryption_config_controller_automatic_reload_last_timestamp_seconds</div>
<div class="metric_help">Timestamp of the last successful or failed automatic reload of encryption configuration.</div>
<div class="metric_help">Timestamp of the last successful or failed automatic reload of encryption configuration split by apiserver identity.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">status</span></li></ul>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">apiserver_id_hash</span><span class="metric_label">status</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_encryption_config_controller_automatic_reload_success_total</div>
<div class="metric_help">Total number of successful automatic reloads of encryption configuration.</div>
<div class="metric_help">Total number of successful automatic reloads of encryption configuration split by apiserver identity.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
</ul>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">apiserver_id_hash</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_envelope_encryption_dek_cache_fill_percent</div>
<div class="metric_help">Percent of the cache slots currently occupied by cached DEKs.</div>
@ -688,21 +688,21 @@ Alpha metrics do not have any API guarantees. These metrics must be used at your
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">key_id_hash</span><span class="metric_label">provider_name</span><span class="metric_label">transformation_type</span></li></ul>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">apiserver_id_hash</span><span class="metric_label">key_id_hash</span><span class="metric_label">provider_name</span><span class="metric_label">transformation_type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_envelope_encryption_key_id_hash_status_last_timestamp_seconds</div>
<div class="metric_help">The last time in seconds when a keyID was returned by the Status RPC call.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="gauge"><label class="metric_detail">Type:</label> <span class="metric_type">Gauge</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">key_id_hash</span><span class="metric_label">provider_name</span></li></ul>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">apiserver_id_hash</span><span class="metric_label">key_id_hash</span><span class="metric_label">provider_name</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_envelope_encryption_key_id_hash_total</div>
<div class="metric_help">Number of times a keyID is used split by transformation type and provider.</div>
<div class="metric_help">Number of times a keyID is used split by transformation type, provider, and apiserver identity.</div>
<ul>
<li><label class="metric_detail">Stability Level:</label><span class="metric_stability_level">ALPHA</span></li>
<li data-type="counter"><label class="metric_detail">Type:</label> <span class="metric_type">Counter</span></li>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">key_id_hash</span><span class="metric_label">provider_name</span><span class="metric_label">transformation_type</span></li></ul>
<li class="metric_labels_varying"><label class="metric_detail">Labels:</label><span class="metric_label">apiserver_id_hash</span><span class="metric_label">key_id_hash</span><span class="metric_label">provider_name</span><span class="metric_label">transformation_type</span></li></ul>
</div><div class="metric" data-stability="alpha">
<div class="metric_name">apiserver_envelope_encryption_kms_operations_latency_seconds</div>
<div class="metric_help">KMS operation duration with gRPC error code status total.</div>