Add build info metric #1226

yeya24 · 2020-09-15T02:55:31Z

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

tariq1890 · 2020-09-15T06:44:56Z

pkg/version/version.go

@@ -18,6 +18,9 @@ import (
 	"os"
 	"path/filepath"
 	"runtime"
+
+	"github.com/prometheus/client_golang/prometheus"


let's not add these imports to the version pkg

tariq1890 · 2020-09-15T06:46:12Z

pkg/version/version.go

@@ -62,3 +65,18 @@ func GetVersion() Version {
 		Platform:  fmt.Sprintf("%s/%s", runtime.GOOS, runtime.GOARCH),
 	}
 }
+
+// RegisterBuildInfo registers the build info metric.
+func RegisterBuildInfo(r prometheus.Registerer) {


We can move this method to main.go instead. In main.go, we can call version.GetVersion(), get the version struct and use its fields to instantiate the Gauge vector in main.go

Yes, thanks! I will update it.

tariq1890 · 2020-09-15T06:46:34Z

Thanks so much for this PR @yeya24 . Provided my comments

lilic · 2020-09-15T13:11:23Z

Thanks for the PR, I already started the kube-state-metrics alpha 2.0 release, so might need to wait a bit longer until that is cut. Hope that's okay. :)

yeya24 · 2020-09-15T14:22:10Z

I just updated the pr, please take a look again @tariq1890

Hi @lilic, no problem. Thanks for letting me know 👍

YuikoTakada · 2020-09-16T22:59:21Z

Thank you for the PR. This new metrics need to be added to docs also? I'm not sure.

yeya24 · 2020-09-16T23:07:50Z

Thank you for the PR. This new metrics need to be added to docs also? I'm not sure.

Yes, you are totally right. Thank you! Let me update the pr.

lilic · 2020-10-05T10:03:46Z

@yeya24 I changed the base to release-2.0, do you mind also adding the docs to the README like we have for other ksm own metrics and we can merge afterwards, thanks! :)

tariq1890 · 2020-10-06T23:20:09Z

main.go

+func registerBuildInfo(r prometheus.Registerer) {
+	v := version.GetVersion()
+	promauto.With(r).NewGaugeFunc(prometheus.GaugeOpts{
+		Name: "kube_state_metrics_build_info",


Do we need it to be "kube_state_metrics_build_info", what about just build_info? We have the job label to specify that it pertains to kube-state-metrics right?

I prefer the full name kube_state_metrics_build_info

k8s-ci-robot · 2020-10-07T04:08:03Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: yeya24
To complete the pull request process, please assign lilic after the PR has been reviewed.
You can assign the PR to them by writing /assign @lilic 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:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

yeya24 · 2020-10-07T04:08:43Z

Sorry for the late, I just updated the doc. Please take a look.

lilic · 2020-10-07T07:30:06Z

Currently right in the middle of cutting the next release, but we can merge straight after that. Bad timing, sorry :)
/hold

Co-authored-by: Lili Cosic <cosiclili@gmail.com>

README.md: Update section on container images

Fix pod-metric missing reasons

fix typo in node-metrics.md

Fix some typos

…lpha.1 and 2.0.0-alpha.2

…792) Signed-off-by: Denys Havrysh <denys.gavrysh@gmail.com>

Currently, Get, List and Watch are required. List and Watch are provided by the ClusterRole related to collectors. The STS collector can be disabled breaking the current AutoSharding role permissions. Moreover, the resourceNames depends of the RELEASE_NAME as defined in deployment.yaml so we need to reflect this or we won't have the correct permission to read our STS. Signed-off-by: Mathis Raguin <mathis@cri.epita.fr>

…850) * added resource config example as its mentioned in the readme Signed-off-by: André Bauer <monotek23@gmail.com> * added newline Signed-off-by: André Bauer <monotek23@gmail.com> * updated chart version Signed-off-by: André Bauer <monotek23@gmail.com> * removed blank line Signed-off-by: André Bauer <monotek23@gmail.com> * updated version Signed-off-by: André Bauer <monotek23@gmail.com>

Signed-off-by: Juan Pablo Jaramillo Pineda <juan@pablox.io>

… (#23380) * Added kubeconfig arg and secret Signed-off-by: Mike Ritter <mike.ritter@target.com> * Updated secret name Signed-off-by: Mike Ritter <mike.ritter@target.com> * Updated secret name Signed-off-by: Mike Ritter <mike.ritter@target.com> * Removed trailing spaces Signed-off-by: Mike Ritter <mike.ritter@target.com> * Removed XXX as default secret Signed-off-by: Mike Ritter <mike.ritter@target.com>

…er Nov 13 2020 Signed-off-by: Scott Rigby <scott@r6by.com>

Signed-off-by: Scott Rigby <scott@r6by.com>

…). Requires configuring a gh-pages branch before merge to master Signed-off-by: Scott Rigby <scott@r6by.com>

Signed-off-by: Manuel Rüger <manuel@rueg.eu> Co-authored-by: Scott Rigby <scott@r6by.com>

Signed-off-by: Damien Grisonnet <dgrisonn@redhat.com>

internal/store: fix high cyclo complexity

…d from. Chart commit history original source: https://github.com/helm/charts/tree/master/stable/kube-state-metrics For context about chart reloation, see "[stable] relocate charts to new repos" https://github.com/helm/charts/issues/21103 Signed-off-by: Scott Rigby <scott@r6by.com>

- kubernetes#1237 (comment) - kubernetes#1237 (comment) Signed-off-by: Scott Rigby <scott@r6by.com>

Note we may want to add GPG signing in a follow-up PR. Signed-off-by: Scott Rigby <scott@r6by.com>

Host stable/kube-state-metrics helm chart

Latest version of chart-releaser action is [v1.1.0](https://github.com/helm/chart-releaser-action/releases/tag/v1.1.0) Signed-off-by: Torsten Walter <torsten.walter@syncier.com>

The test-unit Makefile rule had a dependency on the clean and build rules. However, these rules aren't needed to run kube-state-metrics unit tests. The original rule can be problematic when running the unit tests in an environment without docker installed. Signed-off-by: Damien Grisonnet <dgrisonn@redhat.com>

Makefile: remove test-unit dependencies

helm chart: Fix GitHub action

Signed-off-by: Scott Rigby <scott@r6by.com>

…e-template Chart releaser name template and release

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

k8s-ci-robot · 2020-12-18T04:07:47Z

Keywords which can automatically close issues and at(@) or hashtag(#) mentions are not allowed in commit messages.

The list of commits with invalid commit messages:

ab1143e [stable/kube-state-metrics] add pod affinity (#12819)
21b54d2 [stable/kube-state-metrics] Version bump to 1.9.5 (#20915)

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:08:14Z

Will close a new pr against master. Sorry for the late.

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Sep 15, 2020

k8s-ci-robot requested review from brancz and tariq1890 September 15, 2020 02:55

yeya24 force-pushed the add-build-info branch from 9e93c58 to 255cd5d Compare September 15, 2020 03:11

tariq1890 reviewed Sep 15, 2020

View reviewed changes

lilic changed the base branch from master to release-2.0 October 5, 2020 10:03

tariq1890 reviewed Oct 6, 2020

View reviewed changes

yeya24 force-pushed the add-build-info branch from c0f452e to 465f098 Compare October 7, 2020 04:07

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 7, 2020

eterny13 and others added 10 commits October 27, 2020 22:15

Fix some typos

f977f0f

fix pod-metrics.md

0253dae

README.md: Update section on container images

602392f

Apply suggestions from code review

818bc92

Co-authored-by: Lili Cosic <cosiclili@gmail.com>

Merge pull request kubernetes#1290 from mrueg/doc-update

759ad2c

README.md: Update section on container images

typo in node-metrics.md

9add721

Merge pull request kubernetes#1287 from jangdm/fix-pod-metric-md

25295fc

Fix pod-metric missing reasons

Merge pull request kubernetes#1291 from kesor/fix-typo-in-node-doc

a92bec2

fix typo in node-metrics.md

Merge pull request kubernetes#1283 from ekrecker/patch-1

b6e67d0

Fix some typos

fix container resource limits metrics, which got dropped btwn 2.0.0-a…

122f207

…lpha.1 and 2.0.0-alpha.2

vutny and others added 23 commits December 8, 2020 12:40

[stable/kube-state-metrics] Document kubeTargetVersionOverride (#22…

5925fa3

…792) Signed-off-by: Denys Havrysh <denys.gavrysh@gmail.com>

[stable/kube-state-metrics] Add annotations for serviceAccount (#23411)

ae57d81

Signed-off-by: Juan Pablo Jaramillo Pineda <juan@pablox.io>

Clean up chart README. To-do: remove Helm 2 command documentation aft…

5d0abda

…er Nov 13 2020 Signed-off-by: Scott Rigby <scott@r6by.com>

Bump chart PATCH version

45bde71

Signed-off-by: Scott Rigby <scott@r6by.com>

Add Helm GitHub Actions for CI (chart-testing) and CD (chart-releaser…

9833730

…). Requires configuring a gh-pages branch before merge to master Signed-off-by: Scott Rigby <scott@r6by.com>

[stable/kube-state-metrics] Update apiVersion for clusterrole (#23968)

6a502c3

Signed-off-by: Manuel Rüger <manuel@rueg.eu> Co-authored-by: Scott Rigby <scott@r6by.com>

internal/store: refactor pod and node generators

8e6b214

Signed-off-by: Damien Grisonnet <dgrisonn@redhat.com>

Merge pull request kubernetes#1315 from dgrisonnet/fix-cyclo-complexity

7bdd625

internal/store: fix high cyclo complexity

Remove fiunchinho per these comments:

c9937aa

- kubernetes#1237 (comment) - kubernetes#1237 (comment) Signed-off-by: Scott Rigby <scott@r6by.com>

Update Helm chart repo actions to latest versions.

fdd0e4b

Note we may want to add GPG signing in a follow-up PR. Signed-off-by: Scott Rigby <scott@r6by.com>

Merge pull request kubernetes#1237 from scottrigby/stable-chart-history

52885f7

Host stable/kube-state-metrics helm chart

helm chart: Fix GitHub action

afdf4ea

Latest version of chart-releaser action is [v1.1.0](https://github.com/helm/chart-releaser-action/releases/tag/v1.1.0) Signed-off-by: Torsten Walter <torsten.walter@syncier.com>

Merge pull request kubernetes#1327 from dgrisonnet/test-unit

3ac452a

Makefile: remove test-unit dependencies

Merge pull request kubernetes#1326 from torstenwalter/fix-helm-cd

507769b

helm chart: Fix GitHub action

Add Helm Releaser CR_RELEASE_NAME_TEMPLATE to disambiguate tag naming

31a1afa

Signed-off-by: Scott Rigby <scott@r6by.com>

Bump chart PATCH version

433f7d4

Signed-off-by: Scott Rigby <scott@r6by.com>

Merge pull request kubernetes#1329 from scottrigby/chart-releaser-nam…

a832eeb

…e-template Chart releaser name template and release

add build_info metric for KSM

0e319bd

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

yeya24 force-pushed the add-build-info branch from 465f098 to 0e319bd Compare December 18, 2020 04:07

k8s-ci-robot added the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label Dec 18, 2020

k8s-ci-robot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Dec 18, 2020

yeya24 closed this Dec 18, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add build info metric #1226

Add build info metric #1226

yeya24 commented Sep 15, 2020

tariq1890 Sep 15, 2020

tariq1890 Sep 15, 2020

yeya24 Sep 15, 2020

tariq1890 commented Sep 15, 2020

lilic commented Sep 15, 2020

yeya24 commented Sep 15, 2020

YuikoTakada commented Sep 16, 2020

yeya24 commented Sep 16, 2020

lilic commented Oct 5, 2020

tariq1890 Oct 6, 2020

yeya24 Oct 7, 2020

k8s-ci-robot commented Oct 7, 2020

yeya24 commented Oct 7, 2020

lilic commented Oct 7, 2020

k8s-ci-robot commented Dec 18, 2020

yeya24 commented Dec 18, 2020

Add build info metric #1226

Add build info metric #1226

Conversation

yeya24 commented Sep 15, 2020

tariq1890 Sep 15, 2020

Choose a reason for hiding this comment

tariq1890 Sep 15, 2020

Choose a reason for hiding this comment

yeya24 Sep 15, 2020

Choose a reason for hiding this comment

tariq1890 commented Sep 15, 2020

lilic commented Sep 15, 2020

yeya24 commented Sep 15, 2020

YuikoTakada commented Sep 16, 2020

yeya24 commented Sep 16, 2020

lilic commented Oct 5, 2020

tariq1890 Oct 6, 2020

Choose a reason for hiding this comment

yeya24 Oct 7, 2020

Choose a reason for hiding this comment

k8s-ci-robot commented Oct 7, 2020

yeya24 commented Oct 7, 2020

lilic commented Oct 7, 2020

k8s-ci-robot commented Dec 18, 2020

yeya24 commented Dec 18, 2020