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.

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

resource-usage-monitoring.md Modified #34471

Closed

Conversation

nitishfy
Copy link
Member

@nitishfy nitishfy commented Jun 22, 2022

Fix: #31483

The following changes have been made looking at @sftim comment to the following issue.

In the section "Full metrics pipeline" it says:

Prometheus, a CNCF project, can natively monitor Kubernetes, nodes, and Prometheus itself. Full metrics pipeline projects that are not part of the CNCF are outside the scope of Kubernetes documentation.

The following paragraph was not appealing much to the reader especially mentioning Prometheus. The purpose of this PR is to ensure the reader that the Kubernetes Project is designed to work with OpenMetrics which is a CNCF Project but K8s doesn't provide any recommendations of other Projects to work upon.

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jun 22, 2022
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign kbhawkey after the PR has been reviewed.
You can assign the PR to them by writing /assign @kbhawkey in a comment when ready.

The full list of commands accepted by this bot can be found 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 language/en Issues or PRs related to English language label Jun 22, 2022
@k8s-ci-robot k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Jun 22, 2022
@netlify
Copy link

netlify bot commented Jun 22, 2022

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit e2573c0
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/62b34d7f07cb08000930d72d
😎 Deploy Preview https://deploy-preview-34471--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 settings.

@sftim
Copy link
Contributor

sftim commented Jun 23, 2022

Hi @nitishkumar06

Would you be willing to set a different PR title and PR description?

The PR description should explain what's being fixed / added, and why. The title should try to summarize that description.

@@ -59,8 +59,11 @@ Autoscaler. The monitoring pipeline fetches metrics from the kubelet and
then exposes them to Kubernetes via an adapter by implementing either the
`custom.metrics.k8s.io` or `external.metrics.k8s.io` API.

[Prometheus](https://prometheus.io), a CNCF project, can natively monitor Kubernetes, nodes, and Prometheus itself.
Full metrics pipeline projects that are not part of the CNCF are outside the scope of Kubernetes documentation.
Kubernetes is designed to work with [OpenMetrics](https://openmetrics.io/) which is one of the CNCF Project.
Copy link
Contributor

Choose a reason for hiding this comment

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

👋 @nitishkumar06 . What do you think about these edits:

Kubernetes is designed to work with OpenMetrics which is one of the CNCF Observability and Analysis - Monitoring Projects. Full metrics pipeline projects that are not part of the CNCF are outside the scope of the Kubernetes documentation.

To know more about the Projects under CNCF, refer to this [link](https://landscape.cncf.io/card-mode?category=monitoring&project=graduated,incubating,member,no&grouping=category&sort=stars). Full metrics pipeline
projects that are not part of the CNCF are outside the scope of Kubernetes documentation.

*It is to be noted that Kubernetes Project don't provide any kind of recommendation for other projects to work upon. It is a user choice to pick a project to start working upon. In order to make a Full metric pipeline, Kubernetes is required to design and deploy the infrastructure.*
Copy link
Contributor

Choose a reason for hiding this comment

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

The last two sentences are not as clear, especially the last sentence.

Copy link
Member Author

Choose a reason for hiding this comment

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

@kbhawkey What according to you shall a good understandable sentence look like?

Copy link
Member

Choose a reason for hiding this comment

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

I agree with @kbhawkey, these sentences are not clear and concise

@reylejano
Copy link
Member

I'm closing this PR since there's no traction and there are sentences proposed in this PR that are not clear.
/close

@k8s-ci-robot
Copy link
Contributor

@reylejano: Closed this PR.

In response to this:

I'm closing this PR since there's no traction and there are sentences proposed in this PR that are not clear.
/close

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Unclear wording in “Tools for Monitoring Resources”
5 participants