Skip to content

Commit

Permalink
Move the karpenter_build_info metric to karpenter
Browse files Browse the repository at this point in the history
  • Loading branch information
jonathan-innis committed Dec 8, 2023
1 parent 62ba377 commit 776ab2d
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 0 deletions.
19 changes: 19 additions & 0 deletions pkg/operator/operator.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,16 @@ import (
"fmt"
"net/http"
"net/http/pprof"
"runtime"
"runtime/debug"
"sync"
"time"

"github.com/prometheus/client_golang/prometheus"
coordinationv1 "k8s.io/api/coordination/v1"
"knative.dev/pkg/changeset"
crmetrics "sigs.k8s.io/controller-runtime/pkg/metrics"
"sigs.k8s.io/karpenter/pkg/metrics"

"github.com/go-logr/zapr"
"github.com/samber/lo"
Expand Down Expand Up @@ -62,10 +67,24 @@ const (
component = "controller"
)

var BuildInfo = prometheus.NewGaugeVec(
prometheus.GaugeOpts{
Namespace: metrics.Namespace,
Name: "build_info",
Help: "A metric with a constant '1' value labeled by version from which karpenter was built.",
},
[]string{"version", "goversion", "commit"},
)

// Version is the karpenter app version injected during compilation
// when using the Makefile
var Version = "unspecified"

func init() {
crmetrics.Registry.MustRegister(BuildInfo)
BuildInfo.WithLabelValues(Version, runtime.Version(), changeset.Get()).Set(1)
}

type Operator struct {
manager.Manager

Expand Down
45 changes: 45 additions & 0 deletions pkg/operator/suite_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
/*
Copyright 2023 The Kubernetes Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package operator_test

import (
"testing"

"github.com/samber/lo"

. "github.com/onsi/ginkgo/v2"
. "github.com/onsi/gomega"
prometheusmodel "github.com/prometheus/client_model/go"
. "sigs.k8s.io/karpenter/pkg/test/expectations"
)

func TestOperator(t *testing.T) {
RegisterFailHandler(Fail)
RunSpecs(t, "Operator")
}

var _ = Describe("Operator", func() {
It("should fire a metric with the build_info", func() {
m, found := FindMetricWithLabelValues("karpenter_build_info", map[string]string{})
Expect(found).To(BeTrue())

for _, label := range []string{"version", "goversion", "commit"} {
_, ok := lo.Find(m.GetLabel(), func(l *prometheusmodel.LabelPair) bool { return lo.FromPtr(l.Name) == label })
Expect(ok).To(BeTrue())
}
})
})

0 comments on commit 776ab2d

Please sign in to comment.