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

Karmada metrics documentation improvement. #425

Open
jwcesign opened this issue Jul 18, 2023 · 8 comments · May be fixed by #610
Open

Karmada metrics documentation improvement. #425

jwcesign opened this issue Jul 18, 2023 · 8 comments · May be fixed by #610
Assignees
@shivansh-bhatnagar18
Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.

Comments

@jwcesign
Copy link
Member

jwcesign commented Jul 18, 2023 •
edited by RainbowMango
Loading

What documentation would you like to be added:
Karmada metrics documentation improvement.

Why do you think this document is needed:
Now, the related documents(https://karmada.io/docs/next/reference/instrumentation/metrics/#metrics) is too simple, users don't know:

  • Are these metrics in the stable version, will these metrics be deprecated?
  • How to query these metrics and what do these metrics look like? Give some demos.
  • These metrics should be grouped by components.

referring to:

Where do you think the document should be placed:

https://github.com/karmada-io/website/tree/main/docs/reference/instrumentation/metrics.md
@jwcesign jwcesign added the help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. label Jul 18, 2023
@jwcesign jwcesign mentioned this issue Jul 18, 2023
Merged
@shivansh-bhatnagar18
Copy link

Looks like the issue is still open and needs improvement in the documentation as mentioned in #424. @RainbowMango @jwcesign Can you assign me this issue so that I can start working on this

@RainbowMango
Copy link
Member

/assgin @shivansh-bhatnagar18
Just go for it. Thanks.

@RainbowMango
Copy link
Member

/assign @shivansh-bhatnagar18

@shivansh-bhatnagar18
Copy link

shivansh-bhatnagar18 commented May 22, 2024 •
edited
Loading

@jwcesign @RainbowMango I have been working on improving the documentation of these metrics and I just wanted to confirm that currently I am able to specify the stability of the metrics as to whether they are STABLE/BETA/ALPHA version. I just wanted to make sure that is there something else that I can do to tell the users whether these metrics will be deprecated or no?

@shivansh-bhatnagar18
Copy link

@RainbowMango @jwcesign Also where can I find the stability of these metrics?

@shivansh-bhatnagar18
Copy link

Currently the documentation looks like this
Screenshot from 2024-05-22 18-05-36

@RainbowMango
Copy link
Member

@shivansh-bhatnagar18
Actually, all metrics from Karmada no maturity concept. Please ignore that for now. No plan to introduce that yet. You can ignore it.

I updated the issue PR description a little bit for that.

@shivansh-bhatnagar18
Copy link

@RainbowMango Thanks for the clarification

@shivansh-bhatnagar18 shivansh-bhatnagar18 linked a pull request May 23, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@shivansh-bhatnagar18 shivansh-bhatnagar18

Labels
help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Karmada Metrics Documentation Improvement shivansh-bhatnagar18/website
3 participants
@RainbowMango @jwcesign @shivansh-bhatnagar18