Skip to content

Commit

Permalink
Merge pull request kubernetes#119564 from logicalhan/update-docs
Browse files Browse the repository at this point in the history
update documentation with descriptions
  • Loading branch information
k8s-ci-robot committed Jul 25, 2023
2 parents 7e0a9a7 + 18a7025 commit 86b44a3
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
8 changes: 7 additions & 1 deletion test/instrumentation/documentation/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down
6 changes: 6 additions & 0 deletions test/instrumentation/documentation/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand All @@ -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>
Expand All @@ -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>
Expand Down

0 comments on commit 86b44a3

Please sign in to comment.