feat: Add build information

.github/workflows/publish-custom.yml

@@ -5,6 +5,7 @@ on:
     inputs:
       tag:
         description: Custom tag to publish
+        default: custom
       platforms:
         description: Platforms to publish to (comma separated list)
         default: linux/amd64
@@ -47,3 +48,7 @@ jobs:
           push: true
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
+          build-args: |
+            VERSION=${{ inputs.tag }}
+            REVISION=${{ github.sha }}
+            REVISION_DATE=${{ github.event.head_commit.timestamp }}

.github/workflows/publish-experimental.yml

@@ -32,3 +32,7 @@ jobs:
           push: true
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
+          build-args: |
+            VERSION=experimental
+            REVISION=${{ github.sha }}
+            REVISION_DATE=${{ github.event.head_commit.timestamp }}

.github/workflows/publish-latest.yml

@@ -50,3 +50,7 @@ jobs:
           push: true
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
+          build-args: |
+            VERSION=latest
+            REVISION=${{ github.sha }}
+            REVISION_DATE=${{ github.event.head_commit.timestamp }}

.github/workflows/publish-release.yml

@@ -49,3 +49,7 @@ jobs:
           push: true
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
+          build-args: |
+            VERSION=${{ env.RELEASE }}
+            REVISION=${{ github.sha }}
+            REVISION_DATE=${{ github.event.head_commit.timestamp }}

Dockerfile

@@ -1,10 +1,19 @@
 # Build the go application into a binary
 FROM golang:alpine AS builder
+
+ARG VERSION
+ARG REVISION
+ARG REVISION_DATE
+
 RUN apk --update add ca-certificates
 WORKDIR /app
 COPY . ./
 RUN go mod tidy -diff
-RUN CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -o gatus .
+RUN CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo \
+-ldflags "-X github.com/TwiN/gatus/v5/buildinfo.version=${VERSION} \
+-X github.com/TwiN/gatus/v5/buildinfo.revision=${REVISION} \
+-X github.com/TwiN/gatus/v5/buildinfo.date=${REVISION_DATE}" \
+-o gatus .
 
 # Run Tests inside docker image if you don't have a configured go environment
 #RUN apk update && apk add --virtual build-dependencies build-base gcc

Makefile

@@ -1,8 +1,9 @@
 BINARY=gatus
+VERSION=$(shell git describe --tags --exact-match 2> /dev/null)
 
 .PHONY: install
 install:
-	go build -v -o $(BINARY) .
+	go build -v -ldflags "-X github.com/TwiN/gatus/v5/buildinfo.version=$(VERSION)" -o $(BINARY) .
 
 .PHONY: run
 run:
@@ -25,8 +26,12 @@ test:
 # Docker #
 ##########
 
+DIRTY=$(shell test -n "$$(git status --porcelain)" && echo "-dirty")
 docker-build:
-	docker build -t twinproduction/gatus:latest .
+	docker build --build-arg VERSION=$(VERSION) \
+		--build-arg REVISION=$(shell git rev-parse HEAD)$(DIRTY) \
+		--build-arg REVISION_DATE=$(shell TZ=UTC git show -s --format=%cd --date=iso-strict-local) \
+		-t twinproduction/gatus:latest .
 
 docker-run:
 	docker run -p 8080:8080 --name gatus twinproduction/gatus:latest

README.md

@@ -275,6 +275,7 @@ If you want to test it locally, see [Docker](#docker).
 | `ui.dark-mode`               | Whether to enable dark mode by default. Note that this is superseded by the user's operating system theme preferences.                   | `true`                     |
 | `ui.default-sort-by`         | Default sorting option for endpoints in the dashboard. Can be `name`, `group`, or `health`. Note that user preferences override this.    | `name`                     |
 | `ui.default-filter-by`       | Default filter option for endpoints in the dashboard. Can be `none`, `failing`, or `unstable`. Note that user preferences override this. | `none`                     |
+| `ui.show-build-info`         | Whether to show build information (version in footer).                                                                                   | `true`                      |
 | `maintenance`                | [Maintenance configuration](#maintenance).                                                                                               | `{}`                       |
 
 If you want more verbose logging, you may set the `GATUS_LOG_LEVEL` environment variable to `DEBUG`.
@@ -2685,6 +2686,7 @@ endpoint on the same port your application is configured to run on (`web.port`).
 
 | Metric name                                  | Type    | Description                                                                | Labels                          | Relevant endpoint types |
 |:---------------------------------------------|:--------|:---------------------------------------------------------------------------|:--------------------------------|:------------------------|
+| gatus_build_info                             | gauge   | Build information about the instance                                       | version, revision, build_date   | None                    |
 | gatus_results_total                          | counter | Number of results per endpoint per success state                           | key, group, name, type, success | All                     |
 | gatus_results_code_total                     | counter | Total number of results by code                                            | key, group, name, type, code    | DNS, HTTP               |
 | gatus_results_connected_total                | counter | Total number of results in which a connection was successfully established | key, group, name, type          | All                     |

buildinfo/buildinfo.go

@@ -0,0 +1,84 @@
+package buildinfo
+
+import (
+	"runtime"
+	"runtime/debug"
+)
+
+const (
+	defaultVersion  = "development"
+	defaultRevision = "unknown"
+	defaultDate     = "unknown"
+)
+
+var (
+	version  string
+	revision string
+	date     string
+
+	buildInfo = SetBuildInfo(GetDefault())
+)
+
+type BuildInfo struct {
+	Version   string
+	Revision  string
+	Date      string
+	GoVersion string
+	Dirty     bool
+}
+
+func SetEmbedded(info *BuildInfo) {
+	rawInfo, ok := debug.ReadBuildInfo()
+	if !ok {
+		info.Revision += "-buildinfo-err"
+	}
+	for _, s := range rawInfo.Settings {
+		switch s.Key {
+		case "vcs.revision":
+			info.Revision = s.Value
+		case "vcs.time":
+			info.Date = s.Value
+		case "vcs.modified":
+			info.Dirty = s.Value == "true"
+		}
+	}
+}
+
+func SetLdflags(info *BuildInfo) {
+	if len(version) > 0 {
+		info.Version = version
+	}
+	if len(revision) > 0 {
+		info.Revision = revision
+	}
+	if len(date) > 0 {
+		info.Date = date
+	}
+	if len(info.GoVersion) == 0 {
+		info.GoVersion = runtime.Version()
+	}
+}
+
+func GetDefault() BuildInfo {
+	return BuildInfo{
+		Version:   defaultVersion,
+		Revision:  defaultRevision,
+		Date:      defaultDate,
+		GoVersion: runtime.Version(),
+		Dirty:     false,
+	}
+}
+
+func SetBuildInfo(info BuildInfo) BuildInfo {
+	SetEmbedded(&info)
+	SetLdflags(&info)
+
+	if info.Dirty {
+		info.Revision += "-dirty"
+	}
+	return info
+}
+
+func Get() BuildInfo {
+	return buildInfo
+}

buildinfo/buildinfo_test.go

@@ -0,0 +1,167 @@
+package buildinfo
+
+import (
+	"runtime"
+	"testing"
+)
+
+func TestBuildInfo_GetDefaults(t *testing.T) {
+	info := GetDefault()
+	if info.Version != defaultVersion {
+		t.Errorf("Expected default Version '%s', got '%s'", defaultVersion, info.Version)
+	}
+	if info.Revision != defaultRevision {
+		t.Errorf("Expected default Revision '%s', got '%s'", defaultRevision, info.Revision)
+	}
+	if info.Date != defaultDate {
+		t.Errorf("Expected default Date '%s', got '%s'", defaultDate, info.Date)
+	}
+	if info.GoVersion != runtime.Version() {
+		t.Errorf("Expected GoVersion '%s', got '%s'", runtime.Version(), info.GoVersion)
+	}
+	if info.Dirty != false {
+		t.Errorf("Expected Dirty 'false', got '%v'", info.Dirty)
+	}
+}
+
+func TestBuildInfo_SetLdflags(t *testing.T) {
+	t.Run("NoLdflags", func(t *testing.T) {
+		info := GetDefault()
+		SetLdflags(&info)
+
+		// Since we are not setting ldflags during the test, the values largely remain defaults
+		if info.Version != defaultVersion {
+			t.Errorf("Expected Version '%s', got '%s'", defaultVersion, info.Version)
+		}
+		if info.Revision != defaultRevision {
+			t.Errorf("Expected Revision '%s', got '%s'", defaultRevision, info.Revision)
+		}
+		if info.Date != defaultDate {
+			t.Errorf("Expected Date '%s', got '%s'", defaultDate, info.Date)
+		}
+		if info.GoVersion != runtime.Version() {
+			t.Errorf("Expected GoVersion '%s', got '%s'", runtime.Version(), info.GoVersion)
+		}
+		if info.Dirty != false {
+			t.Errorf("Expected Dirty 'false', got '%v'", info.Dirty)
+		}
+	})
+	t.Run("WithLdflags", func(t *testing.T) {
+		// Simulate ldflags being set
+		originalVersion := version
+		originalRevision := revision
+		originalDate := date
+		defer func() {
+			version = originalVersion
+			revision = originalRevision
+			date = originalDate
+		}()
+		version = "test-version"
+		revision = "test-revision"
+		date = "test-date"
+
+		info := GetDefault()
+		SetLdflags(&info)
+
+		if info.Version != "test-version" {
+			t.Errorf("Expected Version 'test-version', got '%s'", info.Version)
+		}
+		if info.Revision != "test-revision" {
+			t.Errorf("Expected Revision 'test-revision', got '%s'", info.Revision)
+		}
+		if info.Date != "test-date" {
+			t.Errorf("Expected Date ''test-date', got '%s'", info.Date)
+		}
+		if info.GoVersion != runtime.Version() {
+			t.Errorf("Expected GoVersion '%s', got '%s'", runtime.Version(), info.GoVersion)
+		}
+		if info.Dirty != false {
+			t.Errorf("Expected Dirty 'false', got '%v'", info.Dirty)
+		}
+	})
+}
+
+func TestBuildInfo_SetEmbedded(t *testing.T) {
+	info := GetDefault()
+	SetEmbedded(&info)
+
+	if info.Version != defaultVersion {
+		t.Errorf("Expected Version '%s', got '%s'", defaultVersion, info.Version)
+	}
+	if info.Revision != defaultRevision {
+		t.Errorf("Expected Revision '%s', got '%s'", defaultRevision, info.Revision)
+	}
+	if info.Date != defaultDate {
+		t.Errorf("Expected Date '%s', got '%s'", defaultDate, info.Date)
+	}
+	if info.GoVersion != runtime.Version() {
+		t.Errorf("Expected GoVersion '%s', got '%s'", runtime.Version(), info.GoVersion)
+	}
+	if info.Dirty != false {
+		t.Errorf("Expected Dirty 'false', got '%v'", info.Dirty)
+	}
+}
+
+func TestBuildInfo_SetBuildInfo(t *testing.T) {
+	t.Run("TestEmbeddOverwriteLdflags", func(t *testing.T) {
+		// Only change one ldflag at a time to test their effects
+		originalVersion := version
+		defer func() {
+			version = originalVersion
+		}()
+		version = "test-version"
+
+		defaultInfo := GetDefault()
+		info := SetBuildInfo(defaultInfo)
+		if info.Version != "test-version" {
+			t.Errorf("Expected Version 'test-version', got '%s'", info.Version)
+		}
+		if info.Revision != defaultRevision {
+			t.Errorf("Expected Revision '%s', got '%s'", defaultRevision, info.Revision)
+		}
+		if info.Date != defaultDate {
+			t.Errorf("Expected Date '%s', got '%s'", defaultDate, info.Date)
+		}
+		if info.GoVersion != runtime.Version() {
+			t.Errorf("Expected GoVersion '%s', got '%s'", runtime.Version(), info.GoVersion)
+		}
+		if info.Dirty != false {
+			t.Errorf("Expected Dirty 'false', got '%v'", info.Dirty)
+		}
+
+		// Change another ldflag
+		originalRevision := revision
+		defer func() {
+			revision = originalRevision
+		}()
+		revision = "test-rev"
+
+		info = SetBuildInfo(GetDefault())
+		if info.Revision != "test-rev" {
+			t.Errorf("Expected Revision 'test-rev', got '%s'", info.Revision)
+		}
+
+		// Change the last ldflag
+		originalDate := date
+		defer func() {
+			date = originalDate
+		}()
+		date = "test-date"
+
+		info = SetBuildInfo(defaultInfo)
+		if info.Date != "test-date" {
+			t.Errorf("Expected Date 'test-date', got '%s'", info.Date)
+		}
+	})
+	t.Run("TestDirtyFlag", func(t *testing.T) {
+		info := GetDefault()
+		info.Dirty = true // Simulate the embedded info setting Dirty to true
+		info = SetBuildInfo(info)
+		if info.Dirty != true {
+			t.Errorf("Expected Dirty 'true', got '%v'", info.Dirty)
+		}
+		if info.Revision != defaultRevision+"-dirty" {
+			t.Errorf("Expected Revision '%s-dirty', got '%s'", defaultRevision, info.Revision)
+		}
+	})
+}