Skip to content

otel: add WithSpanIDField option to Logrus hook #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
thaJeztah wants to merge 1 commit into
base: main
Choose a base branch
from
Open

otel: add WithSpanIDField option to Logrus hook #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions otel/log.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,14 @@ func WithTraceIDField(enabled bool) HookOpt {
}
}

// WithSpanIDField configures the hook to add the span ID of the active span
// to log entries.
func WithSpanIDField(enabled bool) HookOpt {
return func(h *LogrusHook) {
h.enableSpanIDField = enabled
}
}

// WithLevel configures the minimum log level handled by the hook.
// Entries below this level are ignored.
func WithLevel(level log.Level) HookOpt {
Expand Down Expand Up @@ -90,6 +98,7 @@ func WithErrorStatusLevel(level log.Level) HookOpt {
// [logrus.Hook]: https://github.com/sirupsen/logrus/blob/v1.9.3/hooks.go#L3-L11
type LogrusHook struct {
enableTraceIDField bool
enableSpanIDField bool
errorStatusLevel *log.Level
levels []log.Level
}
Expand Down Expand Up @@ -117,6 +126,9 @@ func (h *LogrusHook) Fire(entry *log.Entry) error {
if h.enableTraceIDField {
entry.Data["trace_id"] = spanCtx.TraceID().String()
}
if h.enableSpanIDField {
entry.Data["span_id"] = spanCtx.SpanID().String()
}

if !span.IsRecording() {
return nil
Expand Down
60 changes: 47 additions & 13 deletions otel/log_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,10 @@ import (
"go.opentelemetry.io/otel/trace"
)

const expectedTraceIDStr = "0102030405060708090a0b0c0d0e0f10"
const (
expectedTraceIDStr = "0102030405060708090a0b0c0d0e0f10"
expectedSpanIDStr = "0102030405060708"
)

var (
testTraceID = trace.TraceID{1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16}
Expand All @@ -54,33 +57,49 @@ func (s *testSpan) IsRecording() bool { return true }
func (s *testSpan) AddEvent(string, ...trace.EventOption) {}
func (s *testSpan) SetStatus(code codes.Code, _ string) { s.status = code }

func TestLogrusHookTraceID(t *testing.T) {
func TestLogrusHookSpanContextFields(t *testing.T) {
tests := []struct {
name string
enableOpt bool
traceID bool
spanID bool
nilContext bool
withSpan bool
expectedTID string
expectedSID string
}{
{
name: "TraceIDInjected",
enableOpt: true,
traceID: true,
withSpan: true,
expectedTID: expectedTraceIDStr,
},
{
name: "SpanIDInjected",
spanID: true,
withSpan: true,
expectedSID: expectedSpanIDStr,
},
{
name: "TraceAndSpanIDInjected",
traceID: true,
spanID: true,
withSpan: true,
expectedTID: expectedTraceIDStr,
expectedSID: expectedSpanIDStr,
},
{
name: "TraceIDNotInjected_OptionDisabled",
enableOpt: false,
withSpan: true,
name: "FieldsNotInjected_OptionsDisabled",
withSpan: true,
},
{
name: "TraceIDNotInjected_NoSpan",
enableOpt: true,
withSpan: false,
name: "FieldsNotInjected_NoSpan",
traceID: true,
spanID: true,
},
{
name: "TraceIDNotInjected_NoContext",
enableOpt: true,
name: "FieldsNotInjected_NoContext",
traceID: true,
spanID: true,
nilContext: true,
},
}
Expand All @@ -89,7 +108,10 @@ func TestLogrusHookTraceID(t *testing.T) {
t.Run(tc.name, func(t *testing.T) {
logger := logrus.New()
logger.SetOutput(io.Discard)
logger.AddHook(otel.NewLogrusHook(otel.WithTraceIDField(tc.enableOpt)))
logger.AddHook(otel.NewLogrusHook(
otel.WithTraceIDField(tc.traceID),
otel.WithSpanIDField(tc.spanID),
))
testHook := test.NewLocal(logger)

switch {
Expand Down Expand Up @@ -123,6 +145,18 @@ func TestLogrusHookTraceID(t *testing.T) {
} else if ok {
t.Errorf(`unexpected "trace_id" field: %v`, traceID)
}

spanID, ok := entry.Data["span_id"]
if tc.expectedSID != "" {
if !ok {
t.Fatal(`expected "span_id" field`)
}
if spanID != tc.expectedSID {
t.Errorf(`"span_id" = %v; want %q`, spanID, tc.expectedSID)
}
} else if ok {
t.Errorf(`unexpected "span_id" field: %v`, spanID)
}
})
}
}
Expand Down
Loading