Merge pull request #74 from yubiuser/development

vNext

Author: yubiuser

.devcontainer/Dockerfile

@@ -4,6 +4,7 @@ ARG golang_version=1.21
 FROM golang:${golang_version}-alpine${alpine_version}
 RUN apk add --no-cache \
                 git \
+                make \
                 nano\
                 openssh
 

.editorconfig

@@ -13,3 +13,6 @@ trim_trailing_whitespace = true
 
 [*.go]
 indent_style = tab
+
+[makefile]
+indent_style = tab

.github/workflows/ghcr.yml

@@ -35,6 +35,24 @@ jobs:
 
       - name: Checkout Code
         uses: actions/[email protected]
+        with:
+          fetch-depth: 0
+          ref: ${{ github.head_ref }}
+
+      - name: "Calculate required variables"
+        id: variables
+        run: |
+          GIT_TAG=${{ github.event.release.tag_name }}
+          # If GIT_TAG is set then GIT BRANCH should be "main", else get it from the branch name
+          GIT_BRANCH=$([ -n "${GIT_TAG}" ] && echo "main" || git rev-parse --abbrev-ref HEAD)
+          GIT_VERSION=$(git --no-pager describe --tags --always --abbrev=8 --dirty)
+          GIT_COMMIT=$(git --no-pager describe --always --abbrev=8 --dirty)
+          GIT_DATE=$(git --no-pager show --date=short --format=%at --name-only | head -n 1)
+          echo "GIT_TAG=${GIT_TAG}" >> $GITHUB_ENV
+          echo "GIT_BRANCH=${GIT_BRANCH}" >> $GITHUB_ENV
+          echo "GIT_VERSION=${GIT_VERSION}" >> $GITHUB_ENV
+          echo "GIT_COMMIT=${GIT_COMMIT}" >> $GITHUB_ENV
+          echo "GIT_DATE=${GIT_DATE}" >> $GITHUB_ENV
 
       - name: Set up QEMU
         uses: docker/[email protected]
@@ -63,6 +81,12 @@ jobs:
         with:
           context: .
           file: ./Dockerfile
+          build-args: |
+            GIT_TAG=${{ env.GIT_TAG }}
+            GIT_BRANCH=${{ env.GIT_BRANCH }}
+            GIT_VERSION=${{ env.GIT_VERSION }}
+            GIT_COMMIT=${{ env.GIT_COMMIT }}
+            GIT_DATE=${{ env.GIT_DATE }}
           platforms: ${{ matrix.platform }}
           labels: ${{ steps.meta.outputs.labels }}
           provenance: false

Dockerfile

@@ -2,11 +2,19 @@ ARG alpine_version=3.19
 ARG golang_version=1.21
 
 FROM golang:${golang_version}-alpine${alpine_version} as builder
+ARG GIT_COMMIT
+ARG GIT_BRANCH
+ARG GIT_VERSION
+ARG GIT_DATE
+ARG GIT_TAG
+
+RUN apk add --no-cache \
+                git \
+                make
 
 COPY /src /src
 WORKDIR /src
-RUN go mod download
-RUN CGO_ENABLED=0 go build -ldflags "-s -w"  docker-event-monitor.go
+RUN make build
 
 FROM scratch as deploy
 COPY --from=builder /src/docker-event-monitor docker-event-monitor

Readme.md

@@ -63,6 +63,7 @@ services:
       FILTER: 'event=start,event=stop,type=container'
       DELAY: '500ms'
       LOG_LEVEL: 'info'
+      SERVER_TAG: ''
 ```
 
 ### Build image locally
@@ -76,7 +77,7 @@ docker build -t docker-event-monitor:local .
 
 ### Build binary locally
 
-If you have a suitable `Go` environment set up, you can build the binary from `/src/`. For development, a `devcontainer` with a suitable `Dockerfile` is provided as well.
+If you have a suitable `Go` environment set up, you can build the binary from `/src/`. For development, a `devcontainer` with a suitable `Dockerfile` is provided as well. If you run `make build` instead of `go build`, `git` commit/branch/date information are injected into to binary.
 
 ### Environment variables and configuration
 

docker-compose.yml

@@ -25,4 +25,4 @@ services:
       FILTER: 'event=start,event=stop,type=container'
       DELAY: '500ms'
       LOG_LEVEL: 'info'
-
+      SERVER_TAG: ''

src/docker-event-monitor.go

@@ -44,6 +44,7 @@ type args struct {
 	Filter           map[string][]string `arg:"-"`
 	LogLevel         string              `arg:"env:LOG_LEVEL" default:"info" help:"Set log level. Use debug for more logging."`
 	ServerTag        string              `arg:"env:SERVER_TAG" help:"Prefix to include in the title of notifications. Useful when running docker-event-monitors on multiple machines."`
+	Version          bool                `arg:"-v" help:"Print version information."`
 }
 
 // Creating a global logger
@@ -52,11 +53,31 @@ var logger zerolog.Logger
 // hold the supplied run-time arguments globally
 var glb_arguments args
 
+// version information, are injected during build process
+var (
+	version string = "n/a"
+	commit  string = "n/a"
+	date    string
+	gitdate string
+	branch  string = "n/a"
+)
+
 func init() {
 	parseArgs()
-
 	configureLogger(glb_arguments.LogLevel)
 
+	// if the -v flag was set, print version information and exit
+	if glb_arguments.Version {
+		logger.Info().
+			Str("Version", version).
+			Str("Branch", branch).
+			Str("Commit", commit).
+			Time("Compile_date", stringToUnix(date)).
+			Time("Git_date", stringToUnix(gitdate)).
+			Msg("Version Information")
+		os.Exit(0)
+	}
+
 	if glb_arguments.Pushover {
 		if len(glb_arguments.PushoverAPIToken) == 0 {
 			logger.Fatal().Msg("Pushover enabled. Pushover API token required!")
@@ -121,6 +142,13 @@ func main() {
 			Str("ServerTag", glb_arguments.ServerTag).
 			Str("Filter", strings.Join(glb_arguments.FilterStrings, " ")),
 		).
+		Dict("version", zerolog.Dict().
+			Str("Version", version).
+			Str("Branch", branch).
+			Str("Commit", commit).
+			Time("Compile_date", stringToUnix(date)).
+			Time("Git_date", stringToUnix(gitdate)),
+		).
 		Msg("Docker event monitor started")
 
 	timestamp := time.Now()
@@ -448,23 +476,32 @@ func parseArgs() {
 }
 
 func configureLogger(LogLevel string) {
-	// UNIX Time is faster and smaller than most timestamps
-	zerolog.TimeFieldFormat = zerolog.TimeFormatUnix
+	// Configure time/timestamp format
+	zerolog.TimeFieldFormat = time.RFC1123Z
 
 	// Change logging level when debug flag is set
 	if LogLevel == "debug" {
-		logger = zerolog.New(os.Stderr).
+		logger = zerolog.New(os.Stdout).
 			Level(zerolog.DebugLevel).
 			With().
 			Timestamp().
 			Str("service", "docker event monitor").
 			Logger()
 	} else {
-		logger = zerolog.New(os.Stderr).
+		logger = zerolog.New(os.Stdout).
 			Level(zerolog.InfoLevel).
 			With().
 			Str("service", "docker event monitor").
 			Timestamp().
 			Logger()
 	}
 }
+
+func stringToUnix(str string) time.Time {
+	i, err := strconv.ParseInt(str, 10, 64)
+	if err != nil {
+		logger.Fatal().Err(err).Msg("String to timestamp conversion failed")
+	}
+	tm := time.Unix(i, 0)
+	return tm
+}

src/go.mod

@@ -4,7 +4,7 @@ go 1.21
 
 require (
 	github.com/alexflint/go-arg v1.4.3
-	github.com/docker/docker v25.0.1+incompatible
+	github.com/docker/docker v25.0.2+incompatible
 	github.com/gregdel/pushover v1.3.0
 	github.com/rs/zerolog v1.31.0
 	golang.org/x/text v0.14.0

src/go.sum

@@ -17,8 +17,8 @@ github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/distribution/reference v0.5.0 h1:/FUIFXtfc/x2gpa5/VGfiGLuOIdYa1t65IKK2OFGvA0=
 github.com/distribution/reference v0.5.0/go.mod h1:BbU0aIcezP1/5jX/8MP0YiH4SdvB5Y4f/wlDRiLyi3E=
-github.com/docker/docker v25.0.1+incompatible h1:k5TYd5rIVQRSqcTwCID+cyVA0yRg86+Pcrz1ls0/frA=
-github.com/docker/docker v25.0.1+incompatible/go.mod h1:eEKB0N0r5NX/I1kEveEz05bcu8tLC/8azJZsviup8Sk=
+github.com/docker/docker v25.0.2+incompatible h1:/OaKeauroa10K4Nqavw4zlhcDq/WBcPMc5DbjOGgozY=
+github.com/docker/docker v25.0.2+incompatible/go.mod h1:eEKB0N0r5NX/I1kEveEz05bcu8tLC/8azJZsviup8Sk=
 github.com/docker/go-connections v0.5.0 h1:USnMq7hx7gwdVZq1L49hLXaFtUdTADjXGp+uj1Br63c=
 github.com/docker/go-connections v0.5.0/go.mod h1:ov60Kzw0kKElRwhNs9UlUHAE/F9Fe6GLaXnqyDdmEXc=
 github.com/docker/go-units v0.5.0 h1:69rxXcBk27SvSaaxTtLh/8llcHD8vYHT7WSdRZ/jvr4=

src/makefile

@@ -0,0 +1,11 @@
+BINARY_NAME := docker-event-monitor
+GIT_COMMIT ?= $(shell git --no-pager describe --always --abbrev=8 --dirty)
+GIT_BRANCH ?= $(shell git rev-parse --abbrev-ref HEAD)
+GIT_VERSION ?= $(shell git --no-pager describe --tags --always --abbrev=8 --dirty)
+GIT_DATE ?= $(shell git --no-pager show --date=short --format=%at --name-only | head -n 1)
+ifdef GIT_TAG
+override GIT_VERSION = ${GIT_TAG}
+endif
+DATE := $(shell date +%s)
+build:
+	CGO_ENABLED=0 go build -ldflags "-s -w -X 'main.version=${GIT_VERSION}' -X 'main.gitdate=${GIT_DATE}' -X 'main.date=${DATE}' -X 'main.commit=${GIT_COMMIT}' -X 'main.branch=${GIT_BRANCH}'" -o=${BINARY_NAME} docker-event-monitor.go