Add Zap as logger (#17)

csullivanupgrade · web-flow · commit 1fb3ba22bd69 · 2022-07-04T21:52:24.000-04:00
* Add Zap as logger

Use Zap lib for logging
Clean up useless loop in GetConstraints
Remove client logging

* Speed up linter

* Bump version
diff --git a/.dockerignore b/.dockerignore
@@ -1,5 +1,10 @@
 .github
+.gitignore
+.golangci.yaml
 .task
 charts
 test
 tmp
+CONTRIBUTING.md
+LICENSE
+README.md
diff --git a/Dockerfile b/Dockerfile
@@ -1,3 +1,5 @@
+# syntax = docker/dockerfile:1-experimental
+
 FROM golang:1.18.3 AS build
 
 ENV TASK_VER 3.13.0
@@ -11,11 +13,16 @@ RUN echo "Fetching dev dependencies" && \
 
 COPY . .
 
-RUN echo "Building" && \
+RUN \
+  --mount=type=cache,target=/root/.cache/go-build \
+  echo "Building" && \
   task build-bin && \
   echo
 
-RUN echo "Linting" && \
+RUN \
+  --mount=type=cache,target=/root/.cache/go-build \
+  --mount=type=cache,target=/root/.cache/golangci-lint \
+  echo "Linting" && \
   task lint && \
   echo
 
diff --git a/Taskfile.yaml b/Taskfile.yaml
@@ -57,34 +57,38 @@ tasks:
       CGO_ENABLED: "0"
       GOARCH: "{{ ARCH }}"
     sources:
-    - main.go
-    - pkg
+    - cmd/**/*
+    - internal/**/*
+    - pkg/**/*
     - go.mod
     - go.sum
     generates:
     - "{{ .BIN_NAME }}"
 
+  # TODO: Unit tests
   # test:
   #   desc: Run tests.
   #   cmds:
-  #   # TODO: Unit tests
-  #   # - go test ./... -v -short {{ .CLI_ARGS }}
+  #   - go test ./... -v -short {{ .CLI_ARGS }}
   #   sources:
-  #   - main.go
-  #   - pkg
+  #   - cmd/**/*
+  #   - internal/**/*
+  #   - pkg/**/*
   #   - go.mod
   #   - go.sum
 
   lint:
     desc: Run the linter.
     cmds:
-    - golangci-lint run ./... --timeout {{ .TIMEOUT }} {{ .CLI_ARGS }}
+    - GOGC=100 golangci-lint run ./... --timeout {{ .TIMEOUT }} {{ .CLI_ARGS }}
     vars:
       TIMEOUT: 1m
     sources:
-    - main.go
-    - pkg
-    - .golangci.yaml
+    - cmd/**/*
+    - internal/**/*
+    - pkg/**/*
+    - go.mod
+    - go.sum
 
   tidy:
     desc: Tidy up go deps.
@@ -99,14 +103,7 @@ tasks:
   build:
     desc: Build the docker image and generate a unique tag to force redeployment.
     cmds:
-    - docker build --tag {{ .IMAGE_NAME }}:{{ .IMAGE_TAG }} --progress plain .
-    sources:
-    - Dockerfile
-    - cmd/**/*
-    - internal/**/*
-    - pkg/**/*
-    - go.mod
-    - go.sum
+    - DOCKER_BUILDKIT=1 docker build --tag {{ .IMAGE_NAME }}:{{ .IMAGE_TAG }} .
 
   template:
     desc: Provide the opa-exporter template and invoke it with a variable kubectl command.
@@ -119,6 +116,8 @@ tasks:
         --values charts/opa-exporter/values.yaml \
         --set image.tag={{ .IMAGE_TAG }} \
         --set exporter.interval=10s \
+        --set exporter.logLevel=debug \
+        --set exporter.logMode=development \
         charts/opa-exporter \
       > {{ .TMP_DIR }}/opa-exporter.yaml
     - kubectl --context {{ .CONTEXT }} {{ .ACTION }} --wait --filename {{ .TMP_DIR }}/opa-exporter.yaml
diff --git a/charts/opa-exporter/Chart.yaml b/charts/opa-exporter/Chart.yaml
@@ -2,6 +2,6 @@ apiVersion: v2
 name: opa-exporter
 description: Helm chart for opa-exporter, a prometheus exporter for OPA Gatekeeper.
 type: application
-version: 0.1.2
-appVersion: 0.2.0
+version: 0.1.3
+appVersion: 0.3.0
 home: https://github.com/csullivanupgrade/opa-exporter
diff --git a/charts/opa-exporter/templates/configmap.yaml b/charts/opa-exporter/templates/configmap.yaml
@@ -8,6 +8,8 @@ data:
   configuration-file: |
     inCluster: {{ .Values.exporter.inCluster }}
     interval: {{ .Values.exporter.interval }}
+    logMode: {{ .Values.exporter.logMode }}
+    logLevel: {{ .Values.exporter.logLevel }}
     namespace: {{ .Values.exporter.namespace }}
     path: {{ .Values.exporter.path }}
     port: {{ .Values.exporter.port }}
diff --git a/charts/opa-exporter/values.yaml b/charts/opa-exporter/values.yaml
@@ -6,6 +6,12 @@ exporter:
   interval: "60s"
   # -- namespace the exporter is running in (does not affect operations - used for metrics FQDN)
   namespace: default
+  # -- log level to use, uses Zap levels
+  logLevel: info
+  # -- log mode to use:
+  # ---- `development` adds extra stacktrace/codepath fields
+  # ---- `nop` disables the logger
+  logMode: production
   # -- path for metrics server to listen
   path: "metrics"
   # -- port for the server to listen
diff --git a/cmd/main.go b/cmd/main.go
@@ -1,15 +1,23 @@
 package main
 
 import (
+	"context"
 	"flag"
 
 	"github.com/csullivanupgrade/opa-exporter/internal/config"
+	"github.com/csullivanupgrade/opa-exporter/internal/log"
 	"github.com/csullivanupgrade/opa-exporter/internal/server"
 )
 
 func main() {
 	configFile := flag.String("config", "", "The path for the config file")
 	flag.Parse()
 	cfg := config.New(*configFile)
-	server.Run(*cfg)
+
+	logger := log.NewLogger(cfg.LogLevel, cfg.LogMode)
+
+	ctx, cancel := context.WithCancel(log.SetContext(context.Background(), logger))
+
+	server.Run(ctx, *cfg)
+	defer cancel()
 }
diff --git a/config.yaml b/config.yaml
diff --git a/go.mod b/go.mod
@@ -50,6 +50,9 @@ require (
 	github.com/spf13/pflag v1.0.5 // indirect
 	github.com/spf13/viper v1.12.0 // indirect
 	github.com/subosito/gotenv v1.3.0 // indirect
+	go.uber.org/atomic v1.7.0 // indirect
+	go.uber.org/multierr v1.6.0 // indirect
+	go.uber.org/zap v1.21.0 // indirect
 	golang.org/x/net v0.0.0-20220624214902-1bab6f366d9e // indirect
 	golang.org/x/oauth2 v0.0.0-20220622183110-fd043fe589d2 // indirect
 	golang.org/x/sys v0.0.0-20220624220833-87e55d714810 // indirect
diff --git a/go.sum b/go.sum
@@ -549,6 +549,7 @@ go.uber.org/atomic v1.7.0 h1:ADUqmZGgLDDfbSL9ZmPxKTybcoEYHgpYfELNoN+7hsw=
 go.uber.org/atomic v1.7.0/go.mod h1:fEN4uk6kAWBTFdckzkM89CLk9XfWZrxpCo0nPH17wJc=
 go.uber.org/goleak v1.1.10/go.mod h1:8a7PlsEVH3e/a/GLqe5IIrQx6GzcnRmZEufDUTk4A7A=
 go.uber.org/goleak v1.1.11-0.20210813005559-691160354723/go.mod h1:cwTWslyiVhfpKIDGSZEM2HlOvcqm+tG4zioyIeLoqMQ=
+go.uber.org/goleak v1.1.11/go.mod h1:cwTWslyiVhfpKIDGSZEM2HlOvcqm+tG4zioyIeLoqMQ=
 go.uber.org/goleak v1.1.12/go.mod h1:cwTWslyiVhfpKIDGSZEM2HlOvcqm+tG4zioyIeLoqMQ=
 go.uber.org/multierr v1.1.0/go.mod h1:wR5kodmAFQ0UK8QlbwjlSNy0Z68gJhDJUG5sjR94q/0=
 go.uber.org/multierr v1.6.0 h1:y6IPFStTAIT5Ytl7/XYmHvzXQ7S3g/IeZW9hyZ5thw4=
@@ -558,6 +559,8 @@ go.uber.org/zap v1.17.0/go.mod h1:MXVU+bhUf/A7Xi2HNOnopQOrmycQ5Ih87HtOu4q5SSo=
 go.uber.org/zap v1.19.0/go.mod h1:xg/QME4nWcxGxrpdeYfq7UvYrLh66cuVKdrbD1XF/NI=
 go.uber.org/zap v1.19.1 h1:ue41HOKd1vGURxrmeKIgELGb3jPW9DMUDGtsinblHwI=
 go.uber.org/zap v1.19.1/go.mod h1:j3DNczoxDZroyBnOT1L/Q79cfUMGZxlv/9dzN7SM1rI=
+go.uber.org/zap v1.21.0 h1:WefMeulhovoZ2sYXz7st6K0sLj7bBhpiFaud4r4zST8=
+go.uber.org/zap v1.21.0/go.mod h1:wjWOCqI0f2ZZrJF/UufIOkiC8ii6tm1iqIsLo76RfJw=
 golang.org/x/crypto v0.0.0-20180904163835-0709b304e793/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
 golang.org/x/crypto v0.0.0-20181029021203-45a5f77698d3/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
diff --git a/internal/config/config.go b/internal/config/config.go
@@ -15,6 +15,8 @@ const (
 	path      = "METRICS_PATH"
 	inCluster = "INCLUSTER"
 	interval  = "INTERVAL"
+	logLevel  = "LOG_LEVEL"
+	logMode   = "LOG_MODE"
 	namespace = "NAMESPACE"
 )
 
@@ -23,6 +25,8 @@ type Config struct {
 	Path      string        `mapstructure:"path"`
 	InCluster bool          `mapstructure:"inCluster"`
 	Interval  time.Duration `mapstructure:"interval"`
+	LogLevel  string        `mapstructure:"logLevel"`
+	LogMode   string        `mapstructure:"logMode"`
 	Namespace string        `mapstructure:"namespace"`
 }
 
@@ -31,12 +35,13 @@ func New(configFile string) *Config {
 	viper.SetConfigFile(configFile)
 	viper.SetEnvPrefix("OPA_EXPORTER")
 	viper.SetEnvKeyReplacer(strings.NewReplacer(".", "_", "-", "_"))
-	// viper.AutomaticEnv()
 
 	viper.SetDefault(port, "9141")
 	viper.SetDefault(path, "metrics")
 	viper.SetDefault(inCluster, true)
 	viper.SetDefault(interval, "60s")
+	viper.SetDefault(logLevel, "info")
+	viper.SetDefault(logMode, "production")
 	viper.SetDefault(namespace, "default")
 
 	c := &Config{
@@ -63,6 +68,8 @@ func New(configFile string) *Config {
 	fmt.Println("-- path:\t", c.Path)
 	fmt.Println("-- incluster:\t", c.InCluster)
 	fmt.Println("-- interval:\t", c.Interval)
+	fmt.Println("-- logLevel:\t", c.LogLevel)
+	fmt.Println("-- logMode:\t", c.LogMode)
 	fmt.Println("-- namepsace:\t", c.Namespace)
 
 	return c
diff --git a/internal/log/log.go b/internal/log/log.go
@@ -0,0 +1,108 @@
+// Package log provides methods for creating the logger
+package log
+
+import (
+	"context"
+	"os"
+
+	"go.uber.org/zap"
+	"go.uber.org/zap/zapcore"
+)
+
+// ContextKey is the context key type.
+type ContextKey string
+
+const (
+	// ContextLogger is the context logger key.
+	ContextLogger = ContextKey("logger")
+)
+
+func setLevel(level string) (zapcore.Level, bool) {
+	switch level {
+	case "debug":
+		return zap.DebugLevel, false
+	case "info":
+		return zap.InfoLevel, false
+	case "warn":
+		return zap.WarnLevel, false
+	case "error":
+		return zap.ErrorLevel, false
+	case "dpanic":
+		return zap.DPanicLevel, false
+	case "panic":
+		return zap.PanicLevel, false
+	case "fatal":
+		return zap.FatalLevel, false
+	}
+	return zap.DebugLevel, true
+}
+
+// NewLogger creates a zap logger based on the mode you specify, defaulting to production if no mode was matched.
+func NewLogger(level string, mode string) *zap.Logger {
+	encoderConfig := zapcore.EncoderConfig{
+		MessageKey:     "msg",
+		LevelKey:       "level",
+		TimeKey:        "time",
+		NameKey:        "logger",
+		CallerKey:      "file",
+		StacktraceKey:  "stacktrace",
+		LineEnding:     zapcore.DefaultLineEnding,
+		EncodeLevel:    zapcore.LowercaseLevelEncoder,
+		EncodeTime:     zapcore.ISO8601TimeEncoder,
+		EncodeDuration: zapcore.SecondsDurationEncoder,
+		EncodeCaller:   zapcore.ShortCallerEncoder,
+		EncodeName:     zapcore.FullNameEncoder,
+	}
+
+	zapLevel, warnBadLevelConfig := setLevel(level)
+	atomicLevel := zap.NewAtomicLevelAt(zapLevel)
+
+	core := zapcore.NewCore(
+		zapcore.NewJSONEncoder(encoderConfig),
+		zapcore.NewMultiWriteSyncer(zapcore.AddSync(os.Stdout)),
+		atomicLevel,
+	)
+
+	var logger *zap.Logger
+	switch mode {
+	case "production":
+		logger = zap.New(core)
+	case "nop":
+		logger = zap.NewNop()
+	case "development":
+		caller := zap.AddCaller()
+		development := zap.Development()
+		core := zapcore.NewCore(
+			zapcore.NewJSONEncoder(encoderConfig),
+			zapcore.NewMultiWriteSyncer(zapcore.AddSync(os.Stdout)),
+			atomicLevel,
+		)
+		logger = zap.New(core, caller, development)
+	default:
+		logger = zap.New(core)
+		logger.Warn("log mode not specified - defaulting to production")
+	}
+
+	if warnBadLevelConfig {
+		logger.Warn("log level not specified - defaulting to info")
+	}
+
+	logger.Info("logger successfully initialized")
+	return logger
+}
+
+// SetContext sets the given logger in a new child context.
+func SetContext(ctx context.Context, contextLogger *zap.Logger) context.Context {
+	return context.WithValue(ctx, ContextLogger, contextLogger)
+}
+
+// FromContext gets the logger from the given context.
+func FromContext(ctx context.Context) *zap.Logger {
+	if logger, ok := ctx.Value(ContextLogger).(*zap.Logger); ok {
+		return logger
+	}
+
+	logger := NewLogger("info", "production")
+	logger.Warn("logger could not be retrieved from context")
+	return logger
+}
diff --git a/internal/server/server.go b/internal/server/server.go
diff --git a/pkg/opa/constraints.go b/pkg/opa/constraints.go
diff --git a/pkg/opa/prometheus.go b/pkg/opa/prometheus.go
