clarify the description of the metric apiserver_storage_objects

[machine424]

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Which issue(s) this PR fixes:

kubernetes/website#43012

Special notes for your reviewer:

Does this PR introduce a user-facing change?

Doc at https://kubernetes.io/docs/reference/instrumentation/metrics/ will be updated

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: machine424 / name: Ayoub Mrini (084deb7)

[k8s-ci-robot]

Welcome @machine424!

It looks like this is your first PR to kubernetes/kubernetes 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/kubernetes has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

[k8s-ci-robot]

Hi @machine424. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[machine424]

cc @dgrisonnet

[dgrisonnet]

/lgtm

/assign @logicalhan

[k8s-ci-robot]

LGTM label has been added.

Git tree hash: e7de8b5cce1fc940a71f2d91756846f7b8202aa6

[dgrisonnet]

For reference, this is where we set the metric to -1 when there is an error when collecting the data from etcd: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apiserver/pkg/registry/generic/registry/store.go#L1583-L1586

[dgrisonnet]

/release-note-none

[dgrisonnet]

/ok-to-test

[dgrisonnet]

@machine424 could you please run ./hack/update-generated-stable-metrics to update the description of the metric in the file used for static analysis?

[machine424]

Was waiting for some tests to fail :)
Done.

[logicalhan]

Have you run the unit tests? I suspect they're going to fail due to the change in the HELP text.

[logicalhan]

/lgtm
/approve

I guess we don't test this metric in our unit tests.

[logicalhan]

/retest

[k8s-ci-robot]

LGTM label has been added.

Git tree hash: 2bcbdb1fd452a2f381445e0ffa2917e60c39a49a

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dgrisonnet, logicalhan, machine424

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• staging/src/k8s.io/apiserver/pkg/storage/etcd3/metrics/OWNERS [logicalhan]
• test/instrumentation/testdata/OWNERS [dgrisonnet,logicalhan]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[dgrisonnet]

@machine424 would you perhaps be interested in covering the unit test gap for this metric in a follow-up PR?

[alexzielenski]

/triage accepted

[machine424]

@dgrisonnet It's already covered by verify-generated-stable-metrics.sh, do you mean adding it to https://github.com/kubernetes/kubernetes/blob/master/test/instrumentation/testdata/pkg/kubelet/metrics/metrics.go?

[dgrisonnet]

The stable metrics verification is just a static check. You can find the unit tests here: https://github.com/machine424/kubernetes/blob/084deb7a7cf147bbafd131ab1a36852a79f08a64/staging/src/k8s.io/apiserver/pkg/storage/etcd3/metrics/metrics_test.go

But as Han mentioned before, there are none for this metric yet.

[machine424]

Thanks, I’ll try to add them then.

[machine424]

Opened a PR here #120827