Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 1.87 KB

README.md

File metadata and controls

61 lines (40 loc) · 1.87 KB
Raw

go-backend-service-common

A library that bundles common building blocks for golang microservices.

Features

This library provides:

  • read and validate configuration from environment variables (and from a file on localhost)
  • json logging (and human-readable plaintext on localhost)
  • a vault client
  • a health controller
  • a controller for serving a bundled swagger ui and an openapi v3 spec
  • middlewares for
    • cors headers
    • distributed tracing (request id headers)
    • incoming request logging
    • incoming request metrics
    • incoming request timeouts
    • panic recovery
    • apm tracing

It aims to be compatible with a typical Spring microservice:

  • Request IDs and the Request ID header match
  • Request metrics names are customized to match Spring Boot Default Metrics
  • JSON logging format has been adapted to match ECS logging schema

Development

initial setup

clone this outside your GOPATH (on linux, defaults to ~/go)

Tip: On Windows, maybe don't have the GOPATH in your profile, because a large body of source code goes there.

build

go build ./...

run tests

Run all tests, collecting coverage across all directories

go test -coverpkg=./... -v ./...

In IntelliJ/GoLand, if you want to check code coverage, you must set Go Tool Arguments to -coverpkg=./..., so cross-package coverage from acceptance tests is considered. You may wish to set this under Edit Configuration - Edit Configuration Templates, so it will be set on all new test run configurations.

Goland terminal configuration

Goland has the habit of limiting line width on the output terminal to 80 characters no matter how wide the window is. You can fix this. Menu: Help -> Find Action... -> search for "Registry"

Uncheck go.run.processes.with.pty.

List dependency tree

go mod graph > deps.txt