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

update paths for documentation

Browse Source 
Change-Id: I369b6972b2b6af2bab4561b1af824812ead95e0e
This commit is contained in:
Han Kang 2022-10-31 09:17:50 -07:00
parent 3628532311
commit fbdd02da40
4 changed files with 144 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

90
test/instrumentation/testdata/documentation-list.yaml → test/instrumentation/documentation/documentation-list.yaml
View File

@ -281,6 +281,7 @@
stabilityLevel: ALPHA
labels:
- completion_mode
- reason
- result
- name: job_pods_finished_total
subsystem: job_controller
@ -324,6 +325,16 @@
- action
- completion_mode
- result
- name: pod_failures_handled_by_failure_policy_total
subsystem: job_controller
help: "`The number of failed Pods handled by failure policy with\n\t\t\trespect
to the failure policy action applied based on the matched\n\t\t\trule. Possible
values of the action label correspond to the\n\t\t\tpossible values for the failure
policy rule action, which are:\n\t\t\t\"FailJob\", \"Ignore\" and \"Count\".`"
type: Counter
stabilityLevel: ALPHA
labels:
- action
- name: terminated_pods_tracking_finalizer_total
subsystem: job_controller
help: |-
@ -547,6 +558,16 @@
help: Counter of certificate renewal errors.
type: Counter
stabilityLevel: ALPHA
- name: retroactive_storageclass_errors_total
help: Total number of failed retroactive StorageClass assignments to persistent
volume claim
type: Counter
stabilityLevel: ALPHA
- name: retroactive_storageclass_total
help: Total number of retroactive StorageClass assignments to persistent volume
claim
type: Counter
stabilityLevel: ALPHA
- name: volume_operation_total_errors
help: Total volume operation errors
type: Counter
@ -584,6 +605,16 @@
- 4
- 8
- 16
- name: cpu_manager_pinning_errors_total
subsystem: kubelet
help: The number of cpu core allocations which required pinning failed.
type: Counter
stabilityLevel: ALPHA
- name: cpu_manager_pinning_requests_total
subsystem: kubelet
help: The number of cpu core allocations which required pinning.
type: Counter
stabilityLevel: ALPHA
- name: device_plugin_alloc_duration_seconds
subsystem: kubelet
help: Duration in seconds to serve a device plugin Allocation request. Broken down
@ -1727,6 +1758,52 @@
- 4.096
- 8.192
- 16.384
- name: check_duration_seconds
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.
type: Histogram
stabilityLevel: ALPHA
labels:
- enforcement_action
- params
- policy
- policy_binding
- state
- validation_expression
buckets:
- 5e-07
- 0.001
- 0.01
- 0.1
- 1
- 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.
type: Counter
stabilityLevel: ALPHA
labels:
- enforcement_action
- params
- policy
- policy_binding
- state
- validation_expression
- name: definition_total
subsystem: validating_admission_policy
namespace: apiserver
help: Validation admission policy count total, labeled by state and enforcement
action.
type: Counter
stabilityLevel: ALPHA
labels:
- enforcement_action
- state
- name: step_admission_duration_seconds_summary
subsystem: admission
namespace: apiserver
@ -2736,6 +2813,13 @@
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: envelope_transformation_cache_misses_total
subsystem: storage
namespace: apiserver
@ -2855,12 +2939,6 @@
stabilityLevel: ALPHA
labels:
- resource
- name: etcd_db_total_size_in_bytes
help: Total size of the etcd database file physically allocated in bytes.
type: Gauge
stabilityLevel: ALPHA
labels:
- endpoint
- name: etcd_lease_object_counts
help: Number of objects attached to a single etcd lease.
type: Histogram

66
test/instrumentation/testdata/documentation.md → test/instrumentation/documentation/documentation.md
View File

@ -6,10 +6,10 @@ description: >-
---
## Metrics (auto-generated 2022 Oct 27)
## Metrics (auto-generated 2022 Oct 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 metrics in Prometheus format.
components using an HTTP scrape, and fetch the current metrics data in Prometheus format.
### List of Stable Kubernetes Metrics
@ -554,6 +554,12 @@ components using an HTTP scrape, and fetch the metrics in Prometheus format.
<td class="metric_description">Total number of failed data encryption key(DEK) generation operations.</td>
<td class="metric_labels_varying">None</td>
<td class="metric_labels_constant">None</td></tr>
<tr class="metric"><td class="metric_name">apiserver_storage_db_total_size_in_bytes</td>
<td class="metric_stability_level" data-stability="alpha">ALPHA</td>
<td class="metric_type" data-type="gauge">Gauge</td>
<td class="metric_description">Total size of the storage database file physically allocated in bytes.</td>
<td class="metric_labels_varying"><div class="metric_label">endpoint</div></td>
<td class="metric_labels_constant">None</td></tr>
<tr class="metric"><td class="metric_name">apiserver_storage_envelope_transformation_cache_misses_total</td>
<td class="metric_stability_level" data-stability="alpha">ALPHA</td>
<td class="metric_type" data-type="counter">Counter</td>
@ -608,6 +614,24 @@ components using an HTTP scrape, and fetch the metrics in Prometheus format.
<td class="metric_description">Number of requests dropped with 'TLS handshake error from' error</td>
<td class="metric_labels_varying">None</td>
<td class="metric_labels_constant">None</td></tr>
<tr class="metric"><td class="metric_name">apiserver_validating_admission_policy_check_duration_seconds</td>
<td class="metric_stability_level" data-stability="alpha">ALPHA</td>
<td class="metric_type" data-type="histogram">Histogram</td>
<td class="metric_description">Validation admission latency for individual validation expressions in seconds, labeled by policy and param resource, further including binding, state and enforcement action taken.</td>
<td class="metric_labels_varying"><div class="metric_label">enforcement_action</div><div class="metric_label">params</div><div class="metric_label">policy</div><div class="metric_label">policy_binding</div><div class="metric_label">state</div><div class="metric_label">validation_expression</div></td>
<td class="metric_labels_constant">None</td></tr>
<tr class="metric"><td class="metric_name">apiserver_validating_admission_policy_check_total</td>
<td class="metric_stability_level" data-stability="alpha">ALPHA</td>
<td class="metric_type" data-type="counter">Counter</td>
<td class="metric_description">Validation admission policy check total, labeled by policy and param resource, and further identified by binding, validation expression, enforcement action taken, and state.</td>
<td class="metric_labels_varying"><div class="metric_label">enforcement_action</div><div class="metric_label">params</div><div class="metric_label">policy</div><div class="metric_label">policy_binding</div><div class="metric_label">state</div><div class="metric_label">validation_expression</div></td>
<td class="metric_labels_constant">None</td></tr>
<tr class="metric"><td class="metric_name">apiserver_validating_admission_policy_definition_total</td>
<td class="metric_stability_level" data-stability="alpha">ALPHA</td>
<td class="metric_type" data-type="counter">Counter</td>
<td class="metric_description">Validation admission policy count total, labeled by state and enforcement action.</td>
<td class="metric_labels_varying"><div class="metric_label">enforcement_action</div><div class="metric_label">state</div></td>
<td class="metric_labels_constant">None</td></tr>
<tr class="metric"><td class="metric_name">apiserver_watch_cache_events_dispatched_total</td>
<td class="metric_stability_level" data-stability="alpha">ALPHA</td>
<td class="metric_type" data-type="counter">Counter</td>
@ -914,12 +938,6 @@ components using an HTTP scrape, and fetch the metrics in Prometheus format.
<td class="metric_description">Number of etcd bookmarks (progress notify events) split by kind.</td>
<td class="metric_labels_varying"><div class="metric_label">resource</div></td>
<td class="metric_labels_constant">None</td></tr>
<tr class="metric"><td class="metric_name">etcd_db_total_size_in_bytes</td>
<td class="metric_stability_level" data-stability="alpha">ALPHA</td>
<td class="metric_type" data-type="gauge">Gauge</td>
<td class="metric_description">Total size of the etcd database file physically allocated in bytes.</td>
<td class="metric_labels_varying"><div class="metric_label">endpoint</div></td>
<td class="metric_labels_constant">None</td></tr>
<tr class="metric"><td class="metric_name">etcd_lease_object_counts</td>
<td class="metric_stability_level" data-stability="alpha">ALPHA</td>
<td class="metric_type" data-type="histogram">Histogram</td>
@ -966,7 +984,7 @@ components using an HTTP scrape, and fetch the metrics in Prometheus format.
<td class="metric_stability_level" data-stability="alpha">ALPHA</td>
<td class="metric_type" data-type="counter">Counter</td>
<td class="metric_description">The number of finished job</td>
<td class="metric_labels_varying"><div class="metric_label">completion_mode</div><div class="metric_label">result</div></td>
<td class="metric_labels_varying"><div class="metric_label">completion_mode</div><div class="metric_label">reason</div><div class="metric_label">result</div></td>
<td class="metric_labels_constant">None</td></tr>
<tr class="metric"><td class="metric_name">job_controller_job_pods_finished_total</td>
<td class="metric_stability_level" data-stability="alpha">ALPHA</td>
@ -986,6 +1004,12 @@ components using an HTTP scrape, and fetch the metrics in Prometheus format.
<td class="metric_description">The number of job syncs</td>
<td class="metric_labels_varying"><div class="metric_label">action</div><div class="metric_label">completion_mode</div><div class="metric_label">result</div></td>
<td class="metric_labels_constant">None</td></tr>
<tr class="metric"><td class="metric_name">job_controller_pod_failures_handled_by_failure_policy_total</td>
<td class="metric_stability_level" data-stability="alpha">ALPHA</td>
<td class="metric_type" data-type="counter">Counter</td>
<td class="metric_description">`The number of failed Pods handled by failure policy with, respect to the failure policy action applied based on the matched, rule. Possible values of the action label correspond to the, possible values for the failure policy rule action, which are:, "FailJob", "Ignore" and "Count".`</td>
<td class="metric_labels_varying"><div class="metric_label">action</div></td>
<td class="metric_labels_constant">None</td></tr>
<tr class="metric"><td class="metric_name">job_controller_terminated_pods_tracking_finalizer_total</td>
<td class="metric_stability_level" data-stability="alpha">ALPHA</td>
<td class="metric_type" data-type="counter">Counter</td>
@ -1064,6 +1088,18 @@ components using an HTTP scrape, and fetch the metrics in Prometheus format.
<td class="metric_description">The number of containers per pod.</td>
<td class="metric_labels_varying">None</td>
<td class="metric_labels_constant">None</td></tr>
<tr class="metric"><td class="metric_name">kubelet_cpu_manager_pinning_errors_total</td>
<td class="metric_stability_level" data-stability="alpha">ALPHA</td>
<td class="metric_type" data-type="counter">Counter</td>
<td class="metric_description">The number of cpu core allocations which required pinning failed.</td>
<td class="metric_labels_varying">None</td>
<td class="metric_labels_constant">None</td></tr>
<tr class="metric"><td class="metric_name">kubelet_cpu_manager_pinning_requests_total</td>
<td class="metric_stability_level" data-stability="alpha">ALPHA</td>
<td class="metric_type" data-type="counter">Counter</td>
<td class="metric_description">The number of cpu core allocations which required pinning.</td>
<td class="metric_labels_varying">None</td>
<td class="metric_labels_constant">None</td></tr>
<tr class="metric"><td class="metric_name">kubelet_device_plugin_alloc_duration_seconds</td>
<td class="metric_stability_level" data-stability="alpha">ALPHA</td>
<td class="metric_type" data-type="histogram">Histogram</td>
@ -1586,6 +1622,18 @@ components using an HTTP scrape, and fetch the metrics in Prometheus format.
<td class="metric_description">Response size in bytes. Broken down by verb and host.</td>
<td class="metric_labels_varying"><div class="metric_label">host</div><div class="metric_label">verb</div></td>
<td class="metric_labels_constant">None</td></tr>
<tr class="metric"><td class="metric_name">retroactive_storageclass_errors_total</td>
<td class="metric_stability_level" data-stability="alpha">ALPHA</td>
<td class="metric_type" data-type="counter">Counter</td>
<td class="metric_description">Total number of failed retroactive StorageClass assignments to persistent volume claim</td>
<td class="metric_labels_varying">None</td>
<td class="metric_labels_constant">None</td></tr>
<tr class="metric"><td class="metric_name">retroactive_storageclass_total</td>
<td class="metric_stability_level" data-stability="alpha">ALPHA</td>
<td class="metric_type" data-type="counter">Counter</td>
<td class="metric_description">Total number of retroactive StorageClass assignments to persistent volume claim</td>
<td class="metric_labels_varying">None</td>
<td class="metric_labels_constant">None</td></tr>
<tr class="metric"><td class="metric_name">root_ca_cert_publisher_sync_duration_seconds</td>
<td class="metric_stability_level" data-stability="alpha">ALPHA</td>
<td class="metric_type" data-type="histogram">Histogram</td>

2
test/instrumentation/documentation/main.go
View File

@ -110,7 +110,7 @@ type templateData struct {
}
func main() {
dat, err := os.ReadFile("test/instrumentation/testdata/documentation-list.yaml")
dat, err := os.ReadFile("test/instrumentation/documentation/documentation-list.yaml")
if err == nil {
var parsedMetrics []metric
err = yaml.Unmarshal(dat, &parsedMetrics)

4
test/instrumentation/stability-utils.sh
View File

@ -114,7 +114,7 @@ kube::update::documentation::list() {
echo "${red}!!! updating golden list of metrics has failed! ${reset}" >&2
exit 1
fi
mv -f "$temp_file" "${KUBE_ROOT}/test/instrumentation/testdata/documentation-list.yaml"
mv -f "$temp_file" "${KUBE_ROOT}/test/instrumentation/documentation/documentation-list.yaml"
echo "${green}Updated list of metrics for documentation ${reset}"
}
@ -126,7 +126,7 @@ kube::update::documentation() {
echo "${red}!!! updating documentation has failed! ${reset}" >&2
exit 1
fi
mv -f "$temp_file" "${KUBE_ROOT}/test/instrumentation/testdata/documentation.md"
mv -f "$temp_file" "${KUBE_ROOT}/test/instrumentation/documentation/documentation.md"
echo "${green}Updated documentation of metrics.${reset}"
}