Build and release automation (#3)

Heiko Zuerker · web-flow · commit e6782af2c86e · 2020-03-31T16:10:21.000-05:00
* Allow configuration through environment variables
* Use nonroot image, require parameters, add version parameter
* Adding config for build automation
* Add config to release to quay.io
* Update documentation and add image build
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,6 @@
+coverage.txt
+dist/
+prometheus_bigquery_remote_storage_adapter
+.idea
+*.swp
+.vscode
diff --git a/.goreleaser.yml b/.goreleaser.yml
@@ -0,0 +1,37 @@
+# This is an example goreleaser.yaml file with some sane defaults.
+# Make sure to check the documentation at http://goreleaser.com
+project_name: prometheus_bigquery_remote_storage_adapter
+env:
+  - CGO_ENABLED=0
+before:
+  hooks:
+    - go mod tidy
+builds:
+- ldflags:
+  - "-X {{.Env.VERSION_PKG}}.Branch={{.Env.BRANCH}}"
+  - "-X {{.Env.VERSION_PKG}}.BuildDate={{.Env.DATE}}"
+  - "-X {{.Env.VERSION_PKG}}.GitSHA1={{.Env.COMMIT}}"
+archives:
+- replacements:
+    darwin: Darwin
+    linux: Linux
+    windows: Windows
+    386: i386
+    amd64: x86_64
+checksum:
+  name_template: 'checksums.txt'
+snapshot:
+  name_template: "{{ .Tag }}-next"
+changelog:
+  skip: true
+dockers:
+  - binaries:
+    - prometheus_bigquery_remote_storage_adapter
+    image_templates:
+      - "quay.io/kohlstechnology/{{.ProjectName}}:{{ .Tag }}"
+      - "quay.io/kohlstechnology/{{.ProjectName}}:latest"
+    build_flag_templates:
+      - "--label=org.opencontainers.image.created={{.Date}}"
+      - "--label=org.opencontainers.image.name={{.ProjectName}}"
+      - "--label=org.opencontainers.image.revision={{.FullCommit}}"
+      - "--label=org.opencontainers.image.version={{.Version}}"
diff --git a/.travis.yml b/.travis.yml
@@ -1,9 +1,36 @@
----
-language: minimal
-
+branches:
+  only:
+    - master
+    - "/^v\\d+\\.\\d+\\.\\d+$/"
+sudo: required
+language: go
+matrix:
+  include:
+    - go: 1.14.x
+env:
+  global:
+    - secure: j/acmH3CpQSsD13ofSnuqAEBzFE5SB6v1Sk0+ICXgTeJrzz+N3ohJBiRa10MuEn5+QcFYPF8oGefTbgWVb7iHEMbBI60HQqoLQ7817CDJWxn5nywlE/79IVUuBn+S+TgCXOyj+AG6+4HiRIwCzKDBqIy+TOPs7HH7Tryvhjiu5ievM8wM0+SfElO4BMIZbreCiFpv6at1oUPLSU2G4x6VJ242lXCVdeHCcYahDymA55CQtT1whoutUzDTWbB5YXu7/8IaT+pXl5YicuK1lvxZoJogl+uh58COwWKtWeqxEkvzzRoUjhuIzdNRNldCstVTXDCInZhwEc05e1qddVLluVko2nlQM99e80Llhurg3kK0tgGxA5OpWY/WzEODOY8vyDdCf7Oe/+llNVKyUxnwoDcmHB26Geugoi284Fzqn7qcZMngYvwmxsYcAbkIFfnnNA4FPXwA9556En+bZNX881y6NWyM1rZPnvHHKsPfnszzbZXfXhHzRygLqcn8YczaBzO6AHmbrBva5IrwGBIr372IP2hRvK+UXSUGqO5rCfXHznb5C2A6ew+7eyl9CGCsBw1NoWB76ebsNii1j4O3eLXKBckTRYfAq7+b0fS1HSNZjzVB14Xg2X4JczD5t8FK3d2Z24k6PR/N12QlfZtyEAmxsJG6xWlm1hA87mVQDQ=
+    - secure: F7xb26+IrXNAnh4gV8im/ZfzYdpwy/1X4bDHZE+1mwlHZi3d0POWZVh2gEYzGXTV5TW7I1VaBiLoHktcwe/+a643Op1CwkS2widg06PpspM8BCH1PQXhNwuM5oyX08dI46ak9XWGbFfDUDxYqG2dnbrX2A348/BcF1WPTVb1KLyPXY9PUsS/0dodyZy+f6DeFaaYet60iMCBtO+JbaZvLV8wK6RRMNEKS+VfX36JSgHeOJFTqF+blHI44zKhj0cFDpCh3dZ7gEYu7Crk6G3MDp/dHWjl2ZLR2eSFgIGTnEcxr9Y1g8/diHqfnZFg4MNcJyJS1f/i01B2aQHd4CabX5aBT+4mTB4HMCgawOMJVsHW+ueg3qfzwH9TNGGWc6s86CpSp3Cyu14rD4fvkW6Wk4iWLyFnZVTFSHu9iAMtd1jWTuI4mCIVYejLk2IsEeE9HA3sRObbpJ8CANOhrztbqN940hK1wxOUguQnp2rFXLrfShTvRG7PayObfEi1ldlPhykM/aG0kptqi7RpDs308wpqwIPH9P/FNRUx90T6D0w0bJL0PqOXl178fBYoZmadQEGiMcIW2vRX7Jb9qXGH40hpybE0yK7gJNZswz+nF7xJc1A/A+RZKYnrYhvB9XzJW6J6GOrS7dMVuyLtPgLqm0HpT+S05LGwnIDlK+VWqM4=
+    - secure: IIvo7LPL1HUcDPy8KQBp2p0+5EiM+cMMpFEUI2tiTNVOQ4YpXTFqIaaM3Rq7UrjAQJkAKRDGXJbTJL2fiuR6U2SrSPCbLe5fMyFnNyMbic4jZdq2NF7r1Y+KKUvTnwt//e2Qas7es/5BIoCjZXJT8g2nyzFspQ2+3/o++Chcj/lG9191GodTgCIymMJcEbqty+sThdW+qRJO5XSEfZnm9TFiskD7VveFGh0bPNVYYrKtbGoSnT7jTSx3Vbvxvs0Jd4J+OajgTP8T/v2fd5L1Ftg5j0WAbA/P/NtEbGJNmUf2Fbzlf2xfvz2rOTjqLQQOUclxsXIxdyNusXgpCtz4BLjafj7fJAcXXDFYjKlZRLFVjPsOoOxSXvWCVnYoKISEBX7W/6NoDFTMPORY+pIlp/OXA3jjkREoJnMZiCdzjYuG0kX2/mQYHQ1qC9qSNRiOmE0oYvS+lr7e7b4addDTVjq6MgkAJkAoX66S4gFHMd6Bs66U/u7ajtxum2/pvWN198IBD832MJPkeamIIP/QfV1GX5KWQWaqxHAn6ylRw+Z1uxpY/8stF/QaQvHm/95vSixmpqRh5jqXxbkp+nHDldTKdr23Ruya2rwkPa2I0ZH3B47iIQb/UrD6Y/xoI2mAZWbq0J6KaVu4HxMxpH2+j9h35EXSeVAwUxq3sb/WJi8=
+  matrix:
+    - GO_RELEASER_VERSION=v0.129.0
+services:
+  - docker
+before_install:
+  - GO111MODULE=off go get golang.org/x/lint/golint
+  - curl -L -o /tmp/goreleaser.tar.gz https://github.com/goreleaser/goreleaser/releases/download/${GO_RELEASER_VERSION}/goreleaser_Linux_x86_64.tar.gz
+  - sudo tar -xzf /tmp/goreleaser.tar.gz -C /usr/local/bin/ && sudo chmod +x /usr/local/bin/goreleaser
 install:
-  - # skip
-
+  -
 script:
-  - echo hello, world!
-
+  - make test-dirty
+  - make test-release
+after_success:
+  - test -n "$TRAVIS_TAG" && docker login -u="$QUAYIO_USER" -p="$QUAYIO_SECRET" quay.io
+deploy:
+  - provider: script
+    skip_cleanup: true
+    script: make clean release
+    on:
+      tags: true
+      condition: "$TRAVIS_OS_NAME = linux"
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,2 @@
+## v0.1.0 (March 31, 2020)
+* Initial release
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,7 @@
+FROM gcr.io/distroless/static:nonroot
+
+COPY ./prometheus_bigquery_remote_storage_adapter /bigquery_remote_storage_adapter
+
+EXPOSE 9201
+
+ENTRYPOINT ["/bigquery_remote_storage_adapter"]
diff --git a/Makefile b/Makefile
@@ -8,7 +8,7 @@ LDFLAGS := "-X ${VERSION_PKG}.Branch=${BRANCH} -X ${VERSION_PKG}.BuildDate=${DAT
 TAG?=""
 
 .PHONY: all
-all: build
+all: build image
 
 .PHONY: clean
 clean:
@@ -18,6 +18,10 @@ clean:
 build:
 	CGO_ENABLED=0 go build -o $(BINARY) -ldflags $(LDFLAGS)
 
+.PHONY: image
+image:
+	docker build . -t quay.io/kohlstechnology/prometheus_bigquery_remote_storage_adapter:latest
+
 .PHONY: test
 test: fmt vet test-unit
 
diff --git a/README.md b/README.md
@@ -1,5 +1,9 @@
 # BigQuery Remote Storage Adapter for Prometheus
 
+[![Build Status](https://travis-ci.com/KohlsTechnology/prometheus_bigquery_remote_storage_adapter.svg?branch=master)](https://travis-ci.com/KohlsTechnology/prometheus_bigquery_remote_storage_adapter)
+[![Go Report Card](https://goreportcard.com/badge/github.com/KohlsTechnology/prometheus_bigquery_remote_storage_adapter)](https://goreportcard.com/report/github.com/KohlsTechnology/prometheus_bigquery_remote_storage_adapter)
+[![Docker Repository on Quay](https://quay.io/repository/kohlstechnology/prometheus_bigquery_remote_storage_adapter/status "Docker Repository on Quay")](https://quay.io/repository/kohlstechnology/prometheus_bigquery_remote_storage_adapter)
+
 This is a write adapter that receives samples via Prometheus's remote write protocol and stores them in Google BigQuery. This adapter is based off code found in the official prometheus repo:
 
 https://github.com/prometheus/prometheus/tree/master/documentation/examples/remote_storage/remote_storage_adapter
@@ -8,7 +12,6 @@ Remote read is not currently supported by this adapter.
 
 Billing MUST be enabled on the GCP project with the destination BigQuery tables. This adapter uses the "streaming inserts" API. More information is available here: https://cloud.google.com/bigquery/streaming-data-into-bigquery#before_you_begin
 
-
 The table schema in BigQuery should be the following format:
 
 | Field name | Type | Mode |
@@ -18,7 +21,6 @@ The table schema in BigQuery should be the following format:
 | value | FLOAT | NULLABLE |
 | timestamp | TIMESTAMP | NULLABLE |
 
-
 It is recommended that the BigQuery table is partitioned on the timestamp column for performance.
 
 The tags field is a json string and can be easily extracted. Here is an example query:
@@ -30,13 +32,7 @@ SELECT metricname, tags, JSON_EXTRACT(tags, '$.some_label')
   WHERE JSON_EXTRACT(tags, '$.some_label') = "\\"target_label_value\\""
 ```
 
-## Building
-
-```
-go build
-```
-
-## Running
+## Running directly
 
 ```
 ./bigquery_remote_storage_adapter \
@@ -51,6 +47,19 @@ To show all flags:
 ./bigquery_remote_storage_adapter -h
 ```
 
+## Configuration
+
+You can configure this storage adapter either through command line options or environment variables. The later is required if you're using our docker image.
+
+| Command Line Flag | Environment Variable | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| `--googleAPIjsonkeypath` | `PROMBQ_GCP_JSON` | Yes | | Path to json keyfile for GCP service account. JSON keyfile also contains project_id. |
+| `--googleAPIdatasetID` | `PROMBQ_DATASET` | Yes | | Dataset name as shown in GCP |
+| `--googleAPItableID` | `PROMBQ_TABLE` | Yes | | Table name as showon in GCP |
+| `--send-timeout` | `PROMBQ_TIMEOUT` | No | `30s` | The timeout to use when sending samples to the remote storage |
+| `--web.listen-address` | `PROMBQ_LISTEN` | No | `:9201` | Address to listen on for web endpoints |
+| `--web.telemetry-path` | `PROMBQ_TELEMETRY` | No | `/metrics` | Address to listen on for web endpoints |
+
 ## Configuring Prometheus
 
 To configure Prometheus to send samples to this binary, add the following to your `prometheus.yml`:
@@ -61,3 +70,43 @@ remote_write:
   - url: "http://localhost:9201/write"
 
 ```
+
+## Building
+
+### Binary
+
+If you just need a local version to test, then the simplest way is to execute:
+
+```
+make build
+```
+
+### Image
+
+In order to build the docker image, simply execute
+
+```
+make image
+```
+
+## Releasing
+
+This project is using [goreleaser](https://goreleaser.com). GitHub release creation is automated using Travis
+CI. New releases are automatically created when new tags are pushed to the repo.
+```
+$ TAG=v0.0.2 make tag
+```
+
+How to manually create a release without relying on Travis CI.
+```
+$ TAG=v0.0.2 make tag
+$ GITHUB_TOKEN=xxx make clean release
+```
+
+### Testing
+
+You can execute goreleaser locally in order to test any changes.
+
+```
+make clean test-release
+```
diff --git a/bigquerydb/client.go b/bigquerydb/client.go
@@ -56,7 +56,6 @@ func NewClient(logger log.Logger, googleAPIjsonkeypath, googleAPIdatasetID, goog
 	var result map[string]interface{}
 	json.Unmarshal([]byte(byteValue), &result)
 
-	//fmt.Println(result["type"])
 	jsonFile.Close()
 
 	projectID := fmt.Sprintf("%v", result["project_id"])
diff --git a/go.mod b/go.mod
@@ -1,4 +1,4 @@
-module github.com/ReliabilityEngineering/prometheus_bigquery_remote_storage_adapter
+module github.com/KohlsTechnology/prometheus_bigquery_remote_storage_adapter
 
 go 1.14
 
diff --git a/go.sum b/go.sum
diff --git a/main.go b/main.go
diff --git a/pkg/version/version.go b/pkg/version/version.go

-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +coverage.txt
 +dist/
 +prometheus_bigquery_remote_storage_adapter
 +.idea
 +*.swp
 +.vscode
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+## v0.1.0 (March 31, 2020)`
	`2`	`+* Initial release`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-module github.com/ReliabilityEngineering/prometheus_bigquery_remote_storage_adapter`
	`1`	`+module github.com/KohlsTechnology/prometheus_bigquery_remote_storage_adapter`
`2`	`2`
`3`	`3`	`go 1.14`
`4`	`4`