Skip to content
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

apiserver/etcd: add request and request_error metrics #117222

Merged
merged 2 commits into from
Apr 12, 2023
Merged

apiserver/etcd: add request and request_error metrics #117222

merged 2 commits into from
Apr 12, 2023

Conversation

iyear
Copy link
Contributor

@iyear iyear commented Apr 12, 2023 •
edited

What type of PR is this?

/kind feature

What this PR does / why we need it:

Add request and request_error metrics for apiserver etcd storage.

Which issue(s) this PR fixes:

Part of #117167

Special notes for your reviewer:

Does this PR introduce a user-facing change?

Apiserver adds two new metrics `etcd_requests_total` and `etcd_request_errors_total` that allow users to monitor requests to etcd storage, split by operation and resource type.

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

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/feature Categorizes issue or PR as related to a new feature. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Apr 12, 2023
@k8s-ci-robot k8s-ci-robot added sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. 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. and removed do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Apr 12, 2023
@k8s-ci-robot
Copy link
Contributor

Hi @iyear. 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.

@k8s-ci-robot k8s-ci-robot added the needs-priority Indicates a PR lacks a `priority/foo` label and requires one. label Apr 12, 2023
@wojtek-t
Copy link
Member

Thank you for the PR.
/ok-to-test
/assign

This LGTM, but I would like to get confirmation from SIG instrumentation POV.
@dgrisonnet - can you please take a look at it?

/assign @dgrisonnet

@k8s-ci-robot k8s-ci-robot added the ok-to-test Indicates a non-member PR verified by an org member that is safe to test. label Apr 12, 2023
@k8s-ci-robot k8s-ci-robot removed the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Apr 12, 2023
dgrisonnet
dgrisonnet reviewed Apr 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.

Just one comment from my side, otherwise these new metrics look good to me 👍

staging/src/k8s.io/apiserver/pkg/storage/etcd3/metrics/metrics.go Outdated
@@ -47,6 +47,22 @@ var (
},
[]string{"operation", "type"},
)
etcdRequestCounts = compbasemetrics.NewCounterVec(
&compbasemetrics.CounterOpts{
Name: "etcd_request_total",
Copy link
Member

Choose a reason for hiding this comment

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

https://prometheus.io/docs/practices/naming/#metric-names

Suggested change
Name: "etcd_request_total",
Name: "etcd_requests_total",

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Nice suggestion! Updated.

@wojtek-t
Copy link
Member

/label tide/merge-method-squash

/lgtm
/approve

Thanks!

@k8s-ci-robot k8s-ci-robot added tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. lgtm "Looks good to me", indicates that a PR is ready to be merged. labels Apr 12, 2023
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 89027fda55845bed8ea76eef06ee54f447a23414

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

iyear commented Apr 12, 2023

Thank you all:)

dgrisonnet
dgrisonnet approved these changes Apr 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.

Awesome, great work @iyear :)

/lgtm
/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dgrisonnet, iyear, wojtek-t

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:

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

@iyear
Copy link
Contributor Author

iyear commented Apr 12, 2023

/retest

@k8s-ci-robot k8s-ci-robot merged commit 4f6714e into kubernetes:master Apr 12, 2023
@k8s-ci-robot k8s-ci-robot added this to the v1.28 milestone Apr 12, 2023
@fedebongio
Copy link
Contributor

/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 Apr 18, 2023
@shyamjvs
Copy link
Member

@iyear This change deserves a release note for users to monitor the new metric. Can you add one similar to this - #117211 (comment)

@shyamjvs shyamjvs mentioned this pull request Apr 25, 2023
Open
15 tasks
@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed release-note-none Denotes a PR that doesn't merit a release note. labels Apr 26, 2023
@iyear
Copy link
Contributor Author

iyear commented Apr 26, 2023

@shyamjvs Added. Thanks for reply:)

@iyear iyear deleted the apiserver/etcd-metrics branch April 26, 2023 00:20
@bertinatto bertinatto mentioned this pull request Jun 20, 2023
Closed
rayowang pushed a commit to rayowang/kubernetes that referenced this pull request Feb 9, 2024
@iyear
apiserver/etcd: add request and request_error metrics (kubernetes#117222
f59e133 
)

* apiserver/etcd: add request and request_error metrics

Signed-off-by: iyear <[email protected]>

* apiserver/etcd: rename etcdRequestCounts metric

Signed-off-by: iyear <[email protected]>

---------

Signed-off-by: iyear <[email protected]>
@jaskaransarkaria jaskaransarkaria mentioned this pull request Jun 5, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dgrisonnet dgrisonnet dgrisonnet approved these changes

@ingvagabund ingvagabund Awaiting requested review from ingvagabund

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

Assignees

@wojtek-t wojtek-t

@dgrisonnet dgrisonnet

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/apiserver cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/feature Categorizes issue or PR as related to a new feature. 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 Denotes a PR that will be considered when it comes time to generate release notes. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Milestone
v1.28
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@iyear @k8s-ci-robot @wojtek-t @fedebongio @shyamjvs @dgrisonnet