Merge pull request #63 from snabble/more-tracing

Pull in tracing functionality from tchibo-integration

Author: tnicolaisen-snabble

go.mod

@@ -17,8 +17,9 @@ require (
 	github.com/felixge/httpsnoop v1.0.3 // indirect
 	github.com/go-logr/logr v1.2.3 // indirect
 	github.com/go-logr/stdr v1.2.2 // indirect
-	github.com/kr/text v0.2.0 // indirect
+	github.com/kr/pretty v0.3.0 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/rogpeppe/go-internal v1.9.0 // indirect
 	github.com/uptrace/opentelemetry-go-extra/otelutil v0.1.20 // indirect
 	go.opentelemetry.io/otel/metric v0.35.0 // indirect
 	golang.org/x/sys v0.4.0 // indirect

go.sum

@@ -10,14 +10,15 @@ github.com/go-logr/logr v1.2.3/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbV
 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/kr/pretty v0.2.1 h1:Fmg33tUaq4/8ym9TJN1x7sLJnHVwhP33CNkpYV/7rwI=
 github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
+github.com/kr/pretty v0.3.0 h1:WgNl7dwNpEZ6jJ9k1snq4pZsg7DOEN8hP9Xw0Tsjwk0=
 github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
 github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
 github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
 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/rogpeppe/go-internal v1.9.0 h1:73kH8U+JUqXU8lRuOHeVHaa/SZPifC7BkcraZVejAe8=
 github.com/sirupsen/logrus v1.9.0 h1:trlNQbNUG3OdDrDil03MCb1H2o9nJ1x4/5LYw7byDE0=
 github.com/sirupsen/logrus v1.9.0/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=

tracex/trace.go

@@ -17,6 +17,12 @@ func TraceAndSpan(ctx context.Context, fields logrus.Fields) {
 	}
 }
 
+// BackgroundContextWithSpan creates a new context with the same span as ctx.
+// This is useful for tracing functions that should not be interrupted if the caller cancels or times out.
+func BackgroundContextWithSpan(ctx context.Context) context.Context {
+	return trace.ContextWithSpan(context.Background(), trace.SpanFromContext(ctx))
+}
+
 type Tracer = trace.Tracer
 
 // GetTracer returns the default otel tracer. You probably want to use NewTracerProvider instead.

tracex/trace_test.go

@@ -0,0 +1,21 @@
+package tracex
+
+import (
+	"context"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"go.opentelemetry.io/otel/trace"
+)
+
+func Test_BackgroundContextWithSpan(t *testing.T) {
+	originalContextWithCancel, cancel := context.WithCancel(context.Background())
+	originalCtx, originalSpan := trace.NewNoopTracerProvider().Tracer("").Start(originalContextWithCancel, "spanName")
+	newCtxWithSameSpan := BackgroundContextWithSpan(originalCtx)
+	trace.SpanContextFromContext(newCtxWithSameSpan).Equal(originalSpan.SpanContext())
+
+	cancel()
+	assert.NotNil(t, originalCtx.Err())
+
+	assert.Nil(t, newCtxWithSameSpan.Err())
+}