feat: add dubbo-go plugins

.github/workflows/plugin_test.yaml

@@ -43,6 +43,7 @@ jobs:
             kratos/test/go_kratos_plugin_test.yaml: kratos/**
             sql/test/sql_plugin_test.yaml: sql/**
             kafkareporter/test/go_kafka_reporter_plugin_test.yaml: kafkareporter/**
+            dubbo-go/test/dubbo_go_plugin_test.yaml: dubbo-go/**
 
   PluginsTest:
     name: Plugin

README.md

@@ -20,6 +20,7 @@ The plugins of [go2sky](https://github.com/SkyAPM/go2sky)
 1. [go-restful](go-restful/README.md)
 1. [go-kratos](kratos/README.md)
 1. [sql](sql/README.md)
+1. [dubbo-go](dubbo-go/README.md)
 
 ### Log Plugins
 

dubbo-go/README.md

@@ -0,0 +1,101 @@
+### Go2Sky with Dubbo-go
+
+##### Installation
+
+```
+go get -u github.com/SkyAMP/go2sky-plugins/dubbo-go
+```
+
+##### Usage
+
+Server:
+
+```go
+import (
+    _ "dubbo.apache.org/dubbo-go/v3/cluster/cluster_impl"
+	_ "dubbo.apache.org/dubbo-go/v3/cluster/loadbalance"
+	"dubbo.apache.org/dubbo-go/v3/common/logger"
+	_ "dubbo.apache.org/dubbo-go/v3/common/proxy/proxy_factory"
+	"dubbo.apache.org/dubbo-go/v3/config"
+	_ "dubbo.apache.org/dubbo-go/v3/filter/filter_impl"
+	_ "dubbo.apache.org/dubbo-go/v3/protocol/dubbo"
+	_ "dubbo.apache.org/dubbo-go/v3/registry/protocol"
+	_ "dubbo.apache.org/dubbo-go/v3/registry/zookeeper"
+	"github.com/SkyAPM/go2sky"
+	"github.com/SkyAPM/go2sky/reporter"
+	hessian "github.com/apache/dubbo-go-hessian2"
+
+	dubbo_go "github.com/SkyAPM/go2sky-plugins/dubbo-go"
+	"github.com/SkyAPM/go2sky-plugins/dubbo-go/test/server/pkg"
+)
+
+// set dubbogo configs ...
+
+// setup reporter, use gRPC reporter for production
+report, err := reporter.NewLogReporter()
+if err != nil {
+    log.Fatalf("new reporter error: %v \n", err)
+}
+
+// setup tracer
+tracer, err := go2sky.NewTracer(serviceName, go2sky.WithReporter(report))
+if err != nil {
+    log.Fatalf("crate tracer error: %v \n", err)
+}
+
+// set dubbogo plugin server tracer
+err = dubbo_go.SetServerTracer(tracer)
+if err != nil {
+    log.Fatalf("set tracer error: %v \n", err)
+}
+
+// set extra tags and report tags
+dubbo_go.SetServerExtraTags("extra-tags", "server")
+dubbo_go.SetServerReportTags("release")
+```
+
+Client:
+
+```go
+import (
+	_ "dubbo.apache.org/dubbo-go/v3/cluster/cluster_impl"
+	_ "dubbo.apache.org/dubbo-go/v3/cluster/loadbalance"
+	_ "dubbo.apache.org/dubbo-go/v3/common/proxy/proxy_factory"
+	"dubbo.apache.org/dubbo-go/v3/config"
+	_ "dubbo.apache.org/dubbo-go/v3/filter/filter_impl"
+	_ "dubbo.apache.org/dubbo-go/v3/protocol/dubbo"
+	_ "dubbo.apache.org/dubbo-go/v3/registry/protocol"
+	_ "dubbo.apache.org/dubbo-go/v3/registry/zookeeper"
+	"github.com/SkyAPM/go2sky"
+	"github.com/SkyAPM/go2sky/reporter"
+	hessian "github.com/apache/dubbo-go-hessian2"
+
+	dubbo_go "github.com/SkyAPM/go2sky-plugins/dubbo-go"
+	"github.com/SkyAPM/go2sky-plugins/dubbo-go/test/client/pkg"
+)
+
+// set dubbogo configs ...
+
+// setup reporter, use gRPC reporter for production
+report, err := reporter.NewLogReporter()
+if err != nil {
+    log.Fatalf("new reporter error: %v \n", err)
+}
+
+// setup tracer
+tracer, err := go2sky.NewTracer(serviceName, go2sky.WithReporter(report))
+if err != nil {
+    log.Fatalf("crate tracer error: %v \n", err)
+}
+
+// set dubbogo plugin client tracer
+err = dubbo_go.SetClientTracer(tracer)
+if err != nil {
+    log.Fatalf("set tracer error: %v \n", err)
+}
+
+// set extra tags and report tags
+dubbo_go.SetClientExtraTags("extra-tags", "client")
+dubbo_go.SetClientReportTags("release")
+```
+

dubbo-go/dubbo-go.go

@@ -0,0 +1,209 @@
+//
+// Copyright 2021 SkyAPM org
+//
+// 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 dubbo_go
+
+import (
+	"context"
+	"errors"
+	"sync"
+	"time"
+
+	"dubbo.apache.org/dubbo-go/v3/common/extension"
+	"dubbo.apache.org/dubbo-go/v3/filter"
+	"dubbo.apache.org/dubbo-go/v3/protocol"
+	agentv3 "skywalking.apache.org/repo/goapi/collect/language/agent/v3"
+
+	"github.com/SkyAPM/go2sky"
+)
+
+// side record the server or client
+type side int
+
+const (
+	componentID = 3
+
+	serverSide side = iota
+	clientSide side = iota
+)
+
+var (
+	errInvalidTracer = errors.New("invalid tracer")
+)
+
+// this should be executed before users set their own Tracer
+func init() {
+	// init default tracer
+	defaultTracer, _ = go2sky.NewTracer("default-dubbo-go-tracer")
+
+	// set filter
+	// in dubbo go conf:
+	//     client side: filter: "go2sky-tracing-client"
+	//     server side: filter: "go2sky-tracing-server"
+	// maybe move to constant
+	extension.SetFilter("go2sky-tracing-client", GetClientTracingFilterSingleton)
+	extension.SetFilter("go2sky-tracing-server", GetServerTracingFilterSingleton)
+}
+
+// default go2sky tracer
+var defaultTracer *go2sky.Tracer
+
+type tracingFilter struct {
+	tracer     *go2sky.Tracer
+	extraTags  map[string]string
+	reportTags []string
+	side       side
+}
+
+// SetClientTracer set client tracer with user's tracer.
+func SetClientTracer(tracer *go2sky.Tracer) error {
+	if tracer == nil {
+		return errInvalidTracer
+	}
+
+	clientFilter.tracer = tracer
+
+	return nil
+}
+
+// SetServerTracer set server tracer with user's tracer.
+func SetServerTracer(tracer *go2sky.Tracer) error {
+	if tracer == nil {
+		return errInvalidTracer
+	}
+
+	serverFilter.tracer = tracer
+
+	return nil
+}
+
+// SetClientExtraTags adds extra tag to client tracer spans.
+func SetClientExtraTags(key string, value string) {
+	if clientFilter.extraTags == nil {
+		clientFilter.extraTags = make(map[string]string)
+	}
+
+	clientFilter.extraTags[key] = value
+}
+
+// SetServerExtraTags adds extra tag to server tracer spans.
+func SetServerExtraTags(key string, value string) {
+	if serverFilter.extraTags == nil {
+		serverFilter.extraTags = make(map[string]string)
+	}
+
+	serverFilter.extraTags[key] = value
+}
+
+// SetClientReportTags adds report tags to client tracer spans.
+func SetClientReportTags(tags ...string) {
+	clientFilter.reportTags = append(clientFilter.reportTags, tags...)
+}
+
+// SetServerReportTags adds report tags to server tracer spans.
+func SetServerReportTags(tags ...string) {
+	serverFilter.reportTags = append(serverFilter.reportTags, tags...)
+}
+
+// Invoke implements dubbo-go filter interface.
+func (cf tracingFilter) Invoke(ctx context.Context, invoker protocol.Invoker, invocation protocol.Invocation) protocol.Result {
+	operationName := invoker.GetURL().ServiceKey() + "#" + invocation.MethodName()
+	var span go2sky.Span
+
+	if cf.side == clientSide {
+		span, _ = cf.tracer.CreateExitSpan(ctx, operationName, invoker.GetURL().Location, func(key, value string) error {
+			invocation.SetAttachments(key, value)
+			return nil
+		})
+
+		span.SetComponent(componentID)
+	} else {
+		// componentIDGo2SkyServer
+		span, ctx, _ = cf.tracer.CreateEntrySpan(ctx, operationName, func(key string) (string, error) {
+			return invocation.AttachmentsByKey(key, ""), nil
+		})
+
+		span.SetComponent(componentID)
+	}
+	defer span.End()
+
+	// add extra tags
+	for k, v := range cf.extraTags {
+		span.Tag(go2sky.Tag(k), v)
+	}
+
+	// add report tags
+	for _, tag := range cf.reportTags {
+		// from attachments
+		if v, ok := invocation.Attachments()[tag].(string); ok {
+			if ok {
+				span.Tag(go2sky.Tag(tag), v)
+			}
+		}
+		// or from url
+		if v := invoker.GetURL().GetParam(tag, ""); v != "" {
+			span.Tag(go2sky.Tag(tag), v)
+		}
+	}
+
+	// other tags ...
+	span.SetSpanLayer(agentv3.SpanLayer_RPCFramework)
+
+	result := invoker.Invoke(ctx, invocation)
+
+	// finish span
+	// defer span.End()
+	if result.Error() != nil {
+		// tag error
+		span.Error(time.Now(), result.Error().Error())
+	}
+	return result
+}
+
+// OnResponse implements dubbo-go filter interface.
+func (cf tracingFilter) OnResponse(ctx context.Context, result protocol.Result, invoker protocol.Invoker, invocation protocol.Invocation) protocol.Result {
+	return result
+}
+
+var (
+	serverFilterOnce sync.Once
+	serverFilter     *tracingFilter
+
+	clientFilterOnce sync.Once
+	clientFilter     *tracingFilter
+)
+
+// GetServerTracingFilterSingleton returns global server filter for server side.
+func GetServerTracingFilterSingleton() filter.Filter {
+	serverFilterOnce.Do(func() {
+		serverFilter = &tracingFilter{
+			tracer: defaultTracer,
+			side:   serverSide,
+		}
+	})
+	return serverFilter
+}
+
+// GetClientTracingFilterSingleton returns global filter for client side.
+func GetClientTracingFilterSingleton() filter.Filter {
+	clientFilterOnce.Do(func() {
+		clientFilter = &tracingFilter{
+			tracer: defaultTracer,
+			side:  clientSide,
+		}
+	})
+	return clientFilter
+}

dubbo-go/go.mod

@@ -0,0 +1,11 @@
+module github.com/SkyAPM/go2sky-plugins/dubbo-go
+
+go 1.14
+
+require (
+	dubbo.apache.org/dubbo-go/v3 v3.0.0-rc2
+	github.com/SkyAPM/go2sky v1.2.0
+	github.com/apache/dubbo-go-hessian2 v1.9.3
+	github.com/dubbogo/gost v1.11.17
+	skywalking.apache.org/repo/goapi v0.0.0-20210820070710-e10b78bbf481
+)