-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(logger): add trace context hook (#134)
* feat(logger): add trace context hook * test(logger): add context tests * fix(middleware): update example tests * chore(probes): remove coverage out * chore(logger): update version to v0.6.4 * chore(otel): uodate version to v0.1.3 * chore(camunda): uodate version to v2.0.3 * chore(middleware): uodate version to v0.3.3
- Loading branch information
Showing
12 changed files
with
164 additions
and
52 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| package logger | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "context" | ||
| "encoding/json" | ||
| "testing" | ||
|
|
||
| "go.opentelemetry.io/otel/attribute" | ||
| "go.opentelemetry.io/otel/codes" | ||
| "go.opentelemetry.io/otel/trace" | ||
| ) | ||
|
|
||
| func TestFromContext(t *testing.T) { | ||
| const ( | ||
| message = "Hello!" | ||
| appName = "test" | ||
| ) | ||
| var buf bytes.Buffer | ||
| logger := New(&buf, appName) | ||
| ctx := logger.WithContext(context.Background()) | ||
| log := FromContext(ctx) | ||
|
|
||
| log.Info().Msg(message) | ||
| var data map[string]interface{} | ||
| if err := json.Unmarshal(buf.Bytes(), &data); err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| if data["message"] != message { | ||
| t.Errorf("expected message to be '%s', got %q", message, data["message"]) | ||
| } | ||
| if data["application"] != appName { | ||
| t.Errorf("expected application to be '%s', got %q", appName, data["application"]) | ||
| } | ||
| } | ||
|
|
||
| func TestFromContext_TraceContext(t *testing.T) { | ||
| traceID := [16]byte{1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16} | ||
| spanID := [8]byte{1, 2, 3, 4, 5, 6, 7, 8} | ||
|
|
||
| ddTraceID := "651345242494996240" | ||
| ddSpanID := "72623859790382856" | ||
|
|
||
| var buf bytes.Buffer | ||
| logger := New(&buf, "test") | ||
| ctx := logger.WithContext(context.Background()) | ||
|
|
||
| span := newFakeSpan(traceID, spanID) | ||
|
|
||
| ctx = trace.ContextWithSpan(ctx, span) | ||
|
|
||
| log := FromContext(ctx) | ||
|
|
||
| log.Info().Msg("message") | ||
| var data map[string]interface{} | ||
| if err := json.Unmarshal(buf.Bytes(), &data); err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| if data["dd.trace_id"] != ddTraceID { | ||
| t.Errorf("expected dd.trace_id to be '%s', got %q", ddTraceID, data["dd.trace_id"]) | ||
| } | ||
| if data["dd.span_id"] != ddSpanID { | ||
| t.Errorf("expected dd.span_id to be '%s', got %q", ddSpanID, data["dd.span_id"]) | ||
| } | ||
| } | ||
|
|
||
| type fakeSpan struct { | ||
| Context trace.SpanContext | ||
| } | ||
|
|
||
| func newFakeSpan(traceID [16]byte, spanID [8]byte) trace.Span { | ||
| ctx := trace.NewSpanContext(trace.SpanContextConfig{ | ||
| TraceID: traceID, | ||
| SpanID: spanID, | ||
| }) | ||
|
|
||
| return fakeSpan{ | ||
| Context: ctx, | ||
| } | ||
| } | ||
|
|
||
| func (f fakeSpan) SpanContext() trace.SpanContext { return f.Context } | ||
| func (fakeSpan) IsRecording() bool { return true } | ||
| func (fakeSpan) SetStatus(codes.Code, string) {} | ||
| func (fakeSpan) SetError(bool) {} | ||
| func (fakeSpan) SetAttributes(...attribute.KeyValue) {} | ||
| func (fakeSpan) End(...trace.SpanEndOption) {} | ||
| func (fakeSpan) RecordError(error, ...trace.EventOption) {} | ||
| func (fakeSpan) AddEvent(string, ...trace.EventOption) {} | ||
| func (fakeSpan) SetName(string) {} | ||
| func (fakeSpan) TracerProvider() trace.TracerProvider { return 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
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,48 @@ | ||
| package hooks | ||
|
|
||
| import ( | ||
| "context" | ||
| "strconv" | ||
|
|
||
| "github.com/rs/zerolog" | ||
| "go.opentelemetry.io/otel/trace" | ||
| ) | ||
|
|
||
| const ( | ||
| ddTraceIDKey = "dd.trace_id" | ||
| ddSpanIDKey = "dd.span_id" | ||
| ) | ||
|
|
||
| func TraceContext(ctx context.Context) zerolog.Hook { | ||
| return &traceContextHook{ctx: ctx} | ||
| } | ||
|
|
||
| type traceContextHook struct { | ||
| ctx context.Context | ||
| } | ||
|
|
||
| func (ot *traceContextHook) Run(e *zerolog.Event, level zerolog.Level, msg string) { | ||
| span := trace.SpanFromContext(ot.ctx) | ||
| if span.IsRecording() { | ||
| spanCtx := span.SpanContext() | ||
| traceID := spanCtx.TraceID().String() | ||
| spanID := spanCtx.SpanID().String() | ||
|
|
||
| e.Str(ddTraceIDKey, convertTraceID(traceID)). | ||
| Str(ddSpanIDKey, convertTraceID(spanID)) | ||
| } | ||
| } | ||
|
|
||
| func convertTraceID(id string) string { | ||
| if len(id) < 16 { | ||
| return "" | ||
| } | ||
| if len(id) > 16 { | ||
| id = id[16:] | ||
| } | ||
| intValue, err := strconv.ParseUint(id, 16, 64) | ||
| if err != nil { | ||
| return "" | ||
| } | ||
| return strconv.FormatUint(intValue, 10) | ||
| } |
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 was deleted.
Oops, something went wrong.
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