add a helpful comment

komuw · May 26, 2023 · 6f54957 · 6f54957
1 parent 3db7a53
commit 6f54957
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/log/log.go b/log/log.go
@@ -53,7 +53,13 @@ func New(w io.Writer, maxMsgs int) func(ctx context.Context) *slog.Logger {
 		AddSource: true,
 		Level:     slog.LevelDebug,
 	}
-	jh := slog.NewJSONHandler(w, opts)
+	jh := slog.NewJSONHandler(
+		// os.Stderr is not buffered. Thus it will make a sycall for every write.
+		// os.Stdout on the other hand is buffered.
+		// https://eklitzke.org/stdout-buffering
+		w,
+		opts,
+	)
 	cbuf := newCirleBuf(maxMsgs)
 	hdlr := handler{wrappedHandler: jh, cBuf: cbuf, logID: id.New()}
 	l := slog.New(hdlr)