Downloaded 34 times
Uploaded byArtem Kovardin
Best practices-for-production-environments
This document provides best practices for production environments in Go projects, including recommendations for development environments, repository structure, formatting and style, configuration, logging and telemetry, testing and validation, dependency management, and building and deploying. It recommends using a single GOPATH, structuring repositories with README, Makefile, and package folders, formatting code with go fmt and following Google style guidelines. It also discusses setting configuration via flags, implementing logging and metrics, writing tests including integration tests, managing dependencies with the VENDOR folder, and building and deploying through Makefiles and scaling stateless services.
More Related Content
Best practices-for-production-environments
- 1. Best Practices for ProductionEnvironments
- 2. These slides maynot make much sense without a narrative! For the proper article, see http://peter.bourgon.org/go-in-production
- 4. Some Go Projects Bazooka Traffic tier Mediastreaming Search & Explore glue Prometheus Stream backend* HLS implementation** Many others…
- 5. Dev environment Repo structure Formattingand style Configuration Logging and telemetry Validation and testing Dependency management ᕕ( ᐛ )ᕗ Build and deploy
- 6.
- 7. Single GOPATH forall projects Work in $GOPATH/src/github.com/soundcloud/foo vim, Sublime Text, emacs—no IDEs
- 8.
- 9.
- 10.
- 11.
- 12.
- 13. go fmt Google’s CodeReview Guidelines Avoid named return parameters Avoid make and new (unless you know sizes) Use struct{} for sentinel value: sets, signal chans Break long lines on parameters
- 14. func process(dst io.Writer,readTimeout, writeTimeout time.Duration, allowInvalid bool, max int, src <-chan util.Job) { // ... }
- 15. func process( dst io.Writer, readTimeout,writeTimeout time.Duration, allowInvalid bool, max int, src <-chan util.Job, ) { // ... }
- 16. f := foo.New(foo.Config{ “zombo.com”, conference.KeyPair{ Key:“gophercon”, // String value Value: 2014, }, os.Stdout, })
- 17.
- 18.
- 19. func main() { var( foo = flag.String(“foo”, “doch”, “...”) bar = flag.Int(“bar”, 34, “...”) ) flag.Parse() // ... }
- 20.
- 21.
- 22.
- 23.
- 24.
- 25.
- 26.
- 27.
- 28. // +build integration varfooAddr = flag.String(...) func TestFoo(t *testing.T) { f, err := newFoo(*fooAddr) // ... }
- 29.
- 30. Save Build onon go fmt goimports or govet golint go test and and maybe Deploy on go test -tags=integration gocov?
- 31.
- 32.
- 34. How important is yourproject? go get -d & hope! VENDOR Eh Very ☞ ☞ import proxy?
- 35. VENDOR submodules with subtrees with a tool with ✖✖✖ means copyyour dependencies
- 36. Binary VENDOR Library _vendor subdirectory Blessed build, with prefixedGOPATH + vendor subdirectory Rewrite your imports + ☞ ☞
- 37.
- 38.
- 39.
- 40. GOVER=go1.2.1 ! STAGE=.stage GOPATH=$(CURDIR)/$(STAGE)/gopath GOROOT=$(CURDIR)/$(STAGE)/go GOCC=$(GOROOT)/bin/go GO=TMPDIR=/tmp GOROOT=$(GOROOT) GOPATH=$(GOPATH)$(GOCC) ! OS=$(shell uname) ARCH=$(shell uname -m) GOOS=$(subst Darwin,darwin,$(subst Linux,linux,$(OS))) GOARCH=$(subst x86_64,amd64,$(ARCH)) GOPKG=$(subst darwin-amd64,darwin-amd64-osx10.8,$(GOVER).$(GOOS)-$(GOARCH).tar.gz) ! PKGBASE=github.com/soundcloud/goku PKGPATH=$(GOPATH)/src/$(PKGBASE) ! all: build ! build: $(GOCC) $(PKGPATH) GOPATH=$(GOPATH) GOROOT=$(GOROOT) GO=$(GOCC) make -C roshi-server build GOPATH=$(GOPATH) GOROOT=$(GOROOT) GO=$(GOCC) make -C roshi-walker build GOPATH=$(GOPATH) GOROOT=$(GOROOT) GO=$(GOCC) make -C reader build GOPATH=$(GOPATH) GOROOT=$(GOROOT) GO=$(GOCC) make -C writer build GOPATH=$(GOPATH) GOROOT=$(GOROOT) GO=$(GOCC) make -C gap-backfill build ! clean: GOPATH=$(GOPATH) GOROOT=$(GOROOT) GO=$(GOCC) make -C roshi-server clean
- 41.
- 42. StatefulStateless Any/no model12-Factor model ProvisionedScaled vs. ContainersContainers? MySQL, RedisRequest router
- 43. $ git pushbazooka master $ bazooka scale -r <new> -n 4 ... $ # validate $ bazooka scale -r <old> -n 0 ... Deploying stateless services
- 44.
- 45.