feat(operator): Add commit hash, buildtime, buildversion to OTel reso…

…urce attributes (#121) Signed-off-by: Giovanni Liva <giovanni.liva@dynatrace.com>
keptn · Oct 6, 2022 · 5a2ef61 · 5a2ef61
1 parent 9bd5d14
commit 5a2ef61
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 13 deletions.
diff --git a/operator/Dockerfile b/operator/Dockerfile
@@ -2,6 +2,8 @@
 FROM golang:1.18 as builder
 
 ARG ARCH
+ARG GIT_HASH
+ARG RELEASE_VERSION
 
 WORKDIR /workspace
 
@@ -20,7 +22,7 @@ COPY controllers/ controllers/
 COPY webhooks/ webhooks/
 
 # Build
-RUN make build.$ARCH
+RUN make build.$ARCH HASH=${GIT_HASH} TAG=${RELEASE_VERSION}
 
 # Use distroless as minimal base image to package the manager binary
 # Refer to https://github.com/GoogleContainerTools/distroless for more details

diff --git a/operator/Makefile b/operator/Makefile
@@ -4,7 +4,9 @@ IMG ?= controller:latest
 # RELEASE_REGISTRY is the container registry to push
 # into.
 RELEASE_REGISTRY?=ghcr.io/keptn-sandbox
-RELEASE_VERSION?=$(shell date +%Y%m%d%s)-v0.24.3#$(shell git describe --tags --match "v*")
+RELEASE_TIME=$(shell date +%Y%m%d%s)
+BUILD_TIME=$(shell date -u "+%F_%T")
+RELEASE_VERSION?=$(RELEASE_TIME)-v0.24.3#$(shell git describe --tags --match "v*")
 TAG?=latest
 RELEASE_IMAGE:=keptn-lifecycle-operator:$(TAG)
 
@@ -32,6 +34,9 @@ endif
 SHELL = /usr/bin/env bash -o pipefail
 .SHELLFLAGS = -ec
 
+# Compute the current Git commit hash
+HASH?=$(shell git rev-parse HEAD)
+
 .PHONY: all
 all: build
 
@@ -77,15 +82,15 @@ test: manifests generate fmt vet envtest ## Run tests.
 ##@ Build
 .PHONY: build
 build: generate fmt vet ## Build manager binary.
-	$(COMMONENVVAR) $(BUILDENVVAR) go build -ldflags '-w' -o bin/manager main.go
+	$(COMMONENVVAR) $(BUILDENVVAR) go build -ldflags '-w -X main.gitCommit=$(HASH) -X main.buildTime=$(BUILD_TIME) -X main.buildVersion=$(TAG)' -o bin/manager main.go
 
 .PHONY: build.amd64
 build.amd64: generate fmt vet ## Build manager binary.
-	$(COMMONENVVAR) $(BUILDENVVAR) GOARCH=amd64 go build -ldflags '-w' -o bin/manager main.go
+	$(COMMONENVVAR) $(BUILDENVVAR) GOARCH=amd64 go build -ldflags '-w -X main.gitCommit=$(HASH) -X main.buildTime=$(BUILD_TIME) -X main.buildVersion=$(TAG)' -o bin/manager main.go
 
 .PHONY: build.arm64v8
 build.arm64v8: generate fmt vet ## Build manager binary.
-	$(COMMONENVVAR) $(BUILDENVVAR) GOARCH=arm64 go build -ldflags '-w' -o bin/manager main.go
+	$(COMMONENVVAR) $(BUILDENVVAR) GOARCH=arm64 go build -ldflags '-w -X main.gitCommit=$(HASH) -X main.buildTime=$(BUILD_TIME) -X main.buildVersion=$(TAG)' -o bin/manager main.go
 
 .PHONY: run
 run: manifests generate fmt vet ## Run a controller from your host.
@@ -162,11 +167,11 @@ release-image: release-image.amd64 release-image.arm64v8
 
 .PHONY: release-image.amd64
 release-image.amd64: clean
-	docker build --load --build-arg ARCH="amd64" --build-arg RELEASE_VERSION="$(RELEASE_VERSION)" -t $(RELEASE_REGISTRY)/$(RELEASE_IMAGE)-amd64 .
+	docker build --load --build-arg ARCH="amd64" --build-arg GIT_HASH="$(HASH)" --build-arg RELEASE_VERSION="$(TAG)" -t $(RELEASE_REGISTRY)/$(RELEASE_IMAGE)-amd64 .
 
 .PHONY: release-image.arm64v8
 release-image.arm64v8: clean
-	docker build --load --build-arg ARCH="arm64v8" --build-arg RELEASE_VERSION="$(RELEASE_VERSION)" -t $(RELEASE_REGISTRY)/$(RELEASE_IMAGE)-arm64 .
+	docker build --load --build-arg ARCH="arm64v8" --build-arg GIT_HASH="$(HASH)" --build-arg RELEASE_VERSION="$(TAG)" -t $(RELEASE_REGISTRY)/$(RELEASE_IMAGE)-arm64 .
 
 .PHONY: push-release-images
 push-release-images:
@@ -203,8 +208,8 @@ release-local: release-local.amd64 release-local.arm64v8
 
 .PHONY: release-local.amd64
 release-local.amd64: clean
-	docker build --build-arg ARCH="amd64" --build-arg RELEASE_VERSION="$(RELEASE_VERSION)" -t $(RELEASE_REGISTRY)/$(RELEASE_IMAGE)-amd64 .
+	docker build --build-arg ARCH="amd64" --build-arg GIT_HASH="$(HASH)" --build-arg RELEASE_VERSION="$(TAG)" -t $(RELEASE_REGISTRY)/$(RELEASE_IMAGE)-amd64 .
 
 .PHONY: release-local.arm64v8
 release-local.arm64v8: clean
-	docker build --build-arg ARCH="arm64v8" --build-arg RELEASE_VERSION="$(RELEASE_VERSION)" -t $(RELEASE_REGISTRY)/$(RELEASE_IMAGE)-arm64 .
+	docker build --build-arg ARCH="arm64v8" --build-arg GIT_HASH="$(HASH)" --build-arg RELEASE_VERSION="$(TAG)" -t $(RELEASE_REGISTRY)/$(RELEASE_IMAGE)-arm64 .
diff --git a/operator/main.go b/operator/main.go
@@ -55,8 +55,11 @@ import (
 )
 
 var (
-	scheme   = runtime.NewScheme()
-	setupLog = ctrl.Log.WithName("setup")
+	scheme       = runtime.NewScheme()
+	setupLog     = ctrl.Log.WithName("setup")
+	gitCommit    string
+	buildTime    string
+	buildVersion string
 )
 
 func init() {
@@ -197,7 +200,6 @@ func main() {
 		setupLog.Error(err, "problem running manager")
 		os.Exit(1)
 	}
-
 }
 
 func newExporter() (trace.SpanExporter, error) {
@@ -214,8 +216,9 @@ func newResource() *resource.Resource {
 		resource.Default(),
 		resource.NewWithAttributes(
 			semconv.SchemaURL,
+			semconv.TelemetrySDKLanguageGo,
 			semconv.ServiceNameKey.String("keptn-lifecycle-operator"),
-			semconv.ServiceVersionKey.String("v0.1.0"),
+			semconv.ServiceVersionKey.String(buildVersion+"-"+gitCommit+"-"+buildTime),
 		),
 	)
 	return r