Add version information to binaries

.github/workflows/publish-container-images.yaml

@@ -51,7 +51,7 @@ jobs:
           images: ${{ matrix.image }}
           # Use latest tag on default branch (main), otherwise use the tag
           tags: |
-            type=raw, value=latest, enable={{is_default_branch}}
+            # type=raw, value=latest, enable={{is_default_branch}}
             type=ref, event=tag
           flavor: |
             latest=false
@@ -63,6 +63,10 @@ jobs:
         with:
           context: .
           file: ${{ matrix.dockerfile }}
+          build-args: |
+            VERSION=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.version'] }}
+            GIT_COMMIT=${{ github.sha }}
+            BUILD_TIME=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.created'] }}
           push: true
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}

build/images/Dockerfile.alerter

@@ -5,7 +5,14 @@ RUN tdnf install -y golang ca-certificates
 ADD . /code
 WORKDIR /code
 
-RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -o ./bin/alerter ./cmd/alerter
+ARG VERSION GIT_COMMIT BUILD_TIME
+
+RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build \
+-ldflags=" \
+-X 'github.com/Azure/adx-mon/pkg/version.Version=${VERSION}' \
+-X 'github.com/Azure/adx-mon/pkg/version.GitCommit=${GIT_COMMIT}' \
+-X 'github.com/Azure/adx-mon/pkg/version.BuildTime=${BUILD_TIME}' \
+" -o ./bin/alerter ./cmd/alerter
 
 FROM mcr.microsoft.com/cbl-mariner/distroless/minimal:2.0
 

build/images/Dockerfile.collector

@@ -5,7 +5,12 @@ RUN tdnf install -y golang systemd-devel gcc glibc-devel binutils kernel-headers
 ADD . /code
 WORKDIR /code
 
-RUN CGO_ENABLED=1 GOOS=linux GOARCH=amd64 go build -o ./bin/collector ./cmd/collector
+RUN CGO_ENABLED=1 GOOS=linux GOARCH=amd64 go build \
+-ldflags=" \
+-X 'github.com/Azure/adx-mon/pkg/version.Version=${VERSION}' \
+-X 'github.com/Azure/adx-mon/pkg/version.GitCommit=${GIT_COMMIT}' \
+-X 'github.com/Azure/adx-mon/pkg/version.BuildTime=${BUILD_TIME}' \
+" -o ./bin/collector ./cmd/collector
 
 # Install systemd lib to get libsystemd.so
 FROM mcr.microsoft.com/cbl-mariner/base/core:2.0 AS libsystemdsource

build/images/Dockerfile.ingestor

@@ -5,7 +5,12 @@ RUN tdnf install -y golang ca-certificates
 ADD . /code
 WORKDIR /code
 
-RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -o ./bin/ingestor ./cmd/ingestor
+RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build \
+-ldflags=" \
+-X 'github.com/Azure/adx-mon/pkg/version.Version=${VERSION}' \
+-X 'github.com/Azure/adx-mon/pkg/version.GitCommit=${GIT_COMMIT}' \
+-X 'github.com/Azure/adx-mon/pkg/version.BuildTime=${BUILD_TIME}' \
+" -o ./bin/ingestor ./cmd/ingestor
 
 FROM mcr.microsoft.com/cbl-mariner/distroless/minimal:2.0
 

cmd/alerter/main.go

@@ -11,6 +11,7 @@ import (
 	"github.com/Azure/adx-mon/alerter"
 	alertrulev1 "github.com/Azure/adx-mon/api/v1"
 	"github.com/Azure/adx-mon/pkg/logger"
+	"github.com/Azure/adx-mon/pkg/version"
 	"github.com/urfave/cli/v2" // imports as package "cli"
 	"k8s.io/client-go/dynamic"
 	"k8s.io/client-go/kubernetes"
@@ -40,6 +41,7 @@ func main() {
 		Commands: []*cli.Command{
 			NewLintCommand(),
 		},
+		Version: version.String(),
 	}
 
 	if err := app.Run(os.Args); err != nil {
@@ -48,6 +50,8 @@ func main() {
 }
 
 func realMain(ctx *cli.Context) error {
+	logger.Infof("alerter version:%s", version.String())
+
 	endpoints := make(map[string]string)
 	endpointsArg := ctx.StringSlice("kusto-endpoint")
 	for _, v := range endpointsArg {

cmd/collector/main.go

@@ -28,6 +28,7 @@ import (
 	"github.com/Azure/adx-mon/pkg/k8s"
 	"github.com/Azure/adx-mon/pkg/logger"
 	"github.com/Azure/adx-mon/pkg/remote"
+	"github.com/Azure/adx-mon/pkg/version"
 	"github.com/Azure/adx-mon/schema"
 	"github.com/Azure/adx-mon/storage"
 	"github.com/pelletier/go-toml/v2"
@@ -68,6 +69,8 @@ func main() {
 		Action: func(ctx *cli.Context) error {
 			return realMain(ctx)
 		},
+
+		Version: version.String(),
 	}
 
 	if err := app.Run(os.Args); err != nil {
@@ -76,6 +79,8 @@ func main() {
 }
 
 func realMain(ctx *cli.Context) error {
+	logger.Infof("collector version:%s", version.String())
+
 	runtime.MemProfileRate = 4096
 	runtime.SetBlockProfileRate(int(1 * time.Second))
 	runtime.SetMutexProfileFraction(1)

cmd/ingestor/main.go

@@ -26,6 +26,7 @@ import (
 	"github.com/Azure/adx-mon/pkg/limiter"
 	"github.com/Azure/adx-mon/pkg/logger"
 	"github.com/Azure/adx-mon/pkg/tls"
+	"github.com/Azure/adx-mon/pkg/version"
 	"github.com/Azure/adx-mon/schema"
 	"github.com/Azure/azure-kusto-go/kusto"
 	"github.com/prometheus/client_golang/prometheus/promhttp"
@@ -85,6 +86,8 @@ func main() {
 		Action: func(ctx *cli.Context) error {
 			return realMain(ctx)
 		},
+
+		Version: version.String(),
 	}
 
 	if err := app.Run(os.Args); err != nil {
@@ -93,6 +96,8 @@ func main() {
 }
 
 func realMain(ctx *cli.Context) error {
+	logger.Infof("ingestor version:%s", version.String())
+
 	svcCtx, cancel := context.WithCancel(context.Background())
 	defer cancel()
 

pkg/version/version.go

@@ -0,0 +1,13 @@
+package version
+
+import "fmt"
+
+var (
+	GitCommit string
+	BuildTime string
+	Version   string
+)
+
+func String() string {
+	return fmt.Sprintf("%s, Commit:%s, Build-time:%s", Version, GitCommit, BuildTime)
+}