Skip to content
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.

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

fix: record attribute correctly #21

Merged
merged 2 commits into from
Apr 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
27 changes: 24 additions & 3 deletions logger.go
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,27 @@ func (l logger) log(ctx context.Context, level slog.Level, format string, args .
_ = l.sloggerHandler.Handle(ctx, r)
}

// log adds context attributes and logs a message with the given slog level
func (l logger) logAttrs(ctx context.Context, level slog.Level, msg string, attrs ...any) {
if ctx == nil {
ctx = context.Background()
}
if !l.sloggerHandler.Enabled(ctx, level) {
return
}

// Properly handle the PC for the caller
var pc uintptr
var pcs [1]uintptr
// skip [runtime.Callers, this function, this function's caller]
runtime.Callers(3, pcs[:])
pc = pcs[0]
r := slog.NewRecord(time.Now(), level, msg, pc)
r.Add(attrs...)

_ = l.sloggerHandler.Handle(ctx, r)
}

// Trace logs sql message
func (l logger) Trace(ctx context.Context, begin time.Time, fc func() (sql string, rowsAffected int64), err error) {
if l.ignoreTrace {
Expand All @@ -141,7 +162,7 @@ func (l logger) Trace(ctx context.Context, begin time.Time, fc func() (sql strin
slog.String(l.sourceField, utils.FileWithLineNum()),
})

l.log(ctx, l.logLevel[ErrorLogType], err.Error(), attributes...)
l.logAttrs(ctx, l.logLevel[ErrorLogType], err.Error(), attributes...)

case l.slowThreshold != 0 && elapsed > l.slowThreshold:
sql, rows := fc()
Expand All @@ -154,7 +175,7 @@ func (l logger) Trace(ctx context.Context, begin time.Time, fc func() (sql strin
slog.Int64(RowsField, rows),
slog.String(l.sourceField, utils.FileWithLineNum()),
})
l.log(ctx, l.logLevel[SlowQueryLogType], fmt.Sprintf("slow sql query [%s >= %v]", elapsed, l.slowThreshold), attributes...)
l.logAttrs(ctx, l.logLevel[SlowQueryLogType], fmt.Sprintf("slow sql query [%s >= %v]", elapsed, l.slowThreshold), attributes...)

case l.traceAll || l.gormLevel == gormlogger.Info:
sql, rows := fc()
Expand All @@ -167,7 +188,7 @@ func (l logger) Trace(ctx context.Context, begin time.Time, fc func() (sql strin
slog.String(l.sourceField, utils.FileWithLineNum()),
})

l.log(ctx, l.logLevel[DefaultLogType], fmt.Sprintf("SQL query executed [%s]", elapsed), attributes...)
l.logAttrs(ctx, l.logLevel[DefaultLogType], fmt.Sprintf("SQL query executed [%s]", elapsed), attributes...)
}
}

Expand Down
29 changes: 29 additions & 0 deletions logger_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,42 @@ func Test_logger_Enabled(t *testing.T) {
l := New(WithHandler(slog.NewTextHandler(buffer, &slog.HandlerOptions{Level: leveler})))
leveler.Set(slog.LevelWarn)

l.Info(nil, "an info message")
assert.Equal(t, 0, buffer.Len())

l.Info(context.Background(), "an info message")
assert.Equal(t, 0, buffer.Len())

l.Warn(context.Background(), "a warn message")
assert.Greater(t, buffer.Len(), 0)
}

func Test_logger_Trace_Enabled(t *testing.T) {
buffer := bytes.NewBuffer(nil)
leveler := &slog.LevelVar{}
l := New(
WithHandler(slog.NewTextHandler(buffer, &slog.HandlerOptions{Level: leveler})),
WithSlowThreshold(10*time.Second),
WithTraceAll(),
)

fc := func() (string, int64) {
return "SELECT * FROM user", 1
}

leveler.Set(slog.LevelWarn)
l.Trace(context.Background(), time.Now().Add(-1*time.Second), fc, nil)
assert.Equal(t, 0, buffer.Len())

leveler.Set(slog.LevelError)
l.Trace(context.Background(), time.Now().Add(-1*time.Minute), fc, nil)
assert.Equal(t, 0, buffer.Len())

leveler.Set(slog.Level(42))
l.Trace(context.Background(), time.Now().Add(-1*time.Minute), fc, fmt.Errorf("awesome error"))
assert.Equal(t, 0, buffer.Len())
}

func Test_logger_LogMode(t *testing.T) {
l := logger{gormLevel: gormlogger.Info}
actual := l.LogMode(gormlogger.Info)
Expand Down
Loading