add example test

Author: codeandcode0x

README.md

@@ -1,13 +1,20 @@
-微服务架构 —— 分布式链路追踪
+# 微服务架构 —— 分布式链路追踪
 
-# Tracing SDK
+## 简介
+traceandtrace-go 是 go 语言 tracing lib, 可以集成不同的 tracer 如: jeager、zipkin、skywalking ... <br>
+
+## 版本介绍
+- v1.0.0 目前只支持 jeager 
+- 支持 http 和 gRPC (or both) 调用链路
+- 支持采样率、采样类型、收集器等配置
+
+## API
 
-Go、Java Tracing SDK
 
 
 ## 快速开始
 
-### 启动 Jaeger or Zipkin
+### 启动 Jaeger
 
 ```shell
 docker run \
@@ -26,11 +33,8 @@ ethansmart-docker.pkg.coding.net/istioalltime/roandocker/jaegertracing-all-in-on
 ```shell
 go get github.com/codeandcode0x/traceandtrace-go
 ```
-或者
 
-```shell
-go get github.com/codeandcode0x/traceandtrace-go
-```
+
 
 ### HTTP 请求链路
 在 http request 方法侧创建 trace

example_test.go

@@ -0,0 +1,24 @@
+package traceandtracego_test
+
+import (
+	"io/ioutil"
+	"log"
+	"net/http"
+
+	tracing "github.com/codeandcode0x/traceandtrace-go"
+)
+
+func ExampleAddHttpTracing() {
+	httpClient := &http.Client{}
+	r, _ := http.NewRequest("GET", "http://www.weather.com.cn/data/sk/101010100.html", nil)
+	// set tracing
+	_, cancel := tracing.AddHttpTracing("HttpClent", r.Header, map[string]string{"version": "v1"})
+	defer cancel()
+	// send reqeust
+	response, _ := httpClient.Do(r)
+	if response.StatusCode == 200 {
+		str, _ := ioutil.ReadAll(response.Body)
+		bodystr := string(str)
+		log.Println("body string", bodystr)
+	}
+}

reporter_jobs.go

@@ -1,3 +1,19 @@
+/** Package traceandtrace-go 是 go 语言 tracing lib, 可以集成不同的 tracer 如: jeager、zipkin、skywalking 等
+reporter_job 可以对 tracing 数据上报，做了性能优化，做到业务侵入小, 高性能等。
+
+// 快速上手
+	import (
+    	tracing "github.com/codeandcode0x/traceandtrace-go"
+	)
+
+	// 在 func 中 或者 middleware 中添加
+	_, cancel := tracing.AddHttpTracing("HttpTracingTest", [your http Header], map[string]string{"version": "v1"})
+	defer cancel()
+
+	...
+
+	reporter_job 对上报 tracing 数据进行了优化 (采用携程任务处理),对业务侵入小，高性能上报,job 结束后, 可以对资源进行释放。
+*/
 package traceandtracego
 
 import (
@@ -10,9 +26,8 @@ import (
 	opentracing "github.com/opentracing/opentracing-go"
 )
 
-//生成 trace jobs
-func GenerateTracingJobs(pch chan<- context.Context, parent context.Context,
-	svc string, header http.Header, tags map[string]string, traceType string) {
+//generate trace jobs (goroutine), use context and chan to control jobs and release goroutine .
+func GenerateTracingJobs(pch chan<- context.Context, parent context.Context, svc string, header http.Header, tags map[string]string, traceType string) {
 	//设置 context
 	ctx, cancel := context.WithCancel(parent)
 	//设置通道
@@ -48,10 +63,8 @@ func doTask(ch chan context.Context, parent context.Context,
 		break
 	case "zipkin":
 		log.Println("create zipkin tracing job")
-		tracer, closer = tracing.InitZipkin(svc)
-		ctx = tracing.AddTracer(svc, parent, header, tracer, tags)
 		break
-	case "skyWalking":
+	case "skywalking":
 		log.Println("create skywalking tracing job")
 		break
 	default:

tracer/skywalking.go

@@ -10,9 +10,6 @@ import (
 	httpreporter "github.com/openzipkin/zipkin-go/reporter/http"
 )
 
-// var ctxShare context.Context
-// var tracer opentracing.Tracer
-
 //初始化 zipkin
 func InitZipkin(service string) (opentracing.Tracer, reporter.Reporter) {
 	//设置 span reporter
@@ -33,26 +30,3 @@ func InitZipkin(service string) (opentracing.Tracer, reporter.Reporter) {
 	//返回 trace & reporter
 	return tracer, reporter
 }
-
-//添加 tracer
-// func AddTracer(r *http.Request, tracer opentracing.Tracer) {
-// 	opentracing.InitGlobalTracer(tracer)
-// 	sp := tracer.StartSpan(r.URL.Path)
-// 	spanCtx, _ := opentracing.GlobalTracer().Extract(opentracing.HTTPHeaders,
-// 		opentracing.HTTPHeadersCarrier(r.Header))
-// 	if spanCtx != nil {
-// 		sp = opentracing.GlobalTracer().StartSpan(r.URL.Path, opentracing.ChildOf(spanCtx))
-// 	} else {
-// 		//http inject
-// 		if err := opentracing.GlobalTracer().Inject(
-// 			sp.Context(),
-// 			opentracing.HTTPHeaders,
-// 			opentracing.HTTPHeadersCarrier(r.Header)); err != nil {
-// 			logger.Println("[traceandtrace] [Error] inject failed ...", err)
-// 		}
-// 	}
-// 	//上下文记录父spanContext
-// 	ctxShare = context.WithValue(context.Background(), "usergRpcCtx", opentracing.ContextWithSpan(context.Background(), sp))
-// 	//close span
-// 	defer sp.Finish()
-// }

tracer/zipkin.go

@@ -14,23 +14,19 @@ import (
 const (
 	JAEGER_TRACER     = "jaeger"
 	ZIPKIN_TRACER     = "zipkin"
-	SKYWALKING_TRACER = "skyWalking"
+	SKYWALKING_TRACER = "skywalking"
 )
 
-//add tracing
-func AddHttpTracing(
-	svcName string,
-	header http.Header,
-	tags map[string]string,
-	param ...map[string]string) (context.Context, context.CancelFunc) {
+// Add http tracing , tags is k-v map which can set in span log, param map can set trace type .
+func AddHttpTracing(svcName string, header http.Header, tags map[string]string, param ...map[string]string) (context.Context, context.CancelFunc) {
 	// 定义 trace type
 	var traceType string
 	//启动 trace 任务
 	ctx, cancel := context.WithCancel(context.Background())
 	//创建通道
 	ch := make(chan context.Context, 0)
 	//选择类型和服务
-	traceType = JAEGER_TRACER
+	ç = JAEGER_TRACER
 	if len(param) > 0 {
 		if _, exist := param[0]["traceType"]; exist {
 			traceType = strings.ToLower(param[0]["traceType"])
@@ -43,27 +39,17 @@ func AddHttpTracing(
 }
 
 //add rpc client tracing
-func AddRpcClientTracing(serviceName string) (grpc.DialOption, io.Closer) {
+func AddRpcClientTracing(serviceName string, param ...map[string]string) (grpc.DialOption, io.Closer) {
 	//初始化 jaeger
 	tracer, closer := tracing.InitJaeger(serviceName)
 	//返回 rpc options
 	return tracing.ClientDialOption(tracer), closer
 }
 
 //add rpc server tracing
-func AddRpcServerTracing(serviceName string) (grpc.ServerOption, io.Closer, opentracing.Tracer) {
+func AddRpcServerTracing(serviceName string, param ...map[string]string) (grpc.ServerOption, io.Closer, opentracing.Tracer) {
 	//初始化 jaeger
 	tracer, closer := tracing.InitJaeger(serviceName)
 	//返回 rpc options
 	return tracing.ServerDialOption(tracer), closer, tracer
 }
-
-//zipkin
-func AddZipkinTracer(serviceName string) {
-	//TO-DO
-}
-
-//skywalking
-func AddSkyWalkingTracer(serviceName string) {
-	//TO-DO
-}