feat: add promslog.NewNopLogger() convenience func (#697)

tjhop · web-flow · commit 4e3a6fd348a3 · 2024-09-27T23:19:05.000+02:00
Simple convenience function to return an slog.Logger that writes to io.Discard. Originally suggested by @ArthurSens [here](#686 (comment)), and requested again by @bboreham [here](prometheus/prometheus#14906 (comment)). As Bryan points out in the comment, there's 147 instances where a discard logger is needed, so a consistent utility function to manage them seems helpful. Signed-off-by: TJ Hoplock <t.hoplock@gmail.com>
diff --git a/promslog/slog.go b/promslog/slog.go
@@ -180,3 +180,9 @@ func New(config *Config) *slog.Logger {
 	}
 	return slog.New(slog.NewTextHandler(config.Writer, logHandlerOpts))
 }
+
+// NewNopLogger is a convenience function to return an slog.Logger that writes
+// to io.Discard.
+func NewNopLogger() *slog.Logger {
+	return slog.New(slog.NewTextHandler(io.Discard, nil))
+}

Original file line number	Diff line number	Diff line change
`@@ -180,3 +180,9 @@ func New(config Config) slog.Logger {`
`180`	`180`	`}`
`181`	`181`	`return slog.New(slog.NewTextHandler(config.Writer, logHandlerOpts))`
`182`	`182`	`}`
	`183`	`+`
	`184`	`+// NewNopLogger is a convenience function to return an slog.Logger that writes`
	`185`	`+// to io.Discard.`
	`186`	`+func NewNopLogger() *slog.Logger {`
	`187`	`+ return slog.New(slog.NewTextHandler(io.Discard, nil))`
	`188`	`+}`