-
Notifications
You must be signed in to change notification settings - Fork 68
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding support for opentelemetry tracer along with opentracing
- Loading branch information
1 parent
76984b2
commit 6e769aa
Showing
7 changed files
with
257 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| package spanlogger | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "reflect" | ||
|
|
||
| "github.com/go-kit/log" | ||
| "github.com/go-kit/log/level" | ||
| "go.opentelemetry.io/otel/attribute" | ||
| "go.opentelemetry.io/otel/codes" | ||
| "go.opentelemetry.io/otel/trace" | ||
| ) | ||
|
|
||
| type OtelSpanLogger struct { | ||
| log.Logger | ||
| trace.Span | ||
| sampled bool | ||
| } | ||
|
|
||
| func OtelNew(ctx context.Context, tr trace.Tracer, logger log.Logger, method string, resolver TenantResolver, kvps ...interface{}) (*OtelSpanLogger, context.Context) { | ||
| ctx, sp := tr.Start(ctx, method) | ||
| defer sp.End() | ||
| if ids, err := resolver.TenantIDs(ctx); err == nil && len(ids) > 0 { | ||
| sp.SetAttributes(attribute.StringSlice(TenantIDsTagName, ids)) | ||
| } | ||
| lwc, sampled := withContext(ctx, logger, resolver, true) | ||
| l := &OtelSpanLogger{ | ||
| Logger: log.With(lwc, "method", method), | ||
| Span: sp, | ||
| sampled: sampled, | ||
| } | ||
| if len(kvps) > 0 { | ||
| level.Debug(l).Log(kvps...) | ||
| } | ||
|
|
||
| ctx = context.WithValue(ctx, loggerCtxKey, logger) | ||
| return l, ctx | ||
| } | ||
|
|
||
| func OtelFromContext(ctx context.Context, fallback log.Logger, resolver TenantResolver) *OtelSpanLogger { | ||
| logger, ok := ctx.Value(loggerCtxKey).(log.Logger) | ||
| if !ok { | ||
| logger = fallback | ||
| } | ||
| sp := trace.SpanFromContext(ctx) | ||
| lwc, sampled := withContext(ctx, logger, resolver, true) | ||
| return &OtelSpanLogger{ | ||
| Logger: lwc, | ||
| Span: sp, | ||
| sampled: sampled, | ||
| } | ||
| } | ||
|
|
||
| func (s *OtelSpanLogger) Log(kvps ...interface{}) error { | ||
| s.Logger.Log(kvps...) | ||
| if !s.sampled { | ||
| return nil | ||
| } | ||
| fields, err := convertKVToAttributes(kvps...) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| s.AddEvent("log", trace.WithAttributes(fields...)) | ||
| return nil | ||
| } | ||
|
|
||
| func (s *OtelSpanLogger) Error(err error) error { | ||
| if err == nil || !s.sampled { | ||
| return err | ||
| } | ||
| s.Span.SetStatus(codes.Error, "") | ||
| s.Span.RecordError(err) | ||
| return err | ||
| } | ||
|
|
||
| // convertKVToAttributes converts keyValues to a slice of attribute.KeyValue | ||
| func convertKVToAttributes(keyValues ...interface{}) ([]attribute.KeyValue, error) { | ||
| if len(keyValues)%2 != 0 { | ||
| return nil, fmt.Errorf("non-even keyValues len: %d", len(keyValues)) | ||
| } | ||
| fields := make([]attribute.KeyValue, len(keyValues)/2) | ||
| for i := 0; i*2 < len(keyValues); i++ { | ||
| key, ok := keyValues[i*2].(string) | ||
| if !ok { | ||
| return nil, fmt.Errorf("non-string key (pair #%d): %T", i, keyValues[i*2]) | ||
| } | ||
| value := keyValues[i*2+1] | ||
| typedVal := reflect.ValueOf(value) | ||
|
|
||
| switch typedVal.Kind() { | ||
| case reflect.Bool: | ||
| fields[i] = attribute.Bool(key, typedVal.Bool()) | ||
| case reflect.String: | ||
| fields[i] = attribute.String(key, typedVal.String()) | ||
| case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64: | ||
| fields[i] = attribute.Int(key, int(typedVal.Int())) | ||
| case reflect.Float32, reflect.Float64: | ||
| fields[i] = attribute.Float64(key, typedVal.Float()) | ||
| default: | ||
| if typedVal.Kind() == reflect.Ptr && typedVal.IsNil() { | ||
| fields[i] = attribute.String(key, "nil") | ||
| continue | ||
| } | ||
| // When in doubt, coerce to a string | ||
| fields[i] = attribute.String(key, fmt.Sprintf("%v", value)) | ||
| } | ||
| } | ||
| return fields, nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| package spanlogger | ||
|
|
||
| import ( | ||
| "context" | ||
| "testing" | ||
|
|
||
| "github.com/go-kit/log" | ||
| "github.com/pkg/errors" | ||
| "github.com/stretchr/testify/require" | ||
| "github.com/weaveworks/common/user" | ||
| "go.opentelemetry.io/otel" | ||
| "go.opentelemetry.io/otel/attribute" | ||
| sdktrace "go.opentelemetry.io/otel/sdk/trace" | ||
| "go.opentelemetry.io/otel/sdk/trace/tracetest" | ||
| ) | ||
|
|
||
| func TestOtelSpanLogger_Log(t *testing.T) { | ||
| logger := log.NewNopLogger() | ||
| resolver := fakeResolver{} | ||
| tp := sdktrace.NewTracerProvider( | ||
| sdktrace.WithBatcher(tracetest.NewInMemoryExporter()), | ||
| ) | ||
| span, ctx := OtelNew(context.Background(), tp.Tracer("test"), logger, "test", resolver, "bar") | ||
| defer span.End() | ||
| _ = span.Log("foo") | ||
| newSpan := OtelFromContext(ctx, logger, resolver) | ||
| require.Equal(t, span.Span, newSpan.Span) | ||
| _ = newSpan.Log("bar") | ||
| noSpan := OtelFromContext(context.Background(), logger, resolver) | ||
| _ = noSpan.Log("foo") | ||
| require.Error(t, noSpan.Error(errors.New("err"))) | ||
| require.NoError(t, noSpan.Error(nil)) | ||
| } | ||
|
|
||
| func TestOtelSpanLogger_CustomLogger(t *testing.T) { | ||
| var logged [][]interface{} | ||
| var logger funcLogger = func(keyvals ...interface{}) error { | ||
| logged = append(logged, keyvals) | ||
| return nil | ||
| } | ||
| resolver := fakeResolver{} | ||
| exp := tracetest.NewNoopExporter() | ||
| tp := sdktrace.NewTracerProvider( | ||
| sdktrace.WithBatcher(exp), | ||
| // Set the sampler to never sample so that traceID is not logged. | ||
| sdktrace.WithSampler(sdktrace.NeverSample()), | ||
| ) | ||
| span, ctx := OtelNew(context.Background(), tp.Tracer("test"), logger, "test", resolver) | ||
| _ = span.Log("msg", "original spanlogger") | ||
|
|
||
| span = OtelFromContext(ctx, log.NewNopLogger(), resolver) | ||
| _ = span.Log("msg", "restored spanlogger") | ||
|
|
||
| span = OtelFromContext(context.Background(), logger, resolver) | ||
| _ = span.Log("msg", "fallback spanlogger") | ||
|
|
||
| expect := [][]interface{}{ | ||
| {"method", "test", "msg", "original spanlogger"}, | ||
| {"msg", "restored spanlogger"}, | ||
| {"msg", "fallback spanlogger"}, | ||
| } | ||
|
|
||
| require.Equal(t, expect, logged) | ||
| } | ||
|
|
||
| func TestOtelSpanCreatedWithTenantTag(t *testing.T) { | ||
| exp, sp := createOtelSpan(user.InjectOrgID(context.Background(), "team-a")) | ||
| defer sp.End() | ||
|
|
||
| require.Equal(t, 1, len(exp.GetSpans().Snapshots())) | ||
| require.Equal(t, | ||
| []attribute.KeyValue{attribute.StringSlice(TenantIDsTagName, []string{"team-a"})}, | ||
| exp.GetSpans().Snapshots()[0].Attributes()) | ||
| } | ||
|
|
||
| func TestOtelSpanCreatedWithoutTenantTag(t *testing.T) { | ||
| exp, sp := createOtelSpan(context.Background()) | ||
| defer sp.End() | ||
| require.Equal(t, 1, len(exp.GetSpans().Snapshots())) | ||
|
|
||
| exist := false | ||
| for _, kv := range exp.GetSpans().Snapshots()[0].Attributes() { | ||
| if kv.Key == TenantIDsTagName { | ||
| exist = true | ||
| } | ||
| } | ||
| require.False(t, exist) | ||
| } | ||
|
|
||
| // Using a no-op logger and no tracing provider, measure the overhead of a small log call. | ||
| func BenchmarkOtelSpanLogger(b *testing.B) { | ||
| _, sl := createOtelSpan(context.Background()) | ||
| b.ResetTimer() | ||
| for i := 0; i < b.N; i++ { | ||
| _ = sl.Log("msg", "foo", "more", "data") | ||
| } | ||
| } | ||
|
|
||
| func createOtelSpan(ctx context.Context) (*tracetest.InMemoryExporter, *OtelSpanLogger) { | ||
| exp := tracetest.NewInMemoryExporter() | ||
| tp := sdktrace.NewTracerProvider( | ||
| sdktrace.WithBatcher(exp), | ||
| ) | ||
| otel.SetTracerProvider(tp) | ||
| tt := tp.Tracer("test") | ||
|
|
||
| sl, _ := OtelNew(ctx, tt, log.NewNopLogger(), "get", fakeResolver{}) | ||
| // Force flush to ensure spans are reported before the test ends. | ||
| tp.ForceFlush(ctx) | ||
| return exp, sl | ||
| } |
Oops, something went wrong.