Skip to content

docs: add controller metrics reference#153

Merged
k8s-ci-robot merged 1 commit intokubernetes-sigs:mainfrom
OneUpWallStreet:oneupwallstreet/94
Mar 7, 2026
Merged

docs: add controller metrics reference#153
k8s-ci-robot merged 1 commit intokubernetes-sigs:mainfrom
OneUpWallStreet:oneupwallstreet/94

Conversation

@OneUpWallStreet
Copy link
Copy Markdown
Contributor

Description

Added user-facing docs covering all the metrics defined in internal/metrics/metrics.go. I tried to keep the structure simple and extensible so we can build on it as we add more metrics, while still keeping it consistent with the rest of the docs.

I also kept the per-metric detail fairly lightweight for now, so lmk if you want more detail for each metric or if the current level is okay.

Related Issue

Fixes #94

Type of Change

/kind documentation

Testing

N/A

Checklist

  • make test passes
  • make lint passes

Does this PR introduce a user-facing change?

NONE

@k8s-ci-robot k8s-ci-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Mar 7, 2026
@netlify
Copy link
Copy Markdown

netlify Bot commented Mar 7, 2026

Deploy Preview for node-readiness-controller ready!

Name Link
🔨 Latest commit c334b2e
🔍 Latest deploy log https://app.netlify.com/projects/node-readiness-controller/deploys/69abc73986e5ed000895edce
😎 Deploy Preview https://deploy-preview-153--node-readiness-controller.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 project configuration.

@k8s-ci-robot k8s-ci-robot requested a review from ajaysundark March 7, 2026 06:35
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Mar 7, 2026
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

Hi @OneUpWallStreet. Thanks for your PR.

I'm waiting for a kubernetes-sigs 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-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 7, 2026
@ajaysundark
Copy link
Copy Markdown
Contributor

/lgtm
/approve

thanks

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

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ajaysundark, OneUpWallStreet

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 Mar 7, 2026
@k8s-ci-robot k8s-ci-robot merged commit 3206caf into kubernetes-sigs:main Mar 7, 2026
10 checks passed
farazmd pushed a commit to farazmd/node-readiness-controller that referenced this pull request Mar 7, 2026
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/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

doc: installing node-readiness-controller with metrics support

3 participants