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

update documentation with descriptions

Browse Source
This commit is contained in:
Han Kang 2023-07-25 08:57:54 -07:00
parent cb6d7fbe66
commit 18a7025383
2 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -8,13 +8,15 @@ description: >-
## Metrics (v1.28)
<!-- (auto-generated 2023 Jul 20) -->
<!-- (auto-generated 2023 Jul 25) -->
<!-- (auto-generated 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.
### List of Stable Kubernetes Metrics
Stable metrics observe strict API contracts and no labels can be added or removed from stable metrics during their lifetime.
<table class="table metrics" caption="This is the list of STABLE metrics emitted from core Kubernetes components">
<thead>
<tr>
@ -223,6 +225,8 @@ components using an HTTP scrape, and fetch the current metrics data in Prometheu
### List of Beta Kubernetes Metrics
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.
<table class="table metrics" caption="This is the list of BETA metrics emitted from core Kubernetes components">
<thead>
<tr>
@ -333,6 +337,8 @@ components using an HTTP scrape, and fetch the current metrics data in Prometheu
### List of Alpha Kubernetes Metrics
Alpha metrics do not have any API guarantees. These metrics must be used at your own risk, subsequent versions of Kubernetes may remove these metrics altogether, or mutate the API in such a way that breaks existing dashboards and alerts.
<table class="table metrics" caption="This is the list of ALPHA metrics emitted from core Kubernetes components">
<thead>
<tr>

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

@ -58,6 +58,8 @@ components using an HTTP scrape, and fetch the current metrics data in Prometheu
### List of Stable Kubernetes Metrics
Stable metrics observe strict API contracts and no labels can be added or removed from stable metrics during their lifetime.
<table class="table metrics" caption="This is the list of STABLE metrics emitted from core Kubernetes components">
<thead>
<tr>
@ -84,6 +86,8 @@ components using an HTTP scrape, and fetch the current metrics data in Prometheu
### List of Beta Kubernetes Metrics
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.
<table class="table metrics" caption="This is the list of BETA metrics emitted from core Kubernetes components">
<thead>
<tr>
@ -110,6 +114,8 @@ components using an HTTP scrape, and fetch the current metrics data in Prometheu
### List of Alpha Kubernetes Metrics
Alpha metrics do not have any API guarantees. These metrics must be used at your own risk, subsequent versions of Kubernetes may remove these metrics altogether, or mutate the API in such a way that breaks existing dashboards and alerts.
<table class="table metrics" caption="This is the list of ALPHA metrics emitted from core Kubernetes components">
<thead>
<tr>