Add profiling mode (#15)

Add pprof serves
Add meta data to api.swagger.json
Improve the usage of tracing
Improve CI

Author: arttet

.github/workflows/coverage.yml

@@ -23,9 +23,9 @@ jobs:
         uses: actions/checkout@v2
       - name: Run coverage
         run: |
-          go env -w CGO_ENABLED=1
-          go test -v -coverprofile="coverage.out" -covermode=atomic ./...
-          go tool cover -html="coverage.out" -o coverage.html
+          go env -w CGO_ENABLED=0
+          go test -v -coverprofile coverage.out ./...
+          go tool cover -html coverage.out -o coverage.html
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v1
         with:

.github/workflows/tests.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       matrix:
         go-version: [1.17.x]
-        os: [ubuntu-latest, macos-latest]
+        os: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:
       - name: Install Go

.gitignore

@@ -15,3 +15,4 @@
 # vendor/
 
 .vscode
+logs.json

Dockerfile

@@ -20,4 +20,4 @@ COPY --from=builder /home/${GITHUB_PATH}/config.yml .
 COPY --from=builder /home/${GITHUB_PATH}/migrations/ ./migrations/
 
 RUN chown root:root reddit-feed-api
-CMD ["./reddit-feed-api", "--migration", "up"]
+CMD ["./reddit-feed-api"]

Makefile

@@ -3,12 +3,12 @@ ifneq ("1.17","$(shell printf "$(GO_VERSION_SHORT)\n1.17" | sort -V | head -1)")
 $(error NEED GO VERSION >= 1.17. Found: $(GO_VERSION_SHORT))
 endif
 
-export GO111MODULE=on
-
 ###############################################################################
 
 SERVICE_NAME=reddit-feed-api
 SERVICE_PATH=github.com/arttet/reddit-feed-api
+SERVICE_MAIN=cmd/$(SERVICE_NAME)/main.go
+SERVICE_EXE=./bin/$(SERVICE_NAME)$(shell go env GOEXE)
 
 ###############################################################################
 
@@ -23,29 +23,32 @@ ifeq ("NT", "$(findstring NT,$(OS_NAME))")
 OS_NAME=Windows
 endif
 
-ifeq ("Windows", "$(OS_NAME)")
-OS_ARCH:=$(addsuffix .exe,$(OS_ARCH))
-endif
-
 ###############################################################################
 
 .PHONY: build
 build: generate .build
-ifeq ("NT", "$(findstring NT,$(shell uname -s))")
-	mv ./bin/$(SERVICE_NAME) ./bin/$(SERVICE_NAME).exe
-endif
 
 .PHONY: run
 run:
-	go run cmd/reddit-feed-api/main.go
+	go run \
+		-gcflags='-m' \
+		-gcflags='$(SERVICE_PATH)/internal/api=-m' \
+		-gcflags='$(SERVICE_PATH)/internal/server=-m' \
+		$(SERVICE_MAIN) --cfg config-dev.yml
 
 .PHONY: test
 test:
 	go test -v -timeout 30s -coverprofile cover.out ./...
 	go tool cover -func cover.out | grep total | awk '{print ($$3)}'
 
+.PHONY: bench
+bench:
+	go test -cpuprofile cpu.prof -memprofile mem.prof -bench ./...
+
 .PHONY: lint
 lint:
+	@command -v golangci-lint 2>&1 > /dev/null || (echo "Install golangci-lint" && \
+		curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b "$(shell go env GOPATH)/bin" v1.42.1)
 	golangci-lint run ./...
 
 .PHONY: tidy
@@ -61,6 +64,10 @@ style:
 cover:
 	go tool cover -html cover.out
 
+# Enable pprof: internal/server/status.go:13
+.PHONY: pprof
+pprof: .pprof-cpu
+
 .PHONY: grpcui
 grpcui:
 	grpcui -plaintext 0.0.0.0:8082
@@ -71,6 +78,8 @@ grpcui:
 deps: .deps
 
 .deps:
+	go env -w GO111MODULE=on
+
 	@ # https://pkg.go.dev/google.golang.org/protobuf/cmd/protoc-gen-go
 	go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
 
@@ -93,7 +102,7 @@ generate: .generate
 .generate:
 	@command -v buf 2>&1 > /dev/null || (echo "Install buf" && \
 		mkdir -p "$(GOBIN)" && \
-		curl -k -sSL0 https://github.com/bufbuild/buf/releases/download/$(BUF_VERSION)/buf-$(OS_NAME)-$(OS_ARCH) -o "$(GOBIN)/buf" && \
+		curl -k -sSL0 https://github.com/bufbuild/buf/releases/download/$(BUF_VERSION)/buf-$(OS_NAME)-$(OS_ARCH)$(shell go env GOEXE) -o "$(GOBIN)/buf" && \
 		chmod +x "$(GOBIN)/buf")
 	@PATH="$(GOBIN):$(PATH)" buf generate
 
@@ -111,4 +120,14 @@ generate: .generate
 			-X '$(SERVICE_PATH)/internal/config.version=$(VERSION)' \
 			-X '$(SERVICE_PATH)/internal/config.commitHash=$(COMMIT_HASH)' \
 		" \
-		-o ./bin/reddit-feed-api ./cmd/reddit-feed-api/main.go
+		-o $(SERVICE_EXE) $(SERVICE_MAIN)
+
+###############################################################################
+
+.pprof-cpu:
+	go tool pprof http://localhost:8000/debug/pprof/profile?seconds=30
+
+.pprof-mem:
+	go tool pprof -alloc_space http://localhost:8000/debug/pprof/heap
+
+###############################################################################

README.md

@@ -1,7 +1,7 @@
 # Reddit Feed API
 
  [![Go](https://img.shields.io/badge/Go-1.17-blue.svg)](https://golang.org)
-[![Tests](https://github.com/arttet/reddit-feed-api/actions/workflows/tests.yml/badge.svg?branch=develop)](https://github.com/arttet/reddit-feed-api/actions/workflows/tests.yml)
+[![tests](https://github.com/arttet/reddit-feed-api/actions/workflows/tests.yml/badge.svg?branch=develop)](https://github.com/arttet/reddit-feed-api/actions/workflows/tests.yml)
 [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/arttet/reddit-feed-api/blob/main/LICENSE)
 
 ## Build project
@@ -69,6 +69,8 @@ Service condition and its information
     - [/live](http://localhost:8000/live)- Layed whether the server is running
     - [/ready](http://localhost:8000/ready) - Is it ready to accept requests?
     - [/version](http://localhost:8000/version) - Version and assembly information
+    - [/debug/swagger/{swagger_file}](http://localhost:8000/debug/swagger/api.swagger.json) - Show a Swagger file in debug mode
+    - [/debug/pprof](http://localhost:8000/debug/pprof) - Profiles when profiling enables
 
 ### Kafka
 

cmd/reddit-feed-api/main.go

@@ -8,6 +8,8 @@ import (
 	"github.com/arttet/reddit-feed-api/internal/server"
 	"github.com/arttet/reddit-feed-api/internal/tracer"
 
+	"github.com/pressly/goose/v3"
+
 	"go.uber.org/zap"
 
 	_ "github.com/jackc/pgx/v4"
@@ -16,22 +18,17 @@ import (
 )
 
 func main() {
-	migration := flag.String("migration", "", "Defines the migration start option")
+	migration := flag.Bool("migration", true, "Defines the migration start option")
 	configYML := flag.String("cfg", "config.yml", "Defines the configuration file option")
 	flag.Parse()
 
-	logger, err := zap.NewProduction()
-	if err != nil {
-		panic(err)
-	}
-
 	if err := config.ReadConfigYML(*configYML); err != nil {
-		logger.Fatal("reading configuration", zap.Error(err))
+		panic(err)
 	}
 
 	cfg := config.GetConfigInstance()
 
-	logger, err = cfg.Logger.Build()
+	logger, err := cfg.Logger.Build()
 	if err != nil {
 		panic(err)
 	}
@@ -40,23 +37,22 @@ func main() {
 
 	logger.Info("starting service",
 		zap.String("name", cfg.Project.Name),
+		zap.String("yml", *configYML),
 		zap.Bool("debug", cfg.Project.Debug),
 		zap.String("environment", cfg.Project.Environment),
 		zap.String("commit_hash", cfg.Project.CommitHash),
 		zap.String("version", cfg.Project.Version),
 	)
 
-	dsn := cfg.Database.String()
-	db, err := database.NewConnection(dsn, cfg.Database.Driver)
+	db, err := database.NewConnection(cfg.Database.String(), cfg.Database.Driver)
 	if err != nil {
 		logger.Fatal("database initialization", zap.Error(err))
 	}
 	defer db.Close()
 
-	if *migration != "" {
-		if err := database.Migrate(db.DB, *migration); err != nil {
+	if *migration {
+		if err = goose.Up(db.DB, cfg.Database.MigrationsDir); err != nil {
 			logger.Error("migrations initialization", zap.Error(err))
-			return
 		}
 	}
 

config-dev.yml

@@ -40,6 +40,7 @@ database:
   password: docker
   name: reddit_feed_api
   sslmode: disable
+  migrationsDir: migrations
   driver: pgx
 
 jaeger:
@@ -57,7 +58,7 @@ status:
   port: 8000
   livenessPath: /live
   readinessPath: /ready
-  swaggerPath: /swagger/
+  swaggerPath: /debug/swagger/
   versionPath: /version
 
 kafka:

config.yml

@@ -36,6 +36,7 @@ database:
   password: docker
   name: reddit_feed_api
   sslmode: disable
+  migrationsDir: migrations
   driver: pgx
 
 jaeger:
@@ -53,7 +54,7 @@ status:
   port: 8000
   livenessPath: /live
   readinessPath: /ready
-  swaggerPath: /swagger/
+  swaggerPath: /debug/swagger/
   versionPath: /version
 
 kafka:

external/swagger/api.swagger.json

@@ -1,8 +1,12 @@
 {
   "swagger": "2.0",
   "info": {
-    "title": "reddit/reddit_feed_api/v1/reddit_feed_api.proto",
-    "version": "version not set"
+    "title": "Reddit Feed API",
+    "version": "1.0",
+    "license": {
+      "name": "MIT",
+      "url": "https://github.com/arttet/reddit-feed-api/blob/main/LICENSE"
+    }
   },
   "consumes": [
     "application/json"