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

e2e: check labels documentation #1078

Closed
olivierlemasle opened this issue Feb 24, 2020 · 2 comments · Fixed by #1082
Closed

e2e: check labels documentation #1078

olivierlemasle opened this issue Feb 24, 2020 · 2 comments · Fixed by #1082
Assignees

Comments

@olivierlemasle
Copy link
Member

As @lilic pointed out recently, CI checks thats every metric is documented (make doccheck), but there's no check on labels documentation.

That led to PR where labels documentation was not updated and CI did not catch this (#996).

Actually, it's more difficult to check labels:

  • metric names are extracted from source code by a static analysis (with regex "(kube_[^"]+)"); labels are not easily found by basic static analysis;
  • some labels have a dynamic name (e.g. label_JOB_LABEL)

What do you think of using e2e to check labels documentation? We already check metrics from /metrics endpoint; we could also list labels for each metric and check if they're in documentation (even if it is not exhaustive).

@brancz
Copy link
Member

brancz commented Feb 24, 2020

I think this is a great idea!

@olivierlemasle
Copy link
Member Author

/assign

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants