Skip to content

Register some audit annotations #47451

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.

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

Merged

Conversation

Ritikaa96
Copy link
Contributor

adding annotation:

  • apiserver.latency.k8s.io/etcd,

  • apiserver.latency.k8s.io/decode-response-object,

  • apiserver.latency.k8s.io/apf-queue-wait

  • Also corrected the description of annotation : k8s.io/removed-release
    In the page Audit Annotations

Partially fixes: #29479

@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Aug 12, 2024
@k8s-ci-robot k8s-ci-robot requested a review from sftim August 12, 2024 06:05
@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Aug 12, 2024
@Ritikaa96
Copy link
Contributor Author

/kind feature
/sig auth
/sig docs

@k8s-ci-robot k8s-ci-robot added kind/feature Categorizes issue or PR as related to a new feature. sig/auth Categorizes an issue or PR as relevant to SIG Auth. sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Aug 12, 2024
@Ritikaa96
Copy link
Contributor Author

JFYI : annotation apiserver.latency.k8s.io/apf-queue-wait
was added in k/k repository in this release cycle only. If not required right now , i can remove it.
Ref: kubernetes/kubernetes#123919

Copy link

netlify bot commented Aug 12, 2024

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 36e798b
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/679bba82f97c540008cbabc4
😎 Deploy Preview https://deploy-preview-47451--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@aramase
Copy link
Member

aramase commented Aug 12, 2024

/sig api-machinery
/remove-sig auth

@k8s-ci-robot k8s-ci-robot added sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. and removed sig/auth Categorizes an issue or PR as relevant to SIG Auth. labels Aug 12, 2024
@Ritikaa96
Copy link
Contributor Author

@sftim @katcosgrove PTAL

@sftim
Copy link
Contributor

sftim commented Sep 25, 2024

/retitle Register some audit annotations

@k8s-ci-robot k8s-ci-robot changed the title Regsitering Audit annotations Register some audit annotations Sep 25, 2024
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

Thanks. I have some comments and suggestions.

Sorry it took a while; we're short on reviewers.

@@ -31,7 +31,7 @@ request used a deprecated API version.

Example: `k8s.io/removed-release: "1.22"`

Value **must** be in the format "<major>.<minor>". It is set to target the removal release
Value **must** be in the format "\<MAJOR>\.\<MINOR>\". It is set to target the removal release
Copy link
Contributor

Choose a reason for hiding this comment

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

Why this change?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

When i tested the page . there was blank spaces instead of "." that's why


Example: `apiserver.latency.k8s.io/decode-response-object: "450.6649ns"`

This annotation records the decoding time of response object.
Copy link
Contributor

Choose a reason for hiding this comment

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

This annotation records the time taken to … (what goes here)?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This annotation records the time taken to decode the response object.

Copy link
Contributor

Choose a reason for hiding this comment

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

Is it one of these?

Suggested change
This annotation records the decoding time of response object.
This annotation records the time taken to decode the response received from the storage layer (etcd).
Suggested change
This annotation records the decoding time of response object.
This annotation records the time that elapses whilst the API server is decoding the response that
it is about to send.

?

Copy link
Contributor Author

@Ritikaa96 Ritikaa96 Oct 11, 2024

Choose a reason for hiding this comment

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

Copy link
Contributor Author

@Ritikaa96 Ritikaa96 Oct 11, 2024

Choose a reason for hiding this comment

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

This is latency incurred inside the function that takes an object returned from the underlying storage layer (etcd) and performs decoding of the response object.

@Ritikaa96
Copy link
Contributor Author

Ritikaa96 commented Sep 25, 2024

Thanks. I have some comments and suggestions.

Sorry it took a while; we're short on reviewers.

No worries, I will wait for further comments on other raised PRs as well. there are more like this still waiting for reviews

@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

  • Mark this PR as fresh with /remove-lifecycle stale
  • Close this PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 28, 2025
@Ritikaa96
Copy link
Contributor Author

I might have missed this one, working on it currently , will update by tomorrow morning.
/remove-lifecycle stale

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 30, 2025
…8s.io/decode-response-object, apiserver.latency.k8s.io/apf-queue-wait

Signed-off-by: Ritikaa96 <[email protected]>
Signed-off-by: Ritikaa96 <[email protected]>
@Ritikaa96 Ritikaa96 force-pushed the audit-annotation-etcd-decode-latency branch from ad38d4f to 36e798b Compare January 30, 2025 17:44
@Ritikaa96
Copy link
Contributor Author

@katcosgrove @sftim PTAL

@Ritikaa96
Copy link
Contributor Author

Just a reminder: @sftim @katcosgrove @aramase
@ptal

Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

/lgtm


Example: `apiserver.latency.k8s.io/etcd: "4.730661757s"`

This annotation indiactes the measure of latency incurred inside the storage layer,
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
This annotation indiactes the measure of latency incurred inside the storage layer,
This annotation indicates the measure of latency incurred inside the storage layer,

Copy link
Contributor

Choose a reason for hiding this comment

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

Minor nit - can be fixed in a follow-up PR. Or if @Ritikaa96 , you're willing to push the changes within this week - happy to get this merged ASAP.

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

LGTM label has been added.

Git tree hash: 34454e15eba3b740c8dd68bc017f354ba02980a7

@divya-mohan0209
Copy link
Contributor

@kubernetes/sig-auth-pr-reviews PTAL and advise if this is technically accurate?

@k8s-ci-robot k8s-ci-robot added the sig/auth Categorizes an issue or PR as relevant to SIG Auth. label Apr 17, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: reylejano

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 May 13, 2025
@k8s-ci-robot k8s-ci-robot merged commit 99b9082 into kubernetes:main May 13, 2025
6 checks passed
@github-project-automation github-project-automation bot moved this from !SIG Auth to Closed / Done in SIG Auth May 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. 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. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. sig/auth Categorizes an issue or PR as relevant to SIG Auth. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
Status: Closed / Done
Development

Successfully merging this pull request may close these issues.

Document well-known audit annotations
7 participants