Add build info metric #1332

yeya24 · 2020-12-18T04:09:11Z

Signed-off-by: Ben Ye yb532204897@gmail.com

What this PR does / why we need it:

This pr adds the kube_state_metrics_build_info metric as required by #1132

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #1132

k8s-ci-robot · 2020-12-18T04:09:14Z

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.

If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
If you have done the above and are still having issues with the CLA being reported as unsigned, please log a ticket with the Linux Foundation Helpdesk: https://support.linuxfoundation.org/
Should you encounter any issues with the Linux Foundation Helpdesk, send a message to the backup e-mail support address at: login-issues@jira.linuxfoundation.org

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. I understand the commands that are listed here.

yeya24 · 2020-12-18T04:09:29Z

PTAL @lilic ^^

kakkoyun · 2020-12-18T08:39:39Z

main.go

@@ -80,6 +81,7 @@ func main() {
 	storeBuilder := store.NewBuilder()

 	ksmMetricsRegistry := prometheus.NewRegistry()
+	registerBuildInfo(ksmMetricsRegistry)


@yeya24 Any reason why you didn't consider the existing collector? https://github.com/prometheus/common/blob/master/version/info.go

Nice Kemal, agreed!

@kakkoyun I was thinking about using that directly. But that works well with promu because promu injects all the info via build flags to that pkg.

Right now the injected flags are added https://github.com/kubernetes/kube-state-metrics/blob/master/Makefile#L55 here, I still need to add more flags to make the VersionCollector usable. I feel it is not necessary.

True. I have done exactly what you said in here https://github.com/kakkoyun/observable-remote-write/blob/56b5c6dedc8eb30ece404cd4885c3aabb779d2b8/Makefile#L14

Hard to judge just which way is simpler. I guess it's a matter of preference. My preference would be obviously reusing the package from the prometheus/common.

@lilic What do you think? Which code looks simpler to you?

Agreed, reusing Prometheus/common would be my preference here as well. 👍

Got it! I will use that package. Thanks @kakkoyun for the example!

yeya24 · 2021-01-05T06:30:22Z

Updated. Please take a look. @lilic @kakkoyun 🤗

Some screenshots:

yeya24 · 2021-01-05T07:00:09Z

Umm, not sure how to fix CI. I tried make validate-manifests locally and I didn't get any error output.

kakkoyun

LGTM.

Concerning CI failure, I'd suggest making sure your tooling version is the same as the CI.

lilic

Thanks for the changes! One suggestion only, but a nit.

The failure seems odd, but do you mind installing all the tools we use (some might need bumping so feel free to bump if you have the time) and try again.

I can also have a look tomorrow if you don't manage, thanks!!

lilic · 2021-01-05T10:25:41Z

README.md

@@ -150,6 +150,12 @@ http_request_duration_seconds_sum{handler="metrics",method="get"} 0.021113919999
 http_request_duration_seconds_count{handler="metrics",method="get"} 30
 ```

+kube-state-metrics exposes the build info metric:


Nit: Would be good to add a few lines what those are useful for. Similiar to have we have them for the list and watch errors above.

lilic · 2021-01-06T12:49:41Z

README.md

+```
+
+`kube_state_metrics_build_info` is used to expose version and other build information. For more usage about the info pattern,
+please check the blog post [here](https://www.robustperception.io/exposing-the-software-version-to-prometheus).


I am not sure we are allowed to link to external companies blog posts? Otherwise, agreed this blog is very useful! @brancz wdyt?

I don't think there is a general rule here, if this was self-promotion I would be more critical, but here it's really just a helpful resource.

Yes sounds good, was on the edge. lgtm apart from the need to squash commits.

lilic

Do you mind just squashing your commits as the bot will merge as is, thanks! Otherwise lgtm, thanks again!

Signed-off-by: Ben Ye <yb532204897@gmail.com>

yeya24 · 2021-01-06T15:51:20Z

Updated. @lilic

lilic

/lgtm

Thanks for the contribution and addressing all the comments so quickly! :)

k8s-ci-robot · 2021-01-06T15:56:16Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: kakkoyun, lilic, yeya24

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:

~~OWNERS~~ [lilic]

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 added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Dec 18, 2020

k8s-ci-robot requested review from brancz and lilic December 18, 2020 04:09

k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Dec 18, 2020

kakkoyun reviewed Dec 18, 2020

View reviewed changes

k8s-ci-robot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jan 5, 2021

yeya24 force-pushed the add-build-info branch from ae2bb46 to 58c0014 Compare January 5, 2021 06:34

k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jan 5, 2021

yeya24 force-pushed the add-build-info branch from 58c0014 to 6c9d775 Compare January 5, 2021 06:45

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jan 5, 2021

kakkoyun approved these changes Jan 5, 2021

View reviewed changes

lilic reviewed Jan 5, 2021

View reviewed changes

lilic reviewed Jan 6, 2021

View reviewed changes

add build_info metric for KSM

6a32904

Signed-off-by: Ben Ye <yb532204897@gmail.com>

yeya24 force-pushed the add-build-info branch from 1974f17 to 6a32904 Compare January 6, 2021 15:50

lilic reviewed Jan 6, 2021

View reviewed changes

k8s-ci-robot assigned lilic Jan 6, 2021

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 6, 2021

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 6, 2021

k8s-ci-robot merged commit 2465de0 into kubernetes:master Jan 6, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add build info metric #1332

Add build info metric #1332

yeya24 commented Dec 18, 2020

k8s-ci-robot commented Dec 18, 2020

yeya24 commented Dec 18, 2020

kakkoyun Dec 18, 2020

lilic Dec 18, 2020

yeya24 Dec 18, 2020

kakkoyun Dec 18, 2020 •

edited

Loading

lilic Jan 4, 2021

yeya24 Jan 4, 2021

yeya24 commented Jan 5, 2021 •

edited

Loading

yeya24 commented Jan 5, 2021

kakkoyun left a comment

lilic left a comment

lilic Jan 5, 2021

yeya24 Jan 5, 2021

lilic Jan 6, 2021

brancz Jan 6, 2021

lilic Jan 6, 2021

lilic left a comment

yeya24 commented Jan 6, 2021

lilic left a comment

k8s-ci-robot commented Jan 6, 2021

Add build info metric #1332

Add build info metric #1332

Conversation

yeya24 commented Dec 18, 2020

k8s-ci-robot commented Dec 18, 2020

yeya24 commented Dec 18, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kakkoyun Dec 18, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yeya24 commented Jan 5, 2021 • edited Loading

yeya24 commented Jan 5, 2021

kakkoyun left a comment

Choose a reason for hiding this comment

lilic left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lilic left a comment

Choose a reason for hiding this comment

yeya24 commented Jan 6, 2021

lilic left a comment

Choose a reason for hiding this comment

k8s-ci-robot commented Jan 6, 2021

kakkoyun Dec 18, 2020 •

edited

Loading

yeya24 commented Jan 5, 2021 •

edited

Loading