logotel/add log field prefix;

bunrouterotel/go.mod

@@ -3,7 +3,7 @@ module git.blauwelle.com/go/crate/bunrouterotel
 go 1.21.1
 
 require (
-	github.com/uptrace/bunrouter v1.0.20
+	github.com/uptrace/bunrouter v1.0.21
 	go.opentelemetry.io/otel v1.21.0
 	go.opentelemetry.io/otel/trace v1.21.0
 )

bunrouterotel/go.sum

@@ -1,32 +1,22 @@
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=
-github.com/go-logr/logr v1.2.4 h1:g01GSCwiDw2xSZfjJ2/T9M+S6pFdcNtFYsp+Y43HYDQ=
-github.com/go-logr/logr v1.2.4/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=
-github.com/go-logr/logr v1.3.0 h1:2y3SDp0ZXuc6/cjLSZ+Q3ir+QB9T/iG5yYRXqsagWSY=
-github.com/go-logr/logr v1.3.0/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=
 github.com/go-logr/logr v1.4.1 h1:pKouT5E8xu9zeFC39JXRDukb6JFQPXM5p5I91188VAQ=
 github.com/go-logr/logr v1.4.1/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY=
 github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=
 github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=
-github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38=
-github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
+github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
+github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
 github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
-github.com/uptrace/bunrouter v1.0.20 h1:jNvYNcJxF+lSYBQAaQjnE6I11Zs0m+3M5Ek7fq/Tp4c=
-github.com/uptrace/bunrouter v1.0.20/go.mod h1:TwT7Bc0ztF2Z2q/ZzMuSVkcb/Ig/d3MQeP2cxn3e1hI=
-go.opentelemetry.io/otel v1.19.0 h1:MuS/TNf4/j4IXsZuJegVzI1cwut7Qc00344rgH7p8bs=
-go.opentelemetry.io/otel v1.19.0/go.mod h1:i0QyjOq3UPoTzff0PJB2N66fb4S0+rSbSB15/oyH9fY=
+github.com/uptrace/bunrouter v1.0.21 h1:HXarvX+N834sXyHpl+I/TuE11m19kLW/qG5u3YpHUag=
+github.com/uptrace/bunrouter v1.0.21/go.mod h1:TwT7Bc0ztF2Z2q/ZzMuSVkcb/Ig/d3MQeP2cxn3e1hI=
 go.opentelemetry.io/otel v1.21.0 h1:hzLeKBZEL7Okw2mGzZ0cc4k/A7Fta0uoPgaJCr8fsFc=
 go.opentelemetry.io/otel v1.21.0/go.mod h1:QZzNPQPm1zLX4gZK4cMi+71eaorMSGT3A4znnUvNNEo=
-go.opentelemetry.io/otel/metric v1.19.0 h1:aTzpGtV0ar9wlV4Sna9sdJyII5jTVJEvKETPiOKwvpE=
-go.opentelemetry.io/otel/metric v1.19.0/go.mod h1:L5rUsV9kM1IxCj1MmSdS+JQAcVm319EUrDVLrt7jqt8=
 go.opentelemetry.io/otel/metric v1.21.0 h1:tlYWfeo+Bocx5kLEloTjbcDwBuELRrIFxwdQ36PlJu4=
 go.opentelemetry.io/otel/metric v1.21.0/go.mod h1:o1p3CA8nNHW8j5yuQLdc1eeqEaPfzug24uvsyIEJRWM=
-go.opentelemetry.io/otel/trace v1.19.0 h1:DFVQmlVbfVeOuBRrwdtaehRrWiL1JoVs9CPIQ1Dzxpg=
-go.opentelemetry.io/otel/trace v1.19.0/go.mod h1:mfaSyvGyEJEI0nyV2I4qhNQnbBOUUmYZpYojqMnX2vo=
 go.opentelemetry.io/otel/trace v1.21.0 h1:WD9i5gzvoUPuXIXH24ZNBudiarZDKuekPqi/E8fpfLc=
 go.opentelemetry.io/otel/trace v1.21.0/go.mod h1:LGbsEB0f9LGjN+OZaQQ26sohbOmiMR+BaslueVtS/qQ=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=

bunrouterotel/middleware.go

@@ -2,6 +2,7 @@ package bunrouterotel
 
 import (
 	"net/http"
+	"strings"
 
 	"github.com/uptrace/bunrouter"
 	"go.opentelemetry.io/otel"
@@ -13,9 +14,11 @@ import (
 
 const (
 	tracerName = "git.blauwelle.com/go/crate/bunrouterotel"
-	version    = "0.2.0"
+	version    = "0.5.0"
 )
 
+var tracer = otel.Tracer(tracerName, trace.WithInstrumentationVersion("semver:"+version))
+
 type config struct {
 	propagators propagation.TextMapPropagator
 }
@@ -36,6 +39,15 @@ func WithPropagators(propagators propagation.TextMapPropagator) Option {
 	})
 }
 
+func getForwardedFor(r *http.Request) []string {
+	h := r.Header.Get("X-Forwarded-For")
+	a := strings.Split(h, ",")
+	for i, s := range a {
+		a[i] = strings.Trim(s, " \t")
+	}
+	return a
+}
+
 // Middleware create a span, which record the request,
 // HTTP status code is NOT recorded.
 func Middleware(serverName string, opts ...Option) bunrouter.MiddlewareFunc {
@@ -46,7 +58,6 @@ func Middleware(serverName string, opts ...Option) bunrouter.MiddlewareFunc {
 	if cfg.propagators == nil {
 		cfg.propagators = otel.GetTextMapPropagator()
 	}
-	tracer := otel.Tracer(tracerName, trace.WithInstrumentationVersion("semver:"+version))
 	return func(next bunrouter.HandlerFunc) bunrouter.HandlerFunc {
 		return func(w http.ResponseWriter, req bunrouter.Request) error {
 			ctx := cfg.propagators.Extract(req.Context(), propagation.HeaderCarrier(req.Header))
@@ -75,6 +86,10 @@ func Middleware(serverName string, opts ...Option) bunrouter.MiddlewareFunc {
 				attrs = append(attrs, attribute.String("http.route.param."+param.Key, param.Value))
 			}
 			span.SetAttributes(attrs...)
+			forwardedFor := getForwardedFor(req.Request)
+			if forwardedFor != nil {
+				span.SetAttributes(attribute.StringSlice("http.forward_route", forwardedFor))
+			}
 			defer span.End()
 			return next(w, req)
 		}

logotel/processor.go

@@ -16,6 +16,14 @@ import (
 	"go.opentelemetry.io/otel/trace"
 )
 
+const (
+	fieldPrefix = "log.field."
+)
+
+var (
+	tracer = otel.Tracer(tracerName, trace.WithInstrumentationVersion("semver:"+version))
+)
+
 // New 创建 log/opentelemetry 处理器
 func New(opts ...Option) *Processor {
 	cfg := newConfig(opts...)
@@ -41,7 +49,7 @@ func (processor *Processor) Process(ctx context.Context, entry logsdk.ReadonlyEn
 			if name == "" {
 				name = "default"
 			}
-			ctx, span = otel.Tracer("git.blauwelle.com/go/crate/logotel").Start(ctx, name) //nolint:ineffassign,staticcheck,wastedassign
+			ctx, span = tracer.Start(ctx, name) //nolint:ineffassign,staticcheck,wastedassign
 			defer span.End()
 		}
 	}
@@ -70,7 +78,7 @@ func (processor *Processor) Process(ctx context.Context, entry logsdk.ReadonlyEn
 			buf.WriteByte('\n')
 		}
 		processor.bufferPool.Put(buf)
-		attrs = append(attrs, attribute.String("zz.stack", buf.String()))
+		attrs = append(attrs, attribute.String("log.stack", buf.String()))
 	}
 	for _, field := range entry.Fields {
 		attrs = append(attrs, fieldToKV(field))
@@ -84,22 +92,22 @@ func (processor *Processor) Process(ctx context.Context, entry logsdk.ReadonlyEn
 func fieldToKV(field logsdk.KV) attribute.KeyValue {
 	switch value := field.Value.(type) {
 	case nil:
-		return attribute.String(field.Key, "<nil>")
+		return attribute.String(fieldPrefix+field.Key, "<nil>")
 	case string:
-		return attribute.String(field.Key, value)
+		return attribute.String(fieldPrefix+field.Key, value)
 	case int:
-		return attribute.Int(field.Key, value)
+		return attribute.Int(fieldPrefix+field.Key, value)
 	case int64:
-		return attribute.Int64(field.Key, value)
+		return attribute.Int64(fieldPrefix+field.Key, value)
 	case float64:
-		return attribute.Float64(field.Key, value)
+		return attribute.Float64(fieldPrefix+field.Key, value)
 	case bool:
-		return attribute.Bool(field.Key, value)
+		return attribute.Bool(fieldPrefix+field.Key, value)
 	case error:
-		return attribute.String(field.Key, value.Error())
+		return attribute.String(fieldPrefix+field.Key, value.Error())
 	case fmt.Stringer:
-		return attribute.String(field.Key, value.String())
+		return attribute.String(fieldPrefix+field.Key, value.String())
 	}
 
-	return attribute.String(field.Key, fmt.Sprint(field.Value))
+	return attribute.String(fieldPrefix+field.Key, fmt.Sprint(field.Value))
 }

logotel/version.go

@@ -0,0 +1,6 @@
+package logotel
+
+const (
+	tracerName = "git.blauwelle.com/go/crate/logotel"
+	version    = "0.14.0"
+)