kubernetes/test/instrumentation
Han Kang fbdd02da40 update paths for documentation
Change-Id: I369b6972b2b6af2bab4561b1af824812ead95e0e
2022-10-31 09:20:39 -07:00
..
documentation update paths for documentation 2022-10-31 09:20:39 -07:00
testdata update paths for documentation 2022-10-31 09:20:39 -07:00
decode_metric.go add buckets.go to prometheus import allowlsit 2022-10-18 13:42:28 -07:00
error.go Update test/instrumentation/error.go 2022-07-26 15:31:25 -07:00
find_stable_metric.go add automated documentation generation from our static analysis pipeline 2022-10-25 14:44:09 -04:00
main_test.go update capabilities of static analysis parser 2022-09-27 17:21:14 -07:00
main.go adjust sizes and documentation 2022-10-25 16:32:55 -04:00
metric.go add automated documentation generation from our static analysis pipeline 2022-10-25 14:44:09 -04:00
OWNERS Check in OWNERS modified by update-yamlfmt.sh 2021-12-09 21:31:26 -05:00
README.md add documentation about auto-generating auto-documentation 2022-10-25 15:09:54 -04:00
stability-utils.sh update paths for documentation 2022-10-31 09:20:39 -07:00
test-update.sh Add support for summary metrics for stablity checks 2022-07-26 15:31:25 -07:00
test-verify.sh Add support for summary metrics for stablity checks 2022-07-26 15:31:25 -07:00
update-documentation-metrics.sh add automated documentation generation from our static analysis pipeline 2022-10-25 14:44:09 -04:00
update-documentation.sh add automated documentation generation from our static analysis pipeline 2022-10-25 14:44:09 -04:00

This directory contains the regression test for controlling the list of stable metrics

If you add or remove a stable metric, this test will fail and you will need to update the golden list of tests stored in testdata/. Changes to that file require review by sig-instrumentation.

To update the list, run

./hack/update-generated-stable-metrics.sh

Add the changed file to your PR, then send for review.

If you want to test the stability framework, you can add metrics to the file in test/instrumentation/testdata/pkg/kubelet/metrics/metrics.go and run test verification via:

./test/instrumentation/test-verify.sh

To update the golden test list, you can run:

./test/instrumentation/test-update.sh

To update the list of documented metrics (which you need to run first before upgrading the documentation markdown file).

./test/instrumentation/update-documentation-metrics.sh

To update the documented list of metrics for k8s/website, please run:

./test/instrumentation/update-documentation.sh