feat: add zipkin

cmd/layotto/main.go

@@ -22,6 +22,10 @@ import (
 	"strconv"
 	"time"
 
+	mosn_zipkin "mosn.io/mosn/pkg/trace/zipkin"
+
+	"mosn.io/layotto/diagnostics/zipkin"
+
 	mosn_jaeger "mosn.io/mosn/pkg/trace/jaeger"
 
 	"github.com/dapr/components-contrib/secretstores"
@@ -519,6 +523,7 @@ func ExtensionsRegister(_ *cli.Context) {
 	trace.RegisterTracerBuilder("SOFATracer", lprotocol.Layotto, diagnostics.NewTracer)
 	trace.RegisterTracerBuilder(skywalking.SkyDriverName, lprotocol.Layotto, lsky.NewGrpcSkyTracer)
 	trace.RegisterTracerBuilder(mosn_jaeger.DriverName, lprotocol.Layotto, jaeger.NewGrpcJaegerTracer)
+	trace.RegisterTracerBuilder(mosn_zipkin.DriverName, lprotocol.Layotto, zipkin.NewGrpcZipTracer)
 }
 
 func main() {

cmd/layotto_multiple_api/main.go

@@ -32,6 +32,7 @@ import (
 	secretstore_env "github.com/dapr/components-contrib/secretstores/local/env"
 	secretstore_file "github.com/dapr/components-contrib/secretstores/local/file"
 	mosn_jaeger "mosn.io/mosn/pkg/trace/jaeger"
+	mosn_zipkin "mosn.io/mosn/pkg/trace/zipkin"
 
 	secretstores_loader "mosn.io/layotto/pkg/runtime/secretstores"
 
@@ -179,6 +180,7 @@ import (
 	"mosn.io/layotto/diagnostics/jaeger"
 	lprotocol "mosn.io/layotto/diagnostics/protocol"
 	lsky "mosn.io/layotto/diagnostics/skywalking"
+	"mosn.io/layotto/diagnostics/zipkin"
 )
 
 // loggerForDaprComp is constructed for reusing dapr's components.
@@ -531,6 +533,7 @@ func ExtensionsRegister(_ *cli.Context) {
 	trace.RegisterTracerBuilder("SOFATracer", "layotto", diagnostics.NewTracer)
 	trace.RegisterTracerBuilder(skywalking.SkyDriverName, lprotocol.Layotto, lsky.NewGrpcSkyTracer)
 	trace.RegisterTracerBuilder(mosn_jaeger.DriverName, lprotocol.Layotto, jaeger.NewGrpcJaegerTracer)
+	trace.RegisterTracerBuilder(mosn_zipkin.DriverName, lprotocol.Layotto, zipkin.NewGrpcZipTracer)
 }
 
 func main() {

configs/config_trace_zipkin.json

@@ -0,0 +1,87 @@
+{
+  "servers": [
+    {
+      "default_log_path": "stdout",
+      "default_log_level": "INFO",
+      "listeners": [
+        {
+          "name": "grpc",
+          "address": "0.0.0.0:34904",
+          "bind_port": true,
+          "filter_chains": [
+            {
+              "filters": [
+                {
+                  "type": "grpc",
+                  "config": {
+                    "server_name": "runtime",
+                    "grpc_config": {
+                      "hellos": {
+                        "quick_start_demo": {
+                          "type": "helloworld",
+                          "hello": "greeting"
+                        }
+                      },
+                      "config_store": {
+                        "config_demo": {
+                          "type": "etcd",
+                          "address": [
+                            "127.0.0.1:2379"
+                          ],
+                          "timeout": "10"
+                        }
+                      }
+                    }
+                  }
+                }
+              ]
+            }
+          ],
+          "stream_filters": [
+            {
+              "type": "flowControlFilter",
+              "config": {
+                "global_switch": true,
+                "limit_key_type": "PATH",
+                "rules": [
+                  {
+                    "resource": "/spec.proto.runtime.v1.Runtime/SayHello",
+                    "grade": 1,
+                    "threshold": 5
+                  }
+                ]
+              }
+            },
+            {
+              "type": "grpc_metric"
+            }
+          ]
+        }
+      ]
+    }
+  ],
+  "tracing": {
+    "enable": true,
+    "driver": "Zipkin",
+    "config": {
+      "config": {
+        "config": {
+          "service_name": "layotto",
+          "reporter_endpoint": "http://127.0.0.1:9411/api/v2/spans",
+          "recorder_host_post": "127.0.0.1:9000"
+        }
+      }
+    }
+  },
+  "metrics": {
+    "sinks": [
+      {
+        "type": "prometheus",
+        "config": {
+          "port": 34903
+        }
+      }
+    ]
+  }
+}
+

diagnostics/zipkin/grpc_tracer.go

@@ -0,0 +1,141 @@
+/*
+* Copyright 2021 Layotto Authors
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*     http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+ */
+
+package zipkin
+
+import (
+	"context"
+	"time"
+
+	"mosn.io/layotto/diagnostics/grpc"
+
+	"github.com/openzipkin/zipkin-go"
+	reporterhttp "github.com/openzipkin/zipkin-go/reporter/http"
+	"mosn.io/api"
+	"mosn.io/mosn/pkg/types"
+	"mosn.io/pkg/log"
+
+	ltrace "mosn.io/layotto/components/trace"
+)
+
+const (
+	service_name       = "service_name"
+	reporter_endpoint  = "reporter_endpoint"
+	recorder_host_post = "recorder_host_post"
+	configs            = "config"
+
+	defaultReporterEndpoint = "http://127.0.0.1:9411/api/v2/spans"
+	defaultServiceName      = "layotto"
+	defaultRecorderHostPost = "127.0.0.1:9000"
+)
+
+type grpcZipTracer struct {
+	*zipkin.Tracer
+}
+
+type grpcZipSpan struct {
+	*ltrace.Span
+	tracer *grpcZipTracer
+	ctx    context.Context
+	span   zipkin.Span
+}
+
+func NewGrpcZipTracer(traceCfg map[string]interface{}) (api.Tracer, error) {
+	reporter := reporterhttp.NewReporter(getReporterEndpoint(traceCfg))
+
+	endpoint, err := zipkin.NewEndpoint(getServerName(traceCfg), getRecorderHostPort(traceCfg))
+	if err != nil {
+		log.DefaultLogger.Errorf("[layotto] [zipkin] [tracer] unable to create zipkin reporter endpoint")
+		return nil, err
+	}
+
+	tracer, err := zipkin.NewTracer(reporter, zipkin.WithLocalEndpoint(endpoint), zipkin.WithTraceID128Bit(true))
+	if err != nil {
+		log.DefaultLogger.Errorf("[layotto] [zipkin] [tracer] cannot initialize zipkin Tracer")
+		return nil, err
+	}
+
+	log.DefaultLogger.Infof("[layotto] [zipkin] [tracer] create success")
+
+	return &grpcZipTracer{
+		tracer,
+	}, nil
+}
+
+func getRecorderHostPort(traceCfg map[string]interface{}) string {
+	if cfg, ok := traceCfg[configs]; ok {
+		recorderHostPort := cfg.(map[string]interface{})
+		if point, ok := recorderHostPort[recorder_host_post]; ok {
+			return point.(string)
+		}
+	}
+
+	return defaultRecorderHostPost
+}
+
+func getReporterEndpoint(traceCfg map[string]interface{}) string {
+	if cfg, ok := traceCfg[configs]; ok {
+		endpoint := cfg.(map[string]interface{})
+		if point, ok := endpoint[reporter_endpoint]; ok {
+			return point.(string)
+		}
+	}
+
+	return defaultReporterEndpoint
+}
+
+func getServerName(traceCfg map[string]interface{}) string {
+	if cfg, ok := traceCfg[configs]; ok {
+		serverName := cfg.(map[string]interface{})
+		if name, ok := serverName[service_name]; ok {
+			return name.(string)
+		}
+	}
+
+	return defaultServiceName
+}
+
+func (t *grpcZipTracer) Start(ctx context.Context, request interface{}, _ time.Time) api.Span {
+	info, ok := request.(*grpc.RequestInfo)
+	if !ok {
+		log.DefaultLogger.Debugf("[layotto] [zipkin] [tracer] unable to get request header, downstream trace ignored")
+		return nil
+	}
+
+	// start span
+	span := t.StartSpan(info.FullMethod)
+
+	return &grpcZipSpan{
+		tracer: t,
+		ctx:    ctx,
+		Span:   &ltrace.Span{},
+		span:   span,
+	}
+}
+
+func (s *grpcZipSpan) TraceId() string {
+	return s.span.Context().TraceID.String()
+}
+
+func (s *grpcZipSpan) InjectContext(requestHeaders types.HeaderMap, requestInfo api.RequestInfo) {
+}
+
+func (s *grpcZipSpan) SetRequestInfo(requestInfo api.RequestInfo) {
+}
+
+func (s *grpcZipSpan) FinishSpan() {
+	s.span.Finish()
+}

diagnostics/zipkin/zipkin-docker-compose.yaml

@@ -0,0 +1,23 @@
+#Licensed to the Apache Software Foundation (ASF) under one or more
+#contributor license agreements.  See the NOTICE file distributed with
+#this work for additional information regarding copyright ownership.
+#The ASF licenses this file to You under the Apache License, Version 2.0
+#(the "License"); you may not use this file except in compliance with
+#the License.  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+#Unless required by applicable law or agreed to in writing, software
+#distributed under the License is distributed on an "AS IS" BASIS,
+#WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#See the License for the specific language governing permissions and
+#limitations under the License.
+
+version: '3.3'
+services:
+  zipkin:
+    image: openzipkin/zipkin:latest
+    container_name: zipkin
+    restart: always
+    ports:
+      - "9411:9411"

docs/zh/_sidebar.md

@@ -26,6 +26,7 @@
         - [Metrics 接入 Prometheus](zh/start/trace/prometheus.md)
         - [Trace 接入 Skywalking](zh/start/trace/skywalking.md)
         - [Trace 接入 Jaeger](zh/start/trace/jaeger.md)
+        - [Trace 接入 Zipkin](zh/start/trace/zipkin.md)
     - [将业务逻辑通过 WASM 下沉进sidecar](zh/start/wasm/start.md)
     - [基于 WASM 跟 Runtime 实现的 Faas 模型](zh/start/faas/start.md)
 - [用户手册](zh/building_blocks/)

docs/zh/start/trace/zipkin.md

@@ -0,0 +1,93 @@
+# ZipKin trace 接入
+
+## 配置
+
+示例：configs/config_trace_zipkin.json
+
+```json
+{
+  "tracing": {
+    "enable": true,
+    "driver": "Zipkin",
+    "config": {
+      "config": {
+        "config": {
+          "service_name": "layotto",
+          "reporter_endpoint": "http://127.0.0.1:9411/api/v2/spans",
+          "recorder_host_post": "127.0.0.1:9000"
+        }
+      }
+    }
+  }
+}
+
+```
+| 字段   | 必填  | 说明                                           |
+|------|-----|----------------------------------------------|
+| service_name | Y   | 服务名称，默认为layotto                              |
+| reporter_endpoint | Y   | 链路日志输出，默认为http://127.0.0.1:9411/api/v2/spans |
+| recorder_host_post     | Y   | 当前服务端口号，默认为127.0.0.1:9000                                  |
+
+注意：目前只支持Http方式的Reporter。
+
+## 运行ZipKin
+
+```shell
+cd ${project_path}/diagnostics/zipkin
+
+docker-compose -f zipkin-docker-compose.yaml up -d
+```
+
+## 运行layotto
+
+可以按照如下方式启动一个layotto的server：
+
+切换目录:
+
+```shell
+cd ${project_path}/cmd/layotto_multiple_api
+```
+
+构建:
+
+```shell @if.not.exist layotto
+go build -o layotto
+```
+
+运行:
+
+```shell @background
+./layotto start -c ../../configs/config_trace_zipkin.json 
+```
+
+## 运行 Demo
+
+对应的调用端代码在[client.go](https://github.com/mosn/layotto/blob/main/demo/flowcontrol/client.go) 中，运行它会调用layotto的SayHello接口：
+
+切换目录:
+
+```shell
+ cd ${project_path}/demo/flowcontrol/
+``` 
+
+构建:
+
+```shell @if.not.exist client 
+ go build -o client
+```
+运行:
+
+```shell
+./client
+```
+访问：http://localhost:9411/zipkin/?serviceName=layotto&lookback=15m&endTs=1655559536414&limit=10
+
+![](../../../img/trace/zipkin.png)
+
+## 清理资源
+
+```shell
+cd ${project_path}/diagnostics/zipkin
+
+docker-compose -f zipkin-docker-compose.yaml down
+```