Merge pull request #694 from jkroepke/slog/writer

ArthurSens · web-flow · commit 40d6251261f7 · 2024-09-14T18:58:25.000+02:00
slog: expose io.Writer
diff --git a/promslog/slog.go b/promslog/slog.go
@@ -148,10 +148,10 @@ func (f *AllowedFormat) Set(s string) error {
 
 // Config is a struct containing configurable settings for the logger
 type Config struct {
-	Level    *AllowedLevel
-	Format   *AllowedFormat
-	Style    LogStyle
-	ioWriter io.Writer
+	Level  *AllowedLevel
+	Format *AllowedFormat
+	Style  LogStyle
+	Writer io.Writer
 }
 
 // New returns a new slog.Logger. Each logged line will be annotated
@@ -162,8 +162,8 @@ func New(config *Config) *slog.Logger {
 		_ = config.Level.Set("info")
 	}
 
-	if config.ioWriter == nil {
-		config.ioWriter = defaultWriter
+	if config.Writer == nil {
+		config.Writer = defaultWriter
 	}
 
 	logHandlerOpts := &slog.HandlerOptions{
@@ -176,7 +176,7 @@ func New(config *Config) *slog.Logger {
 	}
 
 	if config.Format != nil && config.Format.s == "json" {
-		return slog.New(slog.NewJSONHandler(config.ioWriter, logHandlerOpts))
+		return slog.New(slog.NewJSONHandler(config.Writer, logHandlerOpts))
 	}
-	return slog.New(slog.NewTextHandler(config.ioWriter, logHandlerOpts))
+	return slog.New(slog.NewTextHandler(config.Writer, logHandlerOpts))
 }
diff --git a/promslog/slog_test.go b/promslog/slog_test.go
@@ -112,7 +112,7 @@ func TestDynamicLevels(t *testing.T) {
 	for name, tc := range tests {
 		t.Run(name, func(t *testing.T) {
 			buf.Reset() // Ensure buf is reset prior to tests
-			config := &Config{ioWriter: &buf, Style: tc.logStyle}
+			config := &Config{Writer: &buf, Style: tc.logStyle}
 			logger := New(config)
 
 			// Test that log level can be adjusted on-the-fly to debug and that a

Original file line number	Diff line number	Diff line change
`@@ -148,10 +148,10 @@ func (f *AllowedFormat) Set(s string) error {`
`148`	`148`
`149`	`149`	`// Config is a struct containing configurable settings for the logger`
`150`	`150`	`type Config struct {`
`151`		`- Level *AllowedLevel`
`152`		`- Format *AllowedFormat`
`153`		`- Style LogStyle`
`154`		`- ioWriter io.Writer`
	`151`	`+ Level *AllowedLevel`
	`152`	`+ Format *AllowedFormat`
	`153`	`+ Style LogStyle`
	`154`	`+ Writer io.Writer`
`155`	`155`	`}`
`156`	`156`
`157`	`157`	`// New returns a new slog.Logger. Each logged line will be annotated`
`@@ -162,8 +162,8 @@ func New(config Config) slog.Logger {`
`162`	`162`	`_ = config.Level.Set("info")`
`163`	`163`	`}`
`164`	`164`
`165`		`- if config.ioWriter == nil {`
`166`		`- config.ioWriter = defaultWriter`
	`165`	`+ if config.Writer == nil {`
	`166`	`+ config.Writer = defaultWriter`
`167`	`167`	`}`
`168`	`168`
`169`	`169`	`logHandlerOpts := &slog.HandlerOptions{`
`@@ -176,7 +176,7 @@ func New(config Config) slog.Logger {`
`176`	`176`	`}`
`177`	`177`
`178`	`178`	`if config.Format != nil && config.Format.s == "json" {`
`179`		`- return slog.New(slog.NewJSONHandler(config.ioWriter, logHandlerOpts))`
	`179`	`+ return slog.New(slog.NewJSONHandler(config.Writer, logHandlerOpts))`
`180`	`180`	`}`
`181`		`- return slog.New(slog.NewTextHandler(config.ioWriter, logHandlerOpts))`
	`181`	`+ return slog.New(slog.NewTextHandler(config.Writer, logHandlerOpts))`
`182`	`182`	`}`