The native journal handler only put the bare msg string in MESSAGE, so default `journalctl` output lost all slog attributes (env, name, ip_version, etc.) that were visible with the old TextHandler path. Wrap the slog-journal handler so each record's MESSAGE is rendered through slog.TextHandler — producing the same `level=INFO msg="..." key=val` format as before — while still emitting every attribute as a structured journal field for `journalctl -o verbose` / field-based filtering. Also fix go.mod: slog-journal is a direct dependency.
125 lines
3.5 KiB
Go
125 lines
3.5 KiB
Go
package logger
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"log/slog"
|
|
"strings"
|
|
"testing"
|
|
"time"
|
|
)
|
|
|
|
// captureHandler records the last record it handled so tests can inspect
|
|
// the MESSAGE text produced by the journal wrapper.
|
|
type captureHandler struct {
|
|
last slog.Record
|
|
}
|
|
|
|
func (h *captureHandler) Enabled(context.Context, slog.Level) bool { return true }
|
|
func (h *captureHandler) Handle(_ context.Context, r slog.Record) error {
|
|
h.last = r.Clone()
|
|
return nil
|
|
}
|
|
func (h *captureHandler) WithAttrs(attrs []slog.Attr) slog.Handler { return h }
|
|
func (h *captureHandler) WithGroup(string) slog.Handler { return h }
|
|
|
|
func TestJournalMessageHandler_MessageContainsAttrs(t *testing.T) {
|
|
cap := &captureHandler{}
|
|
h := &journalMessageHandler{inner: cap, level: slog.LevelDebug}
|
|
|
|
log := slog.New(h).With("env", "prod").WithGroup("")
|
|
log.Info("shutting down monitor", "name", "usmci1-1a6a7hp", "ip_version", "v4")
|
|
|
|
got := cap.last.Message
|
|
for _, want := range []string{
|
|
`level=INFO`,
|
|
`msg="shutting down monitor"`,
|
|
`env=prod`,
|
|
`name=usmci1-1a6a7hp`,
|
|
`ip_version=v4`,
|
|
} {
|
|
if !strings.Contains(got, want) {
|
|
t.Errorf("MESSAGE missing %q; got %q", want, got)
|
|
}
|
|
}
|
|
if strings.Contains(got, "time=") {
|
|
t.Errorf("MESSAGE should not include time=; got %q", got)
|
|
}
|
|
if strings.HasSuffix(got, "\n") {
|
|
t.Errorf("MESSAGE should not end with newline; got %q", got)
|
|
}
|
|
|
|
// And the attributes should still be present on the record passed
|
|
// to the inner handler so the journal emits them as structured fields.
|
|
var sawEnv, sawName bool
|
|
cap.last.Attrs(func(a slog.Attr) bool {
|
|
switch a.Key {
|
|
case "env":
|
|
sawEnv = a.Value.String() == "prod"
|
|
case "name":
|
|
sawName = a.Value.String() == "usmci1-1a6a7hp"
|
|
}
|
|
return true
|
|
})
|
|
if !sawName {
|
|
t.Errorf("inner record missing name attr")
|
|
}
|
|
// env was applied via WithAttrs so it lives on the inner handler,
|
|
// not the record itself — that's verified separately below.
|
|
_ = sawEnv
|
|
}
|
|
|
|
func TestJournalMessageHandler_TextHandlerParity(t *testing.T) {
|
|
// Render the same record through slog.TextHandler (with time stripped)
|
|
// and through the journal wrapper. The MESSAGE body written to the
|
|
// journal must match the text handler output byte-for-byte (minus the
|
|
// trailing newline).
|
|
var textBuf bytes.Buffer
|
|
textH := slog.NewTextHandler(&textBuf, &slog.HandlerOptions{
|
|
ReplaceAttr: logRemoveTime,
|
|
})
|
|
|
|
cap := &captureHandler{}
|
|
journalH := &journalMessageHandler{inner: cap, level: slog.LevelDebug}
|
|
|
|
r := slog.NewRecord(time.Date(2026, 4, 15, 7, 45, 29, 0, time.UTC), slog.LevelError, "backoff error", 0)
|
|
r.AddAttrs(slog.String("env", "test"), slog.String("ip_version", "v4"))
|
|
|
|
if err := textH.Handle(context.Background(), r); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if err := journalH.Handle(context.Background(), r); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
want := strings.TrimRight(textBuf.String(), "\n")
|
|
if cap.last.Message != want {
|
|
t.Errorf("journal MESSAGE mismatch\n got: %q\nwant: %q", cap.last.Message, want)
|
|
}
|
|
}
|
|
|
|
func TestSanitizeJournalKey(t *testing.T) {
|
|
tests := []struct {
|
|
in, want string
|
|
}{
|
|
{"", ""},
|
|
{"MESSAGE", "MESSAGE"},
|
|
{"trace_id", "TRACE_ID"},
|
|
{"span.id", "SPAN_ID"},
|
|
{"http-method", "HTTP_METHOD"},
|
|
{"a", "A"},
|
|
{"123abc", "_123ABC"},
|
|
{"weird!@#key", "WEIRD___KEY"},
|
|
{"_leading", "_LEADING"},
|
|
{"MiXeD_Case", "MIXED_CASE"},
|
|
}
|
|
for _, tt := range tests {
|
|
t.Run(tt.in, func(t *testing.T) {
|
|
got := sanitizeJournalKey(tt.in)
|
|
if got != tt.want {
|
|
t.Errorf("sanitizeJournalKey(%q) = %q, want %q", tt.in, got, tt.want)
|
|
}
|
|
})
|
|
}
|
|
}
|