feat: optimize the integration of otel tracing

filter/otel/trace/version.go → common/constant/otel.go

@@ -15,18 +15,9 @@
  * limitations under the License.
  */
 
-package trace
+package constant
 
-import (
-	"dubbo.apache.org/dubbo-go/v3/common/constant"
+const (
+	OtelPackageName    = "go.opentelemetry.io/otel"
+	OtelPackageVersion = "v1.10.0"
 )
-
-// Version is the current release version of the dubbogo instrumentation.
-func Version() string {
-	return constant.Version
-}
-
-// SemVersion is the semantic version to be supplied to tracer/meter creation.
-func SemVersion() string {
-	return "semver:" + Version()
-}

common/extension/otel_trace.go

@@ -0,0 +1,58 @@
+/*
+ * 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.
+ */
+
+package extension
+
+import (
+	"context"
+)
+
+import (
+	"dubbo.apache.org/dubbo-go/v3/otel/trace"
+)
+
+import (
+	"github.com/dubbogo/gost/log/logger"
+)
+
+var traceExporterMap = make(map[string]func(config *trace.ExporterConfig) (trace.Exporter, error), 4)
+
+func SetTraceExporter(name string, createFunc func(config *trace.ExporterConfig) (trace.Exporter, error)) {
+	traceExporterMap[name] = createFunc
+}
+
+func GetTraceExporter(name string, config *trace.ExporterConfig) (trace.Exporter, error) {
+	createFunc, ok := traceExporterMap[name]
+	if !ok {
+		panic("Cannot find the trace provider with name " + name)
+	}
+	return createFunc(config)
+}
+
+func GetTraceShutdownCallback() func() {
+	return func() {
+		for name, createFunc := range traceExporterMap {
+			if exporter, err := createFunc(nil); err == nil {
+				if err := exporter.GetTracerProvider().Shutdown(context.Background()); err != nil {
+					logger.Errorf("Graceful shutdown --- Failed to shutdown trace provider %s, error: %s", name, err.Error())
+				} else {
+					logger.Infof("Graceful shutdown --- Tracer provider of %s", name)
+				}
+			}
+		}
+	}
+}

config/otel_config.go

@@ -0,0 +1,115 @@
+/*
+ * 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.
+ */
+
+package config
+
+import (
+	"github.com/creasty/defaults"
+	"github.com/dubbogo/gost/log/logger"
+	"github.com/pkg/errors"
+	"go.opentelemetry.io/otel"
+)
+
+import (
+	"dubbo.apache.org/dubbo-go/v3/common/extension"
+	"dubbo.apache.org/dubbo-go/v3/otel/trace"
+)
+
+type OtelConfig struct {
+	TraceConfig *OtelTraceConfig `yaml:"trace" json:"trace,omitempty" property:"trace"`
+}
+
+type OtelTraceConfig struct {
+	Enable      *bool   `default:"false" yaml:"enable" json:"enable,omitempty" property:"enable"`
+	Exporter    string  `default:"stdout" yaml:"exporter" json:"exporter,omitempty" property:"exporter"` // stdout, jaeger, zipkin, otlp-http, otlp-grpc
+	Endpoint    string  `default:"" yaml:"endpoint" json:"endpoint,omitempty" property:"endpoint"`
+	Propagator  string  `default:"w3c" yaml:"propagator" json:"propagator,omitempty" property:"propagator"`       // one of w3c(standard), b3(for zipkin),
+	SampleMode  string  `default:"ratio" yaml:"sample-mode" json:"sample-mode,omitempty" property:"sample-mode"`  // one of always, never, ratio
+	SampleRatio float64 `default:"0.5" yaml:"sample-ratio" json:"sample-ratio,omitempty" property:"sample-ratio"` // [0.0, 1.0]
+}
+
+func (oc *OtelConfig) Init(appConfig *ApplicationConfig) error {
+	if oc == nil {
+		return errors.New("otel config is nil")
+	}
+	if err := defaults.Set(oc); err != nil {
+		return err
+	}
+	if err := verify(oc); err != nil {
+		return err
+	}
+	if *oc.TraceConfig.Enable {
+		extension.AddCustomShutdownCallback(extension.GetTraceShutdownCallback())
+		return oc.TraceConfig.init(appConfig)
+	}
+
+	return nil
+}
+
+func (c *OtelTraceConfig) init(appConfig *ApplicationConfig) error {
+	exporter, err := extension.GetTraceExporter(c.Exporter, c.toTraceProviderConfig(appConfig))
+	if err != nil {
+		return err
+	}
+	otel.SetTracerProvider(exporter.GetTracerProvider())
+	otel.SetTextMapPropagator(exporter.GetPropagator())
+
+	// print trace exporter configuration
+	if c.Exporter == "stdout" {
+		logger.Infof("enable %s trace provider with propagator: %s", c.Exporter, c.Propagator)
+	} else {
+		logger.Infof("enable %s trace provider with endpoint: %s, propagator: %s", c.Exporter, c.Endpoint, c.Propagator)
+	}
+	logger.Infof("sample mode: %s", c.SampleMode)
+	if c.SampleMode == "ratio" {
+		logger.Infof("sample ratio: %.2f", c.SampleRatio)
+	}
+
+	return nil
+}
+
+func (c *OtelTraceConfig) toTraceProviderConfig(a *ApplicationConfig) *trace.ExporterConfig {
+	tpc := &trace.ExporterConfig{
+		Exporter:         c.Exporter,
+		Endpoint:         c.Endpoint,
+		SampleMode:       c.SampleMode,
+		SampleRatio:      c.SampleRatio,
+		Propagator:       c.Propagator,
+		ServiceNamespace: a.Organization,
+		ServiceName:      a.Name,
+		ServiceVersion:   a.Version,
+	}
+	return tpc
+}
+
+type OtelConfigBuilder struct {
+	otelConfig *OtelConfig
+}
+
+func NewOtelConfigBuilder() *OtelConfigBuilder {
+	return &OtelConfigBuilder{
+		otelConfig: &OtelConfig{
+			TraceConfig: &OtelTraceConfig{},
+		},
+	}
+}
+
+func (ocb *OtelConfigBuilder) Build() *OtelConfig {
+	return ocb.otelConfig
+}
+
+// TODO: dynamic config

filter/otel/trace/version_test.go → config/otel_config_test.go

@@ -15,49 +15,25 @@
  * limitations under the License.
  */
 
-package trace
+package config
 
 import (
 	"testing"
 )
 
 import (
-	"dubbo.apache.org/dubbo-go/v3/common/constant"
+	"github.com/stretchr/testify/assert"
 )
 
-type filed struct {
-	name string
-	want string
-}
+func TestNewOtelConfigBuilder(t *testing.T) {
+	config := NewOtelConfigBuilder().Build()
+	assert.NotNil(t, config)
+	assert.NotNil(t, config.TraceConfig)
 
-func TestSemVersion(t *testing.T) {
-	tests := []filed{
-		{
-			name: "test",
-			want: "semver:" + constant.Version,
-		},
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			if got := SemVersion(); got != tt.want {
-				t.Errorf("SemVersion() = %v, want %v", got, tt.want)
-			}
-		})
-	}
-}
+	ac := NewApplicationConfigBuilder().Build()
+	err := config.Init(ac)
+	assert.NoError(t, err)
 
-func TestVersion(t *testing.T) {
-	tests := []filed{
-		{
-			name: "test",
-			want: constant.Version,
-		},
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			if got := Version(); got != tt.want {
-				t.Errorf("Version() = %v, want %v", got, tt.want)
-			}
-		})
-	}
+	tpc := config.TraceConfig.toTraceProviderConfig(ac)
+	assert.NotNil(t, tpc)
 }

config/root_config.go

@@ -55,6 +55,7 @@ type RootConfig struct {
 	MetadataReport      *MetadataReportConfig      `yaml:"metadata-report" json:"metadata-report,omitempty" property:"metadata-report"`
 	Provider            *ProviderConfig            `yaml:"provider" json:"provider" property:"provider"`
 	Consumer            *ConsumerConfig            `yaml:"consumer" json:"consumer" property:"consumer"`
+	Otel                *OtelConfig                `yaml:"otel" json:"otel,omitempty" property:"otel"`
 	Metric              *MetricConfig              `yaml:"metrics" json:"metrics,omitempty" property:"metrics"`
 	Tracing             map[string]*TracingConfig  `yaml:"tracing" json:"tracing,omitempty" property:"tracing"`
 	Logger              *LoggerConfig              `yaml:"logger" json:"logger,omitempty" property:"logger"`
@@ -178,6 +179,9 @@ func (rc *RootConfig) Init() error {
 	if err := rc.MetadataReport.Init(rc); err != nil {
 		return err
 	}
+	if err := rc.Otel.Init(rc.Application); err != nil {
+		return err
+	}
 	if err := rc.Metric.Init(); err != nil {
 		return err
 	}
@@ -227,6 +231,7 @@ func newEmptyRootConfig() *RootConfig {
 		Tracing:        make(map[string]*TracingConfig),
 		Provider:       NewProviderConfigBuilder().Build(),
 		Consumer:       NewConsumerConfigBuilder().Build(),
+		Otel:           NewOtelConfigBuilder().Build(),
 		Metric:         NewMetricConfigBuilder().Build(),
 		Logger:         NewLoggerConfigBuilder().Build(),
 		Custom:         NewCustomConfigBuilder().Build(),
@@ -284,6 +289,11 @@ func (rb *RootConfigBuilder) SetConsumer(consumer *ConsumerConfig) *RootConfigBu
 	return rb
 }
 
+func (rb *RootConfigBuilder) SetOtel(otel *OtelConfig) *RootConfigBuilder {
+	rb.rootConfig.Otel = otel
+	return rb
+}
+
 func (rb *RootConfigBuilder) SetMetric(metric *MetricConfig) *RootConfigBuilder {
 	rb.rootConfig.Metric = metric
 	return rb

filter/otel/trace/attachment.go

@@ -73,7 +73,7 @@ func Inject(ctx context.Context, metadata map[string]interface{}, propagators pr
 	})
 }
 
-// Extract returns the correlation context and span context that
+// Extract returns the baggage and span context that
 // another service encoded in the dubbo metadata object with Inject.
 // This function is meant to be used on incoming requests.
 func Extract(ctx context.Context, metadata map[string]interface{}, propagators propagation.TextMapPropagator) (baggage.Baggage, trace.SpanContext) {

filter/otel/trace/filter.go

@@ -37,11 +37,8 @@ import (
 	"dubbo.apache.org/dubbo-go/v3/protocol"
 )
 
-const (
-	instrumentationName = "dubbo.apache.org/dubbo-go/v3/oteldubbo"
-)
-
 func init() {
+	// TODO: use single filter to simplify filter field in configuration
 	extension.SetFilter(constant.OTELServerTraceKey, func() filter.Filter {
 		return &otelServerFilter{
 			Propagators:    otel.GetTextMapPropagator(),
@@ -71,8 +68,8 @@ func (f *otelServerFilter) Invoke(ctx context.Context, invoker protocol.Invoker,
 	ctx = baggage.ContextWithBaggage(ctx, bags)
 
 	tracer := f.TracerProvider.Tracer(
-		instrumentationName,
-		trace.WithInstrumentationVersion(SemVersion()),
+		constant.OtelPackageName,
+		trace.WithInstrumentationVersion(constant.OtelPackageVersion),
 	)
 
 	ctx, span := tracer.Start(
@@ -108,8 +105,8 @@ func (f *otelClientFilter) OnResponse(ctx context.Context, result protocol.Resul
 
 func (f *otelClientFilter) Invoke(ctx context.Context, invoker protocol.Invoker, invocation protocol.Invocation) protocol.Result {
 	tracer := f.TracerProvider.Tracer(
-		instrumentationName,
-		trace.WithInstrumentationVersion(SemVersion()),
+		constant.OtelPackageName,
+		trace.WithInstrumentationVersion(constant.OtelPackageVersion),
 	)
 
 	var span trace.Span