Skip to content

Commit e38868f

Browse files
committed
Updating docs/concepts/cluster-administration/system-metrics
Copy editing _Metric lifecycle_ section for clarity. fixes: #20652 Signed-off-by: Nate W <[email protected]>
1 parent 9e010e5 commit e38868f

File tree

1 file changed

+23
-21
lines changed

1 file changed

+23
-21
lines changed

content/en/docs/concepts/cluster-administration/system-metrics.md

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -50,39 +50,41 @@ rules:
5050
5151
## Metric lifecycle
5252
53-
Alpha metric → Stable metric → Deprecated metric → Hidden metric → Deletion
53+
Alpha metric → Stable metric → Deprecated metric → Hidden metric → Deleted metric
5454
55-
Alpha metrics have no stability guarantees; as such they can be modified or deleted at any time.
55+
Alpha metrics have no stability guarantees. These metrics can be modified or deleted at any time.
5656
57-
Stable metrics can be guaranteed to not change; Specifically, stability means:
57+
Stable metrics are guaranteed to not change. This means:
58+
* A stable metric without a deprecated signature will not be deleted or renamed
59+
* A stable metric's type will not be modified
5860
59-
* the metric itself will not be deleted (or renamed)
60-
* the type of metric will not be modified
61+
Deprecated metrics are slated for deletion, but are still available for use.
62+
These metrics include an annotation about the version in which they became deprecated.
6163
62-
Deprecated metric signal that the metric will eventually be deleted; to find which version, you need to check annotation, which includes from which kubernetes version that metric will be considered deprecated.
64+
For example:
6365
64-
Before deprecation:
66+
* Before deprecation
6567
66-
```
67-
# HELP some_counter this counts things
68-
# TYPE some_counter counter
69-
some_counter 0
70-
```
68+
```
69+
# HELP some_counter this counts things
70+
# TYPE some_counter counter
71+
some_counter 0
72+
```
7173

72-
After deprecation:
74+
* After deprecation
7375

74-
```
75-
# HELP some_counter (Deprecated since 1.15.0) this counts things
76-
# TYPE some_counter counter
77-
some_counter 0
78-
```
76+
```
77+
# HELP some_counter (Deprecated since 1.15.0) this counts things
78+
# TYPE some_counter counter
79+
some_counter 0
80+
```
7981

80-
Once a metric is hidden then by default the metrics is not published for scraping. To use a hidden metric, you need to override the configuration for the relevant cluster component.
82+
Hidden metrics are no longer published for scraping, but are still available for use. To use a hidden metric, please refer to the [Show hidden metrics](#show-hidden-metrics) section.
8183

82-
Once a metric is deleted, the metric is not published. You cannot change this using an override.
84+
Deleted metrics are no longer published and cannot be used.
8385

8486

85-
## Show Hidden Metrics
87+
## Show hidden metrics
8688

8789
As described above, admins can enable hidden metrics through a command-line flag on a specific binary. This intends to be used as an escape hatch for admins if they missed the migration of the metrics deprecated in the last release.
8890

0 commit comments

Comments
 (0)