[WIP]refactor: Log component refactoring of Cloudwego

go.mod

@@ -6,23 +6,35 @@ require (
 	github.com/apache/thrift v0.16.0 // indirect
 	github.com/bytedance/gopkg v0.0.0-20230728082804-614d0af6619b
 	github.com/cloudwego/kitex v0.9.1
-	github.com/stretchr/testify v1.8.4
+	github.com/stretchr/testify v1.9.0
 	go.opentelemetry.io/contrib/instrumentation/runtime v0.45.0
 	go.opentelemetry.io/contrib/propagators/b3 v1.20.0
 	go.opentelemetry.io/contrib/propagators/ot v1.20.0
-	go.opentelemetry.io/otel v1.19.0
+	go.opentelemetry.io/otel v1.28.0
 	go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc v0.42.0
 	go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.19.0
 	go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.19.0
-	go.opentelemetry.io/otel/metric v1.19.0
-	go.opentelemetry.io/otel/sdk v1.19.0
-	go.opentelemetry.io/otel/sdk/metric v1.19.0
-	go.opentelemetry.io/otel/trace v1.19.0
+	go.opentelemetry.io/otel/metric v1.28.0
+	go.opentelemetry.io/otel/sdk v1.28.0
+	go.opentelemetry.io/otel/sdk/metric v1.28.0
+	go.opentelemetry.io/otel/trace v1.28.0
 )
 
 require (
+	github.com/cloudwego/hertz v0.9.2
+	github.com/prometheus/client_golang v1.19.1
+	go.opentelemetry.io/otel/exporters/prometheus v0.50.0
+	go.opentelemetry.io/otel/exporters/stdout/stdouttrace v1.28.0
+	gorm.io/gorm v1.25.11
+	gorm.io/plugin/opentelemetry v0.1.4
+)
+
+require (
+	github.com/beorn7/perks v1.0.1 // indirect
+	github.com/bytedance/go-tagexpr/v2 v2.9.2 // indirect
 	github.com/bytedance/sonic v1.11.2 // indirect
 	github.com/cenkalti/backoff/v4 v4.2.1 // indirect
+	github.com/cespare/xxhash/v2 v2.3.0 // indirect
 	github.com/chenzhuoyu/base64x v0.0.0-20230717121745-296ad89f973d // indirect
 	github.com/chenzhuoyu/iasm v0.9.1 // indirect
 	github.com/choleraehyq/pid v0.0.18 // indirect
@@ -35,37 +47,48 @@ require (
 	github.com/cloudwego/thriftgo v0.3.6 // indirect
 	github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
 	github.com/fatih/structtag v1.2.0 // indirect
-	github.com/go-logr/logr v1.3.0 // indirect
+	github.com/fsnotify/fsnotify v1.5.4 // indirect
+	github.com/go-logr/logr v1.4.2 // indirect
 	github.com/go-logr/stdr v1.2.2 // indirect
 	github.com/golang/protobuf v1.5.3 // indirect
 	github.com/google/pprof v0.0.0-20230509042627-b1315fad0c5a // indirect
+	github.com/google/uuid v1.6.0 // indirect
 	github.com/grpc-ecosystem/grpc-gateway/v2 v2.18.0 // indirect
+	github.com/henrylee2cn/ameda v1.4.10 // indirect
+	github.com/henrylee2cn/goutil v0.0.0-20210127050712-89660552f6f8 // indirect
 	github.com/iancoleman/strcase v0.2.0 // indirect
 	github.com/jhump/protoreflect v1.8.2 // indirect
+	github.com/jinzhu/inflection v1.0.0 // indirect
+	github.com/jinzhu/now v1.1.5 // indirect
 	github.com/json-iterator/go v1.1.12 // indirect
 	github.com/klauspost/cpuid/v2 v2.2.4 // indirect
-	github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421 // indirect
+	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/gls v0.0.0-20220109145502-612d0167dce5 // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect
+	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
+	github.com/nyaruka/phonenumbers v1.0.55 // indirect
 	github.com/oleiade/lane v1.0.1 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
-	github.com/tidwall/gjson v1.9.3 // indirect
+	github.com/prometheus/client_model v0.6.1 // indirect
+	github.com/prometheus/common v0.55.0 // indirect
+	github.com/prometheus/procfs v0.15.1 // indirect
+	github.com/tidwall/gjson v1.14.4 // indirect
 	github.com/tidwall/match v1.1.1 // indirect
 	github.com/tidwall/pretty v1.2.0 // indirect
 	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
 	go.opentelemetry.io/otel/exporters/otlp/otlpmetric v0.42.0 // indirect
 	go.opentelemetry.io/proto/otlp v1.0.0 // indirect
 	go.uber.org/multierr v1.11.0 // indirect
 	golang.org/x/arch v0.2.0 // indirect
-	golang.org/x/net v0.17.0 // indirect
-	golang.org/x/sync v0.3.0 // indirect
-	golang.org/x/sys v0.13.0 // indirect
-	golang.org/x/text v0.13.0 // indirect
+	golang.org/x/net v0.26.0 // indirect
+	golang.org/x/sync v0.7.0 // indirect
+	golang.org/x/sys v0.21.0 // indirect
+	golang.org/x/text v0.16.0 // indirect
 	google.golang.org/genproto v0.0.0-20231012201019-e917dd12ba7a // indirect
 	google.golang.org/genproto/googleapis/api v0.0.0-20231016165738-49dd2c1f3d0b // indirect
 	google.golang.org/genproto/googleapis/rpc v0.0.0-20231016165738-49dd2c1f3d0b // indirect
 	google.golang.org/grpc v1.59.0 // indirect
-	google.golang.org/protobuf v1.31.0 // indirect
+	google.golang.org/protobuf v1.34.2 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )
 

go.work

@@ -6,7 +6,7 @@ use (
 	./logging/slog
 	./logging/zap
 	./logging/zerolog
-	tracing/hertzTracing
+
 )
 
 replace github.com/apache/thrift => github.com/apache/thrift v0.13.0

instrumentation/otelgorm/Option.go

@@ -0,0 +1,51 @@
+package otelgorm
+
+import (
+	"go.opentelemetry.io/otel/attribute"
+	semconv "go.opentelemetry.io/otel/semconv/v1.10.0"
+	"go.opentelemetry.io/otel/trace"
+)
+
+type Option func(p *otelPlugin)
+
+// WithTracerProvider configures a tracer provider that is used to create a tracer.
+func WithTracerProvider(provider trace.TracerProvider) Option {
+	return func(p *otelPlugin) {
+		p.provider = provider
+	}
+}
+
+// WithAttributes configures attributes that are used to create a span.
+func WithAttributes(attrs ...attribute.KeyValue) Option {
+	return func(p *otelPlugin) {
+		p.attrs = append(p.attrs, attrs...)
+	}
+}
+
+// WithDBName configures a db.name attribute.
+func WithDBName(name string) Option {
+	return func(p *otelPlugin) {
+		p.attrs = append(p.attrs, semconv.DBNameKey.String(name))
+	}
+}
+
+// WithoutQueryVariables configures the db.statement attribute to exclude query variables
+func WithoutQueryVariables() Option {
+	return func(p *otelPlugin) {
+		p.excludeQueryVars = true
+	}
+}
+
+// WithQueryFormatter configures a query formatter
+func WithQueryFormatter(queryFormatter func(query string) string) Option {
+	return func(p *otelPlugin) {
+		p.queryFormatter = queryFormatter
+	}
+}
+
+// WithoutMetrics prevents DBStats metrics from being reported.
+func WithoutMetrics() Option {
+	return func(p *otelPlugin) {
+		p.excludeMetrics = true
+	}
+}

instrumentation/otelgorm/mertic.go

@@ -0,0 +1,112 @@
+package otelgorm
+
+import (
+	"context"
+	"database/sql"
+
+	"go.opentelemetry.io/otel"
+	"go.opentelemetry.io/otel/metric"
+	"go.opentelemetry.io/otel/trace"
+)
+
+const instrumName = "opentelemetry/otel"
+
+type config struct {
+	tracerProvider trace.TracerProvider
+	tracer         trace.Tracer
+
+	meterProvider metric.MeterProvider
+	meter         metric.Meter
+
+	opts []metric.ObserveOption
+}
+
+func newConfig() *config {
+	c := &config{
+		tracerProvider: otel.GetTracerProvider(),
+		meterProvider:  otel.GetMeterProvider(),
+		tracer:         nil,
+		meter:          nil,
+		opts:           nil,
+	}
+	return c
+}
+
+// ReportDBStatsMetrics reports DBStats metrics using OpenTelemetry Metrics API.
+func ReportDBStatsMetrics(db *sql.DB) {
+	cfg := newConfig()
+
+	if cfg.meter == nil {
+		cfg.meter = cfg.meterProvider.Meter(instrumName)
+	}
+
+	meter := cfg.meter
+	opts := cfg.opts
+
+	maxOpenConns, _ := meter.Int64ObservableGauge(
+		"go.sql.connections_max_open",
+		metric.WithDescription("Maximum number of open connections to the database"),
+	)
+	openConns, _ := meter.Int64ObservableGauge(
+		"go.sql.connections_open",
+		metric.WithDescription("The number of established connections both in use and idle"),
+	)
+	inUseConns, _ := meter.Int64ObservableGauge(
+		"go.sql.connections_in_use",
+		metric.WithDescription("The number of connections currently in use"),
+	)
+	idleConns, _ := meter.Int64ObservableGauge(
+		"go.sql.connections_idle",
+		metric.WithDescription("The number of idle connections"),
+	)
+	connsWaitCount, _ := meter.Int64ObservableCounter(
+		"go.sql.connections_wait_count",
+		metric.WithDescription("The total number of connections waited for"),
+	)
+	connsWaitDuration, _ := meter.Int64ObservableCounter(
+		"go.sql.connections_wait_duration",
+		metric.WithDescription("The total time blocked waiting for a new connection"),
+		metric.WithUnit("nanoseconds"),
+	)
+	connsClosedMaxIdle, _ := meter.Int64ObservableCounter(
+		"go.sql.connections_closed_max_idle",
+		metric.WithDescription("The total number of connections closed due to SetMaxIdleConns"),
+	)
+	connsClosedMaxIdleTime, _ := meter.Int64ObservableCounter(
+		"go.sql.connections_closed_max_idle_time",
+		metric.WithDescription("The total number of connections closed due to SetConnMaxIdleTime"),
+	)
+	connsClosedMaxLifetime, _ := meter.Int64ObservableCounter(
+		"go.sql.connections_closed_max_lifetime",
+		metric.WithDescription("The total number of connections closed due to SetConnMaxLifetime"),
+	)
+
+	_, err := meter.RegisterCallback(
+		func(ctx context.Context, o metric.Observer) error {
+			stats := db.Stats()
+
+			o.ObserveInt64(maxOpenConns, int64(stats.MaxOpenConnections), opts...)
+			o.ObserveInt64(openConns, int64(stats.OpenConnections), opts...)
+			o.ObserveInt64(inUseConns, int64(stats.InUse), opts...)
+			o.ObserveInt64(idleConns, int64(stats.Idle), opts...)
+			o.ObserveInt64(connsWaitCount, stats.WaitCount, opts...)
+			o.ObserveInt64(connsWaitDuration, int64(stats.WaitDuration), opts...)
+			o.ObserveInt64(connsClosedMaxIdle, stats.MaxIdleClosed, opts...)
+			o.ObserveInt64(connsClosedMaxIdleTime, stats.MaxIdleTimeClosed, opts...)
+			o.ObserveInt64(connsClosedMaxLifetime, stats.MaxLifetimeClosed, opts...)
+			return nil
+		},
+		maxOpenConns,
+		openConns,
+		inUseConns,
+		idleConns,
+		connsWaitCount,
+		connsWaitDuration,
+		connsClosedMaxIdle,
+		connsClosedMaxIdleTime,
+		connsClosedMaxLifetime,
+	)
+	if err != nil {
+		panic(err)
+	}
+}