Go 1.17 enhancements

Author: lukasmalkmus

.github/workflows/pr.yml

@@ -6,7 +6,7 @@ on:
       - main
 
 env:
-  GOVERSION: "1.16"
+  GOVERSION: "1.17"
 
 jobs:
   lint:

.github/workflows/push.yml

@@ -6,7 +6,7 @@ on:
       - main
 
 env:
-  GOVERSION: "1.16"
+  GOVERSION: "1.17"
 
 jobs:
   lint:

.github/workflows/release.yml

@@ -3,10 +3,10 @@ name: Release
 on:
   push:
     tags:
-      - "*"
+      - "v*"
 
 env:
-  GOVERSION: "1.16"
+  GOVERSION: "1.17"
 
 jobs:
   release:

.golangci.yml

@@ -19,14 +19,14 @@ linters:
     - goconst
     - gofmt
     - goimports
-    - golint
     - gosec
     - gosimple
     - govet
     - ineffassign
     - misspell
     - nolintlint
     - prealloc
+    - revive
     - staticcheck
     - structcheck
     - stylecheck

Dockerfile

@@ -3,9 +3,9 @@ FROM alpine
 LABEL maintainer="Axiom, Inc. <info@axiom.co>"
 
 # Upgrade packages and install ca-certificates.
-RUN apk update --no-cache
-RUN apk upgrade --no-cache
-RUN apk add --no-cache ca-certificates
+RUN apk update --no-cache                 \
+    && apk upgrade --no-cache             \
+    && apk add --no-cache ca-certificates
 
 # Copy binary into image.
 COPY axiom-honeycomb-proxy /usr/bin/axiom-honeycomb-proxy

Makefile

@@ -4,26 +4,28 @@ GO_BIN_IN_PATH  := CGO_ENABLED=0 go
 GOFMT			:= $(GO)fmt
 
 # ENVIRONMENT
-VERBOSE		=
-GOPATH		:= $(GOPATH)
+VERBOSE	=
+GOPATH	:= $(GOPATH)
 
 # APPLICATION INFORMATION
-BUILD_DATE      := $(shell date -u '+%Y-%m-%dT%H:%M:%SZ')
-REVISION        := $(shell git rev-parse --short HEAD)
-RELEASE         := $(shell git describe --tags 2>/dev/null || git rev-parse --short HEAD)-dev
-USER            := $(shell whoami)
+BUILD_DATE	:= $(shell date -u '+%Y-%m-%dT%H:%M:%SZ')
+REVISION	:= $(shell git rev-parse --short HEAD)
+RELEASE		:= $(shell git describe --tags 2>/dev/null || git rev-parse --short HEAD)-dev
+USER		:= $(shell whoami)
 
 # GO TOOLS
 GOLANGCI_LINT	:= bin/golangci-lint
 GORELEASER		:= bin/goreleaser
 GOTESTSUM		:= bin/gotestsum
 
+GOTOOLS := $(shell cat tools.go | grep "_ \"" | awk '{ print $$2 }' | tr -d '"')
+
 # MISC
 COVERPROFILE	:= coverage.out
-DIST_DIR		:= dist
+DIST_DIR	:= dist
 
 # TAGS
-GOTAGS := osusergo netgo static_build
+GOTAGS	:= osusergo netgo static_build
 
 # FLAGS
 GOFLAGS := -buildmode=pie -tags='$(GOTAGS)' -installsuffix=cgo -trimpath
@@ -62,12 +64,12 @@ build: $(GORELEASER) dep.stamp $(call go-pkg-sourcefiles, ./...) ## Build the bi
 .PHONY: clean
 clean: ## Remove build and test artifacts
 	@echo ">> cleaning up artifacts"
-	@rm -rf bin $(DIST_DIR) $(COVERPROFILE)
+	@rm -rf bin $(DIST_DIR) $(COVERPROFILE) dep.stamp
 
-.PHONY: cover
-cover: $(COVERPROFILE) ## Calculate the code coverage score
+.PHONY: coverage
+coverage: $(COVERPROFILE) ## Calculate the code coverage score
 	@echo ">> calculating code coverage"
-	@$(GO) tool cover -func=$(COVERPROFILE) | tail -n1
+	@$(GO) tool cover -func=$(COVERPROFILE) | grep total | awk '{print $$3}'
 
 .PHONY: dep-clean
 dep-clean: ## Remove obsolete dependencies
@@ -80,6 +82,9 @@ dep-upgrade: ## Upgrade all direct dependencies to their latest version
 	@$(GO) get -d $(shell $(GO) list -f '{{if not (or .Main .Indirect)}}{{.Path}}{{end}}' -m all)
 	@make dep
 
+.PHONY: dep-upgrade-tools
+dep-upgrade-tools: $(GOTOOLS) ## Upgrade all tool dependencies to their latest version and install them
+
 .PHONY: dep
 dep: dep-clean dep.stamp ## Install and verify dependencies and remove obsolete ones
 
@@ -138,3 +143,8 @@ $(GORELEASER): dep.stamp $(call go-pkg-sourcefiles, github.com/goreleaser/gorele
 $(GOTESTSUM): dep.stamp $(call go-pkg-sourcefiles, gotest.tools/gotestsum)
 	@echo ">> installing gotestsum"
 	@$(GO) install gotest.tools/gotestsum
+
+$(GOTOOLS): dep.stamp $(call go-pkg-sourcefiles, $@)
+	@echo ">> installing $@"
+	@$(GO) get -d $@
+	@$(GO) install $@

README.md

@@ -62,15 +62,19 @@ Docker images are available on [DockerHub][docker].
 
 ## Usage
 
-1. Set the following environment variables:
+1. Set the following environment variables to connect to Axiom Cloud:
 
-* `AXIOM_TOKEN`: **Personal Access** or **Ingest** token. Can be
-created under `Profile` or `Settings > Ingest Tokens`. For security reasons it
-is advised to use an Ingest Token with minimal privileges only.
+* `AXIOM_TOKEN`: **Personal Access** or **Ingest** token. Can be created under
+  `Profile` or `Settings > Ingest Tokens`. For security reasons it is advised to
+  use an Ingest Token with minimal privileges only.
+* `AXIOM_ORG_ID`: The organization identifier of the organization to use
 
 When using Axiom Selfhost:
 
-* `AXIOM_URL`: URL of the Axiom deployment to use.
+* `AXIOM_TOKEN`: **Personal Access** or **Ingest** token. Can be created under
+  `Profile` or `Settings > Ingest Tokens`. For security reasons it is advised to
+  use an Ingest Token with minimal privileges only.
+* `AXIOM_URL`: URL of the Axiom deployment to use
 
 2. Run it: `./axiom-honeycomb-proxy` or using Docker:
 
@@ -144,4 +148,4 @@ See [LICENSE](LICENSE) for more information.
 [license]: https://opensource.org/licenses/MIT
 [license_badge]: https://img.shields.io/github/license/axiomhq/axiom-honeycomb-proxy.svg?color=blue&style=flat-square&ghcache=unused
 [docker]: https://hub.docker.com/r/axiomhq/axiom-honeycomb-proxy
-[docker_badge]: https://img.shields.io/docker/pulls/axiomhq/axiom-honeycomb-proxy.svg?style=flat-square&ghcache=unused
+[docker_badge]: https://img.shields.io/docker/pulls/axiomhq/axiom-honeycomb-proxy.svg?style=flat-square&ghcache=unused

cmd/axiom-honeycomb-proxy/main.go

@@ -1,47 +1,92 @@
 package main
 
 import (
+	"context"
 	"flag"
 	"log"
-	"net/http"
 	"os"
+	"os/signal"
+	"syscall"
+	"time"
 
 	"github.com/axiomhq/axiom-go/axiom"
+	"github.com/axiomhq/pkg/http"
 	"github.com/axiomhq/pkg/version"
 
 	"github.com/axiomhq/axiom-honeycomb-proxy/proxy"
 )
 
-var (
-	defaultHoneyCombURL = "https://api.honeycomb.io"
-	deploymentURL       = os.Getenv("AXIOM_URL")
-	accessToken         = os.Getenv("AXIOM_TOKEN")
-	addr                = flag.String("addr", ":8080", "Listen address <ip>:<port>")
+const (
+	exitOK int = iota
+	exitConfig
+	exitInternal
 )
 
+const defaultHoneyCombURL = "https://api.honeycomb.io"
+
+var addr = flag.String("addr", ":8080", "Listen address <ip>:<port>")
+
 func main() {
+	os.Exit(Main())
+}
+
+func Main() int {
+	// Export `AXIOM_TOKEN` and `AXIOM_ORG_ID` for Axiom Cloud
+	// Export `AXIOM_URL` and `AXIOM_TOKEN` for Axiom Selfhost
+
 	log.Print("starting axiom-honeycomb-proxy version ", version.Release())
 
 	flag.Parse()
 
-	if deploymentURL == "" {
-		deploymentURL = axiom.CloudURL
-	}
-	if accessToken == "" {
-		log.Fatal("missing AXIOM_TOKEN")
-	}
+	ctx, cancel := signal.NotifyContext(context.Background(),
+		os.Interrupt,
+		os.Kill,
+		syscall.SIGHUP,
+		syscall.SIGINT,
+		syscall.SIGQUIT,
+	)
+	defer cancel()
 
-	client, err := axiom.NewClient(deploymentURL, accessToken)
+	client, err := axiom.NewClient()
 	if err != nil {
-		log.Fatal(err)
+		log.Print(err)
+		return exitConfig
+	} else if err = client.ValidateCredentials(ctx); err != nil {
+		log.Print(err)
+		return exitConfig
 	}
 
-	log.Print("listening on", *addr)
 	mp, err := proxy.NewMultiplexer(client, defaultHoneyCombURL)
 	if err != nil {
-		panic(err)
+		log.Print(err)
+		return exitInternal
+	}
+
+	srv, err := http.NewServer(*addr, mp)
+	if err != nil {
+		log.Print(err)
+		return exitInternal
+	}
+	defer func() {
+		shutdownCtx, shutdownCancel := context.WithTimeout(context.Background(), time.Second*5)
+		defer shutdownCancel()
+
+		if shutdownErr := srv.Shutdown(shutdownCtx); shutdownErr != nil {
+			log.Print(shutdownErr)
+		}
+	}()
+
+	srv.Run(ctx)
+
+	log.Print("listening on ", srv.ListenAddr().String())
+
+	select {
+	case <-ctx.Done():
+		log.Print("received interrupt, exiting gracefully")
+	case err := <-srv.ListenError():
+		log.Print("error starting http server, exiting gracefully: ", err)
+		return exitInternal
 	}
 
-	server := http.Server{Handler: mp, Addr: *addr}
-	log.Fatal(server.ListenAndServe())
+	return exitOK
 }