Merge pull request #1 from gcp-kit/feat/context-logger-key-to-public

Feat context logger key to public / minor fix and update

Author: 54m

.github/.golangci.yml

@@ -0,0 +1,56 @@
+linters-settings:
+  dupl:
+    threshold: 100
+  goconst:
+    min-len: 2
+    min-occurrences: 2
+  goimports:
+    local-prefixes: github.com/golangci/golangci-lint
+  revive:
+    ignore-generated-header: false
+    confidence: 0.3
+  govet:
+    check-shadowing: true
+  lll:
+    line-length: 120
+  misspell:
+    locale: US
+    ignore-words: []
+
+linters:
+  disable-all: true
+  enable:
+    - bodyclose
+    - deadcode
+    - dogsled
+    - dupl
+    - errcheck
+    - goconst
+    - gofmt
+    - goimports
+    - revive
+    - govet
+    - ineffassign
+    - misspell
+    - exportloopref
+    - staticcheck
+    - structcheck
+    - unconvert
+    - unused
+    - varcheck
+    - whitespace
+
+issues:
+  exclude:
+  - declaration of "(err|ctx)" shadows declaration at
+  - echo
+  exclude-rules:
+    - path: _test\.go
+      linters:
+        - dupl
+        - gomnd
+
+service:
+  golangci-lint-version: 1.41.x
+  prepare:
+    - echo "here I can run custom commands, but no preparation needed for this repo"

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,6 @@
+<!-- This is a template. Please rewrite to the necessary contents when creating the PR. -->
+<!-- If there is an issue, enter it. -->
+- Closes #XXX
+
+<!-- ## Overview -->
+<!-- Please write the purpose of this PR and the outline of implementation. -->

.github/workflows/build.yml

@@ -0,0 +1,31 @@
+name: build
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  go:
+    name: runner / go
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v2
+
+      - uses: actions/setup-go@v2
+        with:
+          go-version: '^1.13'
+
+      - uses: actions/cache@v2
+        with:
+          path: ~/go/pkg/mod
+          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-go-
+
+      - name: build
+        run: go get .

.github/workflows/linter.yml

@@ -0,0 +1,29 @@
+name: linter
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  golangci-lint:
+    name: runner / golangci-lint
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v2
+
+      - uses: actions/setup-go@v2
+        with:
+          go-version: '^1.13'
+
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v2
+        with:
+          args: "--config=.github/.golangci.yml --timeout=10m"
+          skip-go-installation: true
+          skip-pkg-cache: true
+          skip-build-cache: true

.github/workflows/test.yml

@@ -0,0 +1,32 @@
+name: test
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  go:
+    name: runner / go
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Set up Go ^1.13
+        uses: actions/setup-go@v2
+        with:
+          go-version: '^1.13'
+        id: go
+
+      - uses: actions/checkout@v2
+
+      - uses: actions/cache@v2
+        with:
+          path: ~/go/pkg/mod
+          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-go-
+
+      - name: Run tests
+        run: go test -v ./...

context.go

@@ -2,6 +2,4 @@ package stalog
 
 type contextKey struct{}
 
-var (
-	contextLoggerKey = &contextKey{}
-)
+var ContextLoggerKey = &contextKey{}

go.mod

@@ -1,10 +1,10 @@
 module github.com/gcp-kit/stalog
 
-go 1.12
+go 1.13
 
 require (
 	github.com/go-chi/chi v4.0.3+incompatible
-	github.com/google/go-cmp v0.3.0
-	github.com/labstack/echo/v4 v4.1.16
-	go.opencensus.io v0.22.3
+	github.com/google/go-cmp v0.5.3
+	github.com/labstack/echo/v4 v4.5.0
+	go.opencensus.io v0.23.0
 )

go.sum

@@ -27,16 +27,17 @@ func RequestLogging(config *Config) func(http.Handler) http.Handler {
 				reserve.LastHandling(wrw)
 			}()
 
-			next.ServeHTTP(wrw, r)
+			next.ServeHTTP(wrw, reserve.request)
 		}
+
 		return http.HandlerFunc(fn)
 	}
 }
 
 // RequestLoggingWithEcho creates the middleware which logs a request log and creates a request-context logger
 func RequestLoggingWithEcho(config *Config) echo.MiddlewareFunc {
 	return func(next echo.HandlerFunc) echo.HandlerFunc {
-		fn := func(c echo.Context) error {
+		return func(c echo.Context) error {
 			reserve := NewReserve(config, c.Request())
 
 			wrw := &wrappedResponseWriter{
@@ -53,7 +54,6 @@ func RequestLoggingWithEcho(config *Config) echo.MiddlewareFunc {
 
 			return next(c)
 		}
-		return fn
 	}
 }
 
@@ -99,7 +99,7 @@ func NewReserve(config *Config, r *http.Request) *Reserve {
 		loggedSeverity: make([]Severity, 0, 10),
 		Skip:           config.Skip,
 	}
-	ctx := context.WithValue(r.Context(), contextLoggerKey, contextLogger)
+	ctx := context.WithValue(r.Context(), ContextLoggerKey, contextLogger)
 
 	return &Reserve{
 		before:        before,
@@ -159,15 +159,15 @@ func (w *wrappedResponseWriter) Write(b []byte) (int, error) {
 	return n, err
 }
 
-type HttpRequest struct {
+type HTTPRequest struct {
 	RequestMethod                  string `json:"requestMethod"`
 	RequestUrl                     string `json:"requestUrl"`
 	RequestSize                    string `json:"requestSize"`
 	Status                         int    `json:"status"`
 	ResponseSize                   string `json:"responseSize"`
 	UserAgent                      string `json:"userAgent"`
-	RemoteIp                       string `json:"remoteIp"`
-	ServerIp                       string `json:"serverIp"`
+	RemoteIP                       string `json:"remoteIp"`
+	ServerIP                       string `json:"serverIp"`
 	Referer                        string `json:"referer"`
 	Latency                        string `json:"latency"`
 	CacheLookup                    bool   `json:"cacheLookup"`
@@ -176,28 +176,28 @@ type HttpRequest struct {
 	Protocol                       string `json:"protocol"`
 }
 
-type HttpRequestLog struct {
+type HTTPRequestLog struct {
 	Time           string         `json:"time"`
 	Trace          string         `json:"logging.googleapis.com/trace"`
 	Severity       string         `json:"severity"`
-	HttpRequest    HttpRequest    `json:"httpRequest"`
+	HTTPRequest    HTTPRequest    `json:"httpRequest"`
 	AdditionalData AdditionalData `json:"data,omitempty"`
 }
 
 func writeRequestLog(r *http.Request, config *Config, status int, responseSize int, elapsed time.Duration, trace string, severity Severity) error {
-	requestLog := &HttpRequestLog{
+	requestLog := &HTTPRequestLog{
 		Time:     time.Now().Format(time.RFC3339Nano),
 		Trace:    trace,
 		Severity: severity.String(),
-		HttpRequest: HttpRequest{
+		HTTPRequest: HTTPRequest{
 			RequestMethod:                  r.Method,
 			RequestUrl:                     r.URL.RequestURI(),
 			RequestSize:                    fmt.Sprintf("%d", r.ContentLength),
 			Status:                         status,
 			ResponseSize:                   fmt.Sprintf("%d", responseSize),
 			UserAgent:                      r.UserAgent(),
-			RemoteIp:                       getRemoteIp(r),
-			ServerIp:                       getServerIp(),
+			RemoteIP:                       getRemoteIP(r),
+			ServerIP:                       getServerIP(),
 			Referer:                        r.Referer(),
 			Latency:                        fmt.Sprintf("%fs", elapsed.Seconds()),
 			CacheLookup:                    false,
@@ -207,31 +207,36 @@ func writeRequestLog(r *http.Request, config *Config, status int, responseSize i
 		},
 		AdditionalData: config.AdditionalData,
 	}
-	requestLogJson, err := json.Marshal(requestLog)
+
+	jsonByte, err := json.Marshal(requestLog)
 	if err != nil {
 		return err
 	}
-	requestLogJson = append(requestLogJson, '\n')
 
-	_, err = config.RequestLogOut.Write(requestLogJson)
+	// append \n
+	jsonByte = append(jsonByte, 0xa)
+
+	_, err = config.RequestLogOut.Write(jsonByte)
 	return err
 }
 
-func getRemoteIp(r *http.Request) string {
+func getRemoteIP(r *http.Request) string {
 	parts := strings.Split(r.RemoteAddr, ":")
 	return parts[0]
 }
 
-func getServerIp() string {
+func getServerIP() string {
 	ifaces, err := net.Interfaces()
 	if err != nil {
 		return ""
 	}
+
 	for _, i := range ifaces {
 		addrs, err := i.Addrs()
 		if err != nil {
 			return ""
 		}
+
 		for _, addr := range addrs {
 			if ipnet, ok := addr.(*net.IPNet); ok && !ipnet.IP.IsLoopback() {
 				if ipnet.IP.To4() != nil {
@@ -240,5 +245,6 @@ func getServerIp() string {
 			}
 		}
 	}
+
 	return ""
 }

middleware.go

@@ -80,8 +80,9 @@ func (s Severity) String() string {
 		return "ALERT"
 	case SeverityEmergency:
 		return "EMERGENCY"
+	default:
+		return "UNKNOWN"
 	}
-	return "UNKNOWN"
 }
 
 type SourceLocation struct {
@@ -112,7 +113,7 @@ type ContextLogger struct {
 // RequestContextLogger gets request-context logger for the request.
 // You must use `RequestLogging` middleware in advance for this function to work.
 func RequestContextLogger(r *http.Request) *ContextLogger {
-	v, _ := r.Context().Value(contextLoggerKey).(*ContextLogger)
+	v, _ := r.Context().Value(ContextLoggerKey).(*ContextLogger)
 	return v
 }
 
@@ -293,14 +294,16 @@ func (l *ContextLogger) write(severity Severity, msg string) error {
 		AdditionalData: l.AdditionalData,
 	}
 
-	logJson, err := json.Marshal(log)
+	jsonByte, err := json.Marshal(log)
 	if err != nil {
 		_, _ = fmt.Fprintln(os.Stderr, err.Error())
 		return err
 	}
-	logJson = append(logJson, '\n')
 
-	_, err = l.out.Write(logJson)
+	// append \n
+	jsonByte = append(jsonByte, 0xa)
+
+	_, err = l.out.Write(jsonByte)
 	return err
 }
 
@@ -311,5 +314,6 @@ func (l *ContextLogger) maxSeverity() Severity {
 			max = s
 		}
 	}
+
 	return max
 }