fix gflag to version

Signed-off-by: dongjiang <[email protected]>

hack/util.sh

@@ -707,9 +707,21 @@ function util::get_version() {
   git describe --tags --dirty
 }
 
+function util::get_branch() {
+  git branch --show-current
+}
+
+function util::get_revision() {
+  git rev-parse --short HEAD
+}
+
 function util::version_ldflags() {
   # Git information
   GIT_VERSION=$(util::get_version)
+  # Git branch
+  GIT_BRANCH=$(util::get_branch)
+  # Git revision
+  GIT_REVISION=$(util::get_revision)
   GIT_COMMIT_HASH=$(git rev-parse HEAD)
   if git_status=$(git status --porcelain 2>/dev/null) && [[ -z ${git_status} ]]; then
     GIT_TREESTATE="clean"
@@ -720,6 +732,8 @@ function util::version_ldflags() {
   LDFLAGS="-X github.com/karmada-io/karmada/pkg/version.gitVersion=${GIT_VERSION} \
                         -X github.com/karmada-io/karmada/pkg/version.gitCommit=${GIT_COMMIT_HASH} \
                         -X github.com/karmada-io/karmada/pkg/version.gitTreeState=${GIT_TREESTATE} \
+                        -X github.com/karmada-io/karmada/pkg/version.gitBranch=${GIT_BRANCH} \
+                        -X github.com/karmada-io/karmada/pkg/version.gitRevision=${GIT_REVISION} \
                         -X github.com/karmada-io/karmada/pkg/version.buildDate=${BUILDDATE}"
   echo $LDFLAGS
 }

operator/cmd/operator/app/operator.go

@@ -24,7 +24,6 @@ import (
 	"regexp"
 
 	"github.com/prometheus/client_golang/prometheus/collectors"
-	prometheusversion "github.com/prometheus/client_golang/prometheus/collectors/version"
 	"github.com/spf13/cobra"
 	"k8s.io/apimachinery/pkg/util/sets"
 	restclient "k8s.io/client-go/rest"
@@ -133,7 +132,7 @@ func Run(ctx context.Context, o *options.Options) error {
 		),
 	)
 	ctrlmetrics.Registry.MustRegister(
-		prometheusversion.NewCollector("karmada_operator"),
+		version.NewCollector("karmada_operator"),
 	)
 
 	controllerCtx := ctrlctx.Context{

pkg/version/base.go

@@ -26,6 +26,8 @@ var (
 	gitVersion   = "v0.0.0-master"
 	gitCommit    = "unknown" // sha1 from git, output of $(git rev-parse HEAD)
 	gitTreeState = "unknown" // state of git tree, either "clean" or "dirty"
+	gitBranch    = "unknown"
+	gitRevision  = "unknown"
 
 	buildDate = "unknown" // build date in ISO8601 format, output of $(date -u +'%Y-%m-%dT%H:%M:%SZ')
 )

pkg/version/version.go

@@ -19,13 +19,17 @@ package version
 import (
 	"fmt"
 	"runtime"
+
+	"github.com/prometheus/client_golang/prometheus"
 )
 
 // Info contains versioning information.
 type Info struct {
 	GitVersion   string `json:"gitVersion"`
 	GitCommit    string `json:"gitCommit"`
+	GitRevision  string `json:"gitRevision"`
 	GitTreeState string `json:"gitTreeState"`
+	GitBranch    string `json:"gitBranch"`
 	BuildDate    string `json:"buildDate"`
 	GoVersion    string `json:"goVersion"`
 	Compiler     string `json:"compiler"`
@@ -42,11 +46,39 @@ func (info Info) String() string {
 func Get() Info {
 	return Info{
 		GitVersion:   gitVersion,
+		GitRevision:  gitRevision,
 		GitCommit:    gitCommit,
 		GitTreeState: gitTreeState,
+		GitBranch:    gitBranch,
 		BuildDate:    buildDate,
 		GoVersion:    runtime.Version(),
 		Compiler:     runtime.Compiler,
 		Platform:     fmt.Sprintf("%s/%s", runtime.GOOS, runtime.GOARCH),
 	}
 }
+
+// NewCollector returns a collector that exports metrics about current version
+// information.
+func NewCollector(program string) prometheus.Collector {
+	return prometheus.NewGaugeFunc(
+		prometheus.GaugeOpts{
+			Namespace: program,
+			Name:      "build_info",
+			Help: fmt.Sprintf(
+				"A metric with a constant '1' value labeled by version, revision, branch, goversion from which %s was built, and the goos and goarch for the build.",
+				program,
+			),
+			ConstLabels: prometheus.Labels{
+				"version":   Get().GitVersion,
+				"revision":  Get().GitRevision,
+				"branch":    Get().GitBranch,
+				"goversion": runtime.Version(),
+				"goos":      runtime.GOOS,
+				"goarch":    runtime.GOARCH,
+				"compiler":  runtime.Compiler,
+				"platform":  fmt.Sprintf("%s/%s", runtime.GOOS, runtime.GOARCH),
+			},
+		},
+		func() float64 { return 1 },
+	)
+}

pkg/version/version_test.go

@@ -32,12 +32,14 @@ func TestInfo_String(t *testing.T) {
 				GitVersion:   "1.3.0",
 				GitCommit:    "da070e68f3318410c8c70ed8186a2bc4736dacbd",
 				GitTreeState: "clean",
+				GitRevision:  "851c78564",
+				GitBranch:    "v1.3.0",
 				BuildDate:    "2022-08-31T13:09:22Z",
 				GoVersion:    "go1.18.3",
 				Compiler:     "gc",
 				Platform:     "linux/amd64",
 			},
-			want: `version.Info{GitVersion:"1.3.0", GitCommit:"da070e68f3318410c8c70ed8186a2bc4736dacbd", GitTreeState:"clean", BuildDate:"2022-08-31T13:09:22Z", GoVersion:"go1.18.3", Compiler:"gc", Platform:"linux/amd64"}`,
+			want: `version.Info{GitVersion:"1.3.0", GitCommit:"da070e68f3318410c8c70ed8186a2bc4736dacbd", GitRevision:"851c78564", GitTreeState:"clean", GitBranch:"v1.3.0", BuildDate:"2022-08-31T13:09:22Z", GoVersion:"go1.18.3", Compiler:"gc", Platform:"linux/amd64"}`,
 		},
 	}
 	for _, tt := range tests {