Skip to content

Commit ead3a92

Browse files
Update file location
1 parent 94ae839 commit ead3a92

2 files changed

Lines changed: 5 additions & 5 deletions

File tree

  • contributors/devel/sig-instrumentation

contributors/devel/sig-instrumentation/k8s-metrics-instrumenter/SKILL.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ When graduating a metric from Alpha to Beta or from Beta to Stable, the followin
134134
- Avoid tests that only check if a metric is registered or emitted, or that simply call `.Set()`/`.Inc()`/`.Observe()` and expect the value to change since these do not provide meaningful coverage. Focus on testing the metric's behavior as part of the component's logic.
135135
- For a concrete example of proper metric testing, see the [test example](#adding-a-new-metric) in the "Adding a New Metric" section.
136136

137-
5. **Documentation**: Ensure the metric has a clear and accurate help text description and the metric must be included in the [stable metrics list](https://github.com/kubernetes/kubernetes/blob/master/test/instrumentation/testdata/stable-metrics-list.yaml)
137+
5. **Documentation**: Ensure the metric has a clear and accurate help text description and the metric must be included in the [stable metrics list](https://github.com/kubernetes/kubernetes/blob/master/hack/tools/instrumentation/testdata/stable-metrics-list.yaml)
138138
- See the [instrumentation test README](https://github.com/kubernetes/kubernetes/tree/master/hack/tools/instrumentation/README.md) for steps on how to generate this file correctly
139139

140140
6. **API Review**: Graduating a metric to Beta requires an API review by SIG Instrumentation, as it represents a contractual API agreement. See the [API Review](/contributors/devel/sig-instrumentation/metric-stability.md#api-review) section in the metrics stability documentation.
@@ -145,7 +145,7 @@ The metric must meet all of the requirements for Beta graduation.
145145

146146
1. **Stability validation**: The metric should have been at Beta stability for at least two releases to ensure it has been sufficiently validated in production environments.
147147

148-
2. **Documentation**: The metric must be included in the [stable metrics list](https://github.com/kubernetes/kubernetes/blob/master/test/instrumentation/testdata/stable-metrics-list.yaml)
148+
2. **Documentation**: The metric must be included in the [stable metrics list](https://github.com/kubernetes/kubernetes/blob/master/hack/tools/instrumentation/testdata/stable-metrics-list.yaml)
149149
- See the [instrumentation test README](https://github.com/kubernetes/kubernetes/tree/master/hack/tools/instrumentation/README.md) for steps on how to generate this file correctly
150150

151151
3. **API Review**: Marking a metric as stable is a commitment by the owning SIG to maintain stability guarantees. The owning SIG leads must review and approve the graduation first. Additionally, approval from SIG Instrumentation is required as it represents a contractual API agreement. See the [API Review](/contributors/devel/sig-instrumentation/metric-stability.md#api-review) section in the metrics stability documentation.

contributors/devel/sig-instrumentation/k8s-metrics-reviewer/SKILL.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ Confirm the change is in-scope. In-scope signals (any of):
2525
- Touches `k8s.io/component-base/metrics` or imports it.
2626
- Adds/changes a `metrics.NewCounterVec / NewGauge / NewHistogram / NewSummary` (the
2727
**component-base** wrappers, not raw `prometheus.NewX`).
28-
- Edits `test/instrumentation/testdata/stable-metrics-list.yaml` (the generated stable-metrics snapshot)
29-
or `test/instrumentation/documentation/...`.
28+
- Edits `hack/tools/instrumentation/testdata/stable-metrics-list.yaml` (the generated stable-metrics snapshot)
29+
or `hack/tools/instrumentation/documentation/...`.
3030
- Changes `StabilityLevel`, `DeprecatedVersion`, metric `Name`/`Subsystem`/`Namespace`, `Help`, `Buckets`, or labels.
3131

3232
If none apply, report "not a metrics change — out of SIG-Instrumentation scope" and stop.
@@ -79,7 +79,7 @@ Go through each item. For every finding, cite the file:line and classify severit
7979

8080
### E. Stable metrics list must be regenerated
8181
- Any change affecting a STABLE/BETA metric must be reflected in
82-
`test/instrumentation/testdata/stable-metrics-list.yaml`.
82+
`hack/tools/instrumentation/testdata/stable-metrics-list.yaml`.
8383
- The author must run `hack/update-generated-stable-metrics.sh`; CI runs
8484
`hack/verify-generated-stable-metrics.sh`. **BLOCKER** if the metric changed but the snapshot didn't
8585
(or vice-versa) — the diff should be internally consistent.

0 commit comments

Comments
 (0)