From 4c9d3a1c420d8604256d95180c8ea8e50ac1534d Mon Sep 17 00:00:00 2001 From: Han Kang Date: Thu, 10 Nov 2022 08:45:43 -0800 Subject: [PATCH] update documentation after code freeze Change-Id: Ifdc6ec5ef8a0070f4f5cae74543671c4ceb01a4d --- .../documentation/documentation-list.yaml | 29 ++++++-------- .../documentation/documentation.md | 39 ++++++++++--------- test/instrumentation/documentation/main.go | 1 + 3 files changed, 33 insertions(+), 36 deletions(-) diff --git a/test/instrumentation/documentation/documentation-list.yaml b/test/instrumentation/documentation/documentation-list.yaml index dad1138b103..35ebfe47718 100644 --- a/test/instrumentation/documentation/documentation-list.yaml +++ b/test/instrumentation/documentation/documentation-list.yaml @@ -553,7 +553,7 @@ If serving certificate is invalid or unused, the value will be +INF. type: Gauge stabilityLevel: ALPHA -- name: kubelet_credential_provider_plugin_duration +- name: credential_provider_plugin_duration subsystem: kubelet help: Duration of execution in seconds for credential provider plugin type: Histogram @@ -572,7 +572,7 @@ - 2.5 - 5 - 10 -- name: kubelet_credential_provider_plugin_errors +- name: credential_provider_plugin_errors subsystem: kubelet help: Number of errors from credential provider plugin type: Counter @@ -2065,17 +2065,15 @@ subsystem: validating_admission_policy namespace: apiserver help: Validation admission latency for individual validation expressions in seconds, - labeled by policy and param resource, further including binding, state and enforcement - action taken. + labeled by policy and further including binding, state and enforcement action + taken. type: Histogram stabilityLevel: ALPHA labels: - enforcement_action - - params - policy - policy_binding - state - - validation_expression buckets: - 5e-07 - 0.001 @@ -2085,18 +2083,15 @@ - name: check_total subsystem: validating_admission_policy namespace: apiserver - help: Validation admission policy check total, labeled by policy and param resource, - and further identified by binding, validation expression, enforcement action taken, - and state. + help: Validation admission policy check total, labeled by policy and further identified + by binding, enforcement action taken, and state. type: Counter stabilityLevel: ALPHA labels: - enforcement_action - - params - policy - policy_binding - state - - validation_expression - name: definition_total subsystem: validating_admission_policy namespace: apiserver @@ -3855,12 +3850,6 @@ - resource_group - source - subscription_id -- name: number_of_l4_ilbs - help: Number of L4 ILBs - type: Gauge - stabilityLevel: ALPHA - labels: - - feature - name: cloudprovider_gce_api_request_duration_seconds help: Latency of a GCE API call type: Histogram @@ -3919,6 +3908,12 @@ help: Counter of failed Token() requests to the alternate token source type: Counter stabilityLevel: ALPHA +- name: number_of_l4_ilbs + help: Number of L4 ILBs + type: Gauge + stabilityLevel: ALPHA + labels: + - feature - name: pod_security_errors_total help: Number of errors preventing normal evaluation. Non-fatal errors may result in the latest restricted profile being used for evaluation. diff --git a/test/instrumentation/documentation/documentation.md b/test/instrumentation/documentation/documentation.md index d0a1f007b13..70f48ce97b6 100644 --- a/test/instrumentation/documentation/documentation.md +++ b/test/instrumentation/documentation/documentation.md @@ -1,13 +1,14 @@ --- title: Kubernetes Metrics Reference content_type: reference +auto-generated: true description: >- Details of the metric data that Kubernetes components export. --- ## Metrics (v1.26) - + 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. @@ -848,15 +849,15 @@ components using an HTTP scrape, and fetch the current metrics data in Prometheu apiserver_validating_admission_policy_check_duration_seconds ALPHA Histogram -Validation admission latency for individual validation expressions in seconds, labeled by policy and param resource, further including binding, state and enforcement action taken. -
enforcement_action
params
policy
policy_binding
state
validation_expression
+Validation admission latency for individual validation expressions in seconds, labeled by policy and further including binding, state and enforcement action taken. +
enforcement_action
policy
policy_binding
state
apiserver_validating_admission_policy_check_total ALPHA Counter -Validation admission policy check total, labeled by policy and param resource, and further identified by binding, validation expression, enforcement action taken, and state. -
enforcement_action
params
policy
policy_binding
state
validation_expression
+Validation admission policy check total, labeled by policy and further identified by binding, enforcement action taken, and state. +
enforcement_action
policy
policy_binding
state
apiserver_validating_admission_policy_definition_total @@ -1433,6 +1434,20 @@ components using an HTTP scrape, and fetch the current metrics data in Prometheu +kubelet_credential_provider_plugin_duration +ALPHA +Histogram +Duration of execution in seconds for credential provider plugin +
plugin_name
+ + +kubelet_credential_provider_plugin_errors +ALPHA +Counter +Number of errors from credential provider plugin +
plugin_name
+ + kubelet_device_plugin_alloc_duration_seconds ALPHA Histogram @@ -1496,20 +1511,6 @@ components using an HTTP scrape, and fetch the current metrics data in Prometheu
long_running
method
path
server_type
-kubelet_kubelet_credential_provider_plugin_duration -ALPHA -Histogram -Duration of execution in seconds for credential provider plugin -
plugin_name
- - -kubelet_kubelet_credential_provider_plugin_errors -ALPHA -Counter -Number of errors from credential provider plugin -
plugin_name
- - kubelet_lifecycle_handler_http_fallbacks_total ALPHA Counter diff --git a/test/instrumentation/documentation/main.go b/test/instrumentation/documentation/main.go index 46515a57329..bcbbfe0ddc1 100755 --- a/test/instrumentation/documentation/main.go +++ b/test/instrumentation/documentation/main.go @@ -44,6 +44,7 @@ const ( templ = `--- title: Kubernetes Metrics Reference content_type: reference +auto-generated: true description: >- Details of the metric data that Kubernetes components export. ---