Skip to content

clarify the description of the metric apiserver_storage_objects #120597

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
k8s-ci-robot merged 1 commit into from
Sep 12, 2023
Merged

clarify the description of the metric apiserver_storage_objects #120597

k8s-ci-robot merged 1 commit into from
Sep 12, 2023
+3 −2

Conversation

@machine424
Copy link
Contributor

@machine424 machine424 commented Sep 12, 2023

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.:

@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Sep 12, 2023
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Sep 12, 2023 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

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

@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Sep 12, 2023
@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Sep 12, 2023

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 k8s-ci-robot added needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Sep 12, 2023
@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Sep 12, 2023

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.

Details

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.

@k8s-ci-robot k8s-ci-robot added the needs-priority Indicates a PR lacks a `priority/foo` label and requires one. label Sep 12, 2023
@machine424 machine424 mentioned this pull request Sep 12, 2023
Closed
@k8s-ci-robot k8s-ci-robot added area/apiserver sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. and removed do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Sep 12, 2023
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Sep 12, 2023
@machine424
Copy link
Contributor Author

machine424 commented Sep 12, 2023

cc @dgrisonnet

dgrisonnet
dgrisonnet approved these changes Sep 12, 2023
View reviewed changes
Copy link
Member

@dgrisonnet dgrisonnet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

/assign @logicalhan

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 12, 2023
@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Sep 12, 2023

LGTM label has been added.

DetailsGit tree hash: e7de8b5cce1fc940a71f2d91756846f7b8202aa6

@dgrisonnet
Copy link
Member

dgrisonnet commented Sep 12, 2023 •
edited
Loading

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
Copy link
Member

dgrisonnet commented Sep 12, 2023

/release-note-none

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. and removed do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Sep 12, 2023
@dgrisonnet
Copy link
Member

dgrisonnet commented Sep 12, 2023

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Sep 12, 2023
@dgrisonnet
Copy link
Member

dgrisonnet commented Sep 12, 2023

@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 machine424 force-pushed the apiserver_storage_objects branch from 2f56ff9 to 084deb7 Compare September 12, 2023 14:44
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 12, 2023
@machine424
Copy link
Contributor Author

machine424 commented Sep 12, 2023

Was waiting for some tests to fail :)
Done.

@k8s-ci-robot k8s-ci-robot added area/stable-metrics Issues or PRs involving stable metrics sig/instrumentation Categorizes an issue or PR as relevant to SIG Instrumentation. labels Sep 12, 2023
logicalhan
logicalhan reviewed Sep 12, 2023
View reviewed changes
Copy link
Member

@logicalhan logicalhan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

logicalhan
logicalhan approved these changes Sep 12, 2023
View reviewed changes
Copy link
Member

@logicalhan logicalhan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm
/approve

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

@logicalhan
Copy link
Member

logicalhan commented Sep 12, 2023

/retest

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 12, 2023
@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Sep 12, 2023

LGTM label has been added.

DetailsGit tree hash: 2bcbdb1fd452a2f381445e0ffa2917e60c39a49a

@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Sep 12, 2023

[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

Details Needs approval from an approver in each of these files:

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 12, 2023
@dgrisonnet
Copy link
Member

dgrisonnet commented Sep 12, 2023

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

@alexzielenski
Copy link
Member

alexzielenski commented Sep 12, 2023

/triage accepted

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Sep 12, 2023
@k8s-ci-robot k8s-ci-robot merged commit d147da0 into kubernetes:master Sep 12, 2023
@k8s-ci-robot k8s-ci-robot added this to the v1.29 milestone Sep 12, 2023
@machine424
Copy link
Contributor Author

machine424 commented Sep 13, 2023

@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
Copy link
Member

dgrisonnet commented Sep 15, 2023

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
Copy link
Contributor Author

machine424 commented Sep 15, 2023

Thanks, I’ll try to add them then.

This was referenced Sep 20, 2023
Merged
Merged
@machine424
Copy link
Contributor Author

machine424 commented Sep 22, 2023

Opened a PR here #120827

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@enj enj Awaiting requested review from enj

@wojtek-t wojtek-t Awaiting requested review from wojtek-t

@dgrisonnet dgrisonnet Awaiting requested review from dgrisonnet

1 more reviewer

@logicalhan logicalhan logicalhan approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@logicalhan logicalhan

@dgrisonnet dgrisonnet

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. area/apiserver area/stable-metrics Issues or PRs involving stable metrics cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesn't merit a release note. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. sig/instrumentation Categorizes an issue or PR as relevant to SIG Instrumentation. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Projects

None yet

Milestone

v1.29

Development

Successfully merging this pull request may close these issues.

5 participants

@machine424 @k8s-ci-robot @dgrisonnet @logicalhan @alexzielenski