Skip to content

otel: avoid span lookup for entries without context #28

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

Merged
estesp merged 1 commit into from
Aug 28, 2026
Merged

otel: avoid span lookup for entries without context #28

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
9 changes: 5 additions & 4 deletions otel/log.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,17 +72,18 @@ func (h *LogrusHook) Levels() []log.Level {

// Fire is called when a log event occurs.
func (h *LogrusHook) Fire(entry *log.Entry) error {
span := trace.SpanFromContext(entry.Context)
if span == nil {
if entry.Context == nil {
return nil
}

if !span.SpanContext().IsValid() {
span := trace.SpanFromContext(entry.Context)
spanCtx := span.SpanContext()
if !spanCtx.IsValid() {
return nil
}

if h.enableTraceIDField {
entry.Data["trace_id"] = span.SpanContext().TraceID().String()
entry.Data["trace_id"] = spanCtx.TraceID().String()
}

if !span.IsRecording() {
Expand Down
47 changes: 29 additions & 18 deletions otel/log_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,12 @@ package otel_test

import (
"context"
"io"
"testing"

"github.com/containerd/log"
"github.com/containerd/log/otel"
"github.com/sirupsen/logrus"
"github.com/sirupsen/logrus/hooks/test"
"go.opentelemetry.io/otel/trace"
)

Expand All @@ -36,6 +38,7 @@ func TestLogrusHookTraceID(t *testing.T) {
tests := []struct {
name string
enableOpt bool
nilContext bool
withSpan bool
expectedTID string
}{
Expand All @@ -55,30 +58,38 @@ func TestLogrusHookTraceID(t *testing.T) {
enableOpt: true,
withSpan: false,
},
{
name: "TraceIDNotInjected_NoContext",
enableOpt: true,
nilContext: true,
},
}

for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
ctx := context.Background()
if tc.withSpan {
ctx = trace.ContextWithSpanContext(
ctx,
trace.NewSpanContext(trace.SpanContextConfig{
TraceID: testTraceID,
SpanID: testSpanID,
}),
)
}
logger := logrus.New()
logger.SetOutput(io.Discard)
logger.AddHook(otel.NewLogrusHook(otel.WithTraceIDField(tc.enableOpt)))
testHook := test.NewLocal(logger)

switch {
case tc.withSpan:
ctx := trace.ContextWithSpanContext(context.Background(), trace.NewSpanContext(trace.SpanContextConfig{
TraceID: testTraceID,
SpanID: testSpanID,
}))
logger.WithContext(ctx).Info("test")

case tc.nilContext:
logger.Info("test")

hook := otel.NewLogrusHook(otel.WithTraceIDField(tc.enableOpt))
entry := &log.Entry{
Context: ctx,
Data: make(log.Fields),
default:
logger.WithContext(context.Background()).Info("test")
}

err := hook.Fire(entry)
if err != nil {
t.Fatal(err)
entry := testHook.LastEntry()
if entry == nil {
t.Fatal("expected log entry")
}

traceID, ok := entry.Data["trace_id"]
Expand Down
Loading