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

Fix double counting issue for request metrics on timeout. #83427

Merged
merged 3 commits into from
Oct 22, 2019
Merged

Fix double counting issue for request metrics on timeout. #83427

merged 3 commits into from
Oct 22, 2019

Conversation

logicalhan
Copy link
Member

Currently we record request metrics during the normal request flow; we also manually invoke Record in the timeout handler to record timeouts. This means that we double count requests to our metrics whenever we timeout. To preserve the bits where we do encounter an error but to avoid double-counting our metrics, this PR adds a new metric to represent the running count of apiserver request errors and records occurrences of encountered errors to that new metrics.

This PR also renames the Record function to RecordRequestError to more accurately reflect the intended side-effect of the function call.

What type of PR is this?

/kind bug

Which issue(s) this PR fixes:

Fixes #83424

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

Adds a metric apiserver_request_error_total to kube-apiserver. This metric tallies the number of request_errors encountered by verb, group, version, resource, subresource, scope, component, and code.

Fix double counting issue for request metrics on timeout.
4c6e724 
Currently we record request metrics during the normal request flow and
we also manually invoke `Record` in the timeout handler to record
timeouts. This means that we effectively double count whenever we
timeout. This PR renames the `Record` function to `RecordRequestError`
to more accurately reflect the intended side-effect of the function
call.

Change-Id: Ie37fd0c1e501bd525640a434433d364a5fd6dde2
@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. kind/bug Categorizes issue or PR as related to a bug. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Oct 2, 2019
@k8s-ci-robot k8s-ci-robot requested review from cheftako and sttts October 2, 2019 23:51
@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 needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Oct 2, 2019
@logicalhan
Copy link
Member Author

logicalhan commented Oct 2, 2019 •
edited
Loading

/sig api-machinery instrumentation

@k8s-ci-robot k8s-ci-robot added the sig/instrumentation Categorizes an issue or PR as relevant to SIG Instrumentation. label Oct 2, 2019
@k8s-ci-robot
Copy link
Contributor

@logicalhan: The label(s) priority/importent-soon cannot be applied. These labels are supported: api-review, community/discussion, community/maintenance, community/question, cuj/build-train-deploy, cuj/multi-user, platform/aws, platform/azure, platform/gcp, platform/minikube, platform/other

In response to this:

/sig api-machinery instrumentation
/priority importent-soon

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.

@logicalhan
Copy link
Member Author

/priority important-soon

@k8s-ci-robot k8s-ci-robot added priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. and removed needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Oct 2, 2019
@logicalhan
Copy link
Member Author

/retest

@logicalhan
Copy link
Member Author

For ref: #79609

cheftako
cheftako reviewed Oct 7, 2019
View reviewed changes
staging/src/k8s.io/apiserver/pkg/endpoints/metrics/metrics.go Outdated

requestErrorTotal = compbasemetrics.NewCounterVec(
&compbasemetrics.CounterOpts{
Name: "apiserver_request_error_total",
Copy link
Member

Choose a reason for hiding this comment

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

Pedantic: error should probably be pluralized.

cheftako
cheftako reviewed Oct 7, 2019
View reviewed changes
Copy link
Member

@cheftako cheftako left a comment

Choose a reason for hiding this comment

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

/lgtm
Please take a look at the metric name as I would rather not change it after this is submitted.

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 7, 2019
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 8, 2019
@cheftako
Copy link
Member

cheftako commented Oct 9, 2019

Will lgtm after gofmt.

pluralize error metric name
5e652fe 
Change-Id: I12eb94f41ded20ed5a16332ada13a7b34f75de18
rename metric for apiserver request terminations and reword correspon…
f8f1def 
…ding documentation

Change-Id: I47a9c7b10614afe85bb652fa61984f91848d6d65
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed lgtm "Looks good to me", indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Oct 21, 2019
@logicalhan
Copy link
Member Author

/retest

@lavalamp
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 21, 2019
@lavalamp
Copy link
Member

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lavalamp, logicalhan

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

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 21, 2019
@lavalamp
Copy link
Member

If it is easy, I'd like to cherry-pick this back. This is a major defect in our metrics.

@k8s-ci-robot k8s-ci-robot merged commit aa25739 into kubernetes:master Oct 22, 2019
@k8s-ci-robot k8s-ci-robot added this to the v1.17 milestone Oct 22, 2019
@RainbowMango
Copy link
Member

If it is easy, I'd like to cherry-pick this back. This is a major defect in our metrics.

@lavalamp
Which branches do you want to cherry-pick to? Can I try the cherry-pick process?

@lavalamp
Copy link
Member

@RainbowMango please feel free!

I'd take this back as many versions as we support, 1.14, 1.15, 1.16, and 1.13 if it's still in the support window. Not sure how easily this will cherry pick to the older ones...

@RainbowMango RainbowMango mentioned this pull request Oct 23, 2019
Merged
@tpepper
Copy link
Member

tpepper commented Nov 4, 2019

@lavalamp @RainbowMango are there going to be backports on this for 1.15 and 1.14?

k8s-ci-robot added a commit that referenced this pull request Nov 4, 2019
@k8s-ci-robot
Merge pull request #84215 from RainbowMango/automated-cherry-pick-of-…
22f43ab 
…#83427-upstream-release-1.16

Automated cherry pick of #83427: Fix double counting issue for request metrics on timeout.
@RainbowMango
Copy link
Member

@lavalamp @RainbowMango are there going to be backports on this for 1.15 and 1.14?

Oh, yes. I will try this as soon as possible. As mentioned by @logicalhan , we will probably need a manual PR to pick this fix back to 1.15 and 1.14.

According to kubernetes version policy, I think 1.13 is no longer maintained, so it wouldn't happen on 1.13.

The Kubernetes project maintains release branches for the most recent three minor releases.

RainbowMango added a commit to RainbowMango/upstream-kubernetes that referenced this pull request Nov 5, 2019
@RainbowMango
Cherry-pick kubernetes#83427
412cbe0 
Fix double counting issue for request metrics on timeout.
@RainbowMango RainbowMango mentioned this pull request Nov 5, 2019
Merged
RainbowMango added a commit to RainbowMango/upstream-kubernetes that referenced this pull request Nov 5, 2019
@RainbowMango
Cherry-pick kubernetes#83427
02fdb52 
Fix double counting issue for request metrics on timeout.
@RainbowMango RainbowMango mentioned this pull request Nov 5, 2019
Merged
k8s-ci-robot added a commit that referenced this pull request Nov 7, 2019
@k8s-ci-robot
Merge pull request #84780 from RainbowMango/manually-cherry-pick-of-#…
9aed496 
…83427-upstream-release-1.14

Manually cherry pick of #83427: Fix double counting issue for request metrics on timeout
k8s-ci-robot added a commit that referenced this pull request Nov 7, 2019
@k8s-ci-robot
Merge pull request #84777 from RainbowMango/manually-cherry-pick-of-#…
0869af6 
…83427-upstream-release-1.16

Manually cherry pick of #83427: Fix double counting issue for request metrics on timeout
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lavalamp lavalamp lavalamp left review comments

@cheftako cheftako cheftako left review comments

@sttts sttts Awaiting requested review from sttts

Assignees

@lavalamp lavalamp

@cheftako cheftako

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/bug Categorizes issue or PR as related to a bug. lgtm "Looks good to me", indicates that a PR is ready to be merged. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. 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. sig/instrumentation Categorizes an issue or PR as relevant to SIG Instrumentation. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
v1.17
Development

Successfully merging this pull request may close these issues.

Kube-apiserver request timeouts are double-counted into request metrics
6 participants
@logicalhan @k8s-ci-robot @cheftako @lavalamp @RainbowMango @tpepper