Merge pull request pathwar#443 from pathwar/dev/moul/tracing

feat: configure opentracing

api/errcode.proto

@@ -162,6 +162,7 @@ enum ErrCode {
   ErrConfigureDB = 6013;
   ErrInitSSOClient = 6014;
   ErrInitService = 6015;
+  ErrInitTracer = 6016;
 
   //// Pathwar Agent (starting at 7001)
 

go.mod

@@ -29,6 +29,9 @@ require (
 	github.com/oklog/run v1.0.0
 	github.com/olekukonko/tablewriter v0.0.4
 	github.com/opencontainers/go-digest v1.0.0-rc1 // indirect
+	github.com/opentracing/opentracing-go v1.1.0
+	github.com/openzipkin-contrib/zipkin-go-opentracing v0.4.5
+	github.com/openzipkin/zipkin-go v0.2.1
 	github.com/peterbourgon/ff v1.7.0
 	github.com/pkg/errors v0.8.1
 	github.com/rogpeppe/go-internal v1.5.1 // indirect

go/Makefile

@@ -25,10 +25,6 @@ include ../rules.mk  # see https://github.com/moul/rules.mk
 	mkdir -p out
 	GOOS=linux GOARCH=amd64 $(GO) build -mod=readonly -o $@ ./cmd/pwinit
 
-##
-## mysql
-##
-
 MYSQL_CONFIG ?=	-h127.0.0.1 -P3306 -uroot -puns3cur3
 
 .PHONY: up
@@ -57,7 +53,7 @@ mysql.down:
 
 .PHONY: mysql.logs
 mysql.logs:
-	docker-compose logs -f mysql
+	docker-compose logs --tail=1000 -f mysql
 
 .PHONY: mysql.shell
 mysql.shell:
@@ -67,9 +63,18 @@ mysql.shell:
 mysql.dump:
 	mysqldump $(MYSQL_CONFIG) pathwar
 
-.PHONY: packr
-packr:
-	cd pkg/pwinit && packr2
+.PHONY: zipkin.up
+zipkin.up:
+	docker-compose $(COMPOSE_OPTS) up -d zipkin
+
+.PHONY: zipkin.logs
+zipkin.logs:
+	docker-compose $(COMPOSE_OPTS) logs --tail=1000 -f zipkin
+
+.PHONY: zipkin.down
+zipkin.down:
+	docker-compose $(COMPOSE_OPTS) stop zipkin || true
+	docker-compose $(COMPOSE_OPTS) rm -f -v zipkin || true
 
 ##
 ## generate
@@ -110,3 +115,7 @@ generate_local:
 .PHONY: clean
 clean:
 	rm -f gen.sum $(wildcard */*/*.pb.go */*/*.pb.gw.go) $(wildcard out/*) $(wildcard */*/packrd/*) $(wildcard */*/*-packr.go)
+
+.PHONY: packr
+packr:
+	cd pkg/pwinit && packr2

go/cmd/pathwar/main.go

@@ -20,6 +20,11 @@ import (
 	_ "github.com/go-sql-driver/mysql" // required by gorm
 	"github.com/jinzhu/gorm"
 	"github.com/oklog/run"
+	opentracing "github.com/opentracing/opentracing-go"
+	zipkinot "github.com/openzipkin-contrib/zipkin-go-opentracing"
+	zipkin "github.com/openzipkin/zipkin-go"
+	"github.com/openzipkin/zipkin-go/model"
+	reporterhttp "github.com/openzipkin/zipkin-go/reporter/http"
 	"github.com/peterbourgon/ff"
 	"github.com/peterbourgon/ff/ffcli"
 	"go.uber.org/zap"
@@ -51,7 +56,9 @@ const (
 )
 
 var (
-	logger     *zap.Logger
+	logger *zap.Logger
+	tracer opentracing.Tracer
+
 	flagOutput = os.Stderr
 
 	// flag vars
@@ -86,6 +93,7 @@ var (
 	composeUpForceRecreate   bool
 	composeUpInstanceKey     string
 	httpAPIAddr              string
+	zipkinEndpoint           string
 	serverBind               string
 	serverCORSAllowedOrigins string
 	serverRequestTimeout     time.Duration
@@ -128,6 +136,7 @@ func main() {
 	)
 	globalFlags.SetOutput(flagOutput) // used in main_test.go
 	globalFlags.BoolVar(&globalDebug, "debug", false, "debug mode")
+	globalFlags.StringVar(&zipkinEndpoint, "zipkin-endpoint", "", "optional opentracing server")
 	globalFlags.StringVar(&bearerSecretKey, "bearer-secretkey", "", "bearer.sh secret key")
 
 	agentFlags.BoolVar(&agentClean, "clean", false, "remove all pathwar instances before executing")
@@ -238,6 +247,7 @@ func main() {
 						RequestTimeout:     serverRequestTimeout,
 						ShutdownTimeout:    serverShutdownTimeout,
 						WithPprof:          serverWithPprof,
+						Tracer:             tracer,
 					}
 					var err error
 					server, err = pwapi.NewServer(ctx, svc, opts)
@@ -790,6 +800,24 @@ func globalPreRun() error {
 			return errcode.ErrInitLogger.Wrap(err)
 		}
 	}
+	if zipkinEndpoint != "" {
+		reporter := reporterhttp.NewReporter(zipkinEndpoint)
+		localEndpoint := &model.Endpoint{ServiceName: "pathwar"}
+		sampler, err := zipkin.NewCountingSampler(1)
+		if err != nil {
+			return errcode.ErrInitTracer.Wrap(err)
+		}
+		nativeTracer, err := zipkin.NewTracer(
+			reporter,
+			zipkin.WithSampler(sampler),
+			zipkin.WithLocalEndpoint(localEndpoint),
+		)
+		if err != nil {
+			return errcode.ErrInitTracer.Wrap(err)
+		}
+		tracer = zipkinot.Wrap(nativeTracer)
+		opentracing.SetGlobalTracer(tracer)
+	}
 	return nil
 }
 

go/cmd/pathwar/main_test.go

@@ -24,4 +24,5 @@ func Example() {
 	// FLAGS
 	//   -bearer-secretkey ...  bearer.sh secret key
 	//   -debug false           debug mode
+	//   -zipkin-endpoint ...   optional opentracing server
 }

go/docker-compose.dev.yml

@@ -8,3 +8,7 @@ services:
   mysql:
     ports:
       - 3306:3306
+
+  zipkin:
+    ports:
+      - 9411:9411

go/docker-compose.yml

@@ -38,6 +38,11 @@ services:
       MYSQL_USER: pathwar
       MYSQL_PASSWORD: uns3cur3
 
+  zipkin:
+    image: openzipkin/zipkin-slim:latest
+    ports:
+      - 9411
+
   mailserver:
     image: mailhog/mailhog
     restart: unless-stopped