Merge pull request #241 from thockin/master

Add SlogSink support to funcr

.github/workflows/lint.yaml

@@ -11,6 +11,11 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      - name: Update Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: '>=1.21.0'
+          cache: false
       - name: Lint
         uses: golangci/golangci-lint-action@3a919529898de77ec3da873e3063ca4b10e7f5cc # v3.7.0
         with:

benchmark/benchmark_slog_test.go

@@ -0,0 +1,142 @@
+//go:build go1.21
+// +build go1.21
+
+/*
+Copyright 2021 The logr Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package logr
+
+import (
+	"log/slog"
+	"os"
+	"testing"
+
+	"github.com/go-logr/logr"
+)
+
+//
+// slogSink wrapper of discard
+//
+
+func BenchmarkSlogSinkLogInfoOneArg(b *testing.B) {
+	var log logr.Logger = logr.FromSlogHandler(logr.ToSlogHandler(logr.Discard()))
+	doInfoOneArg(b, log)
+}
+
+func BenchmarkSlogSinkLogInfoSeveralArgs(b *testing.B) {
+	var log logr.Logger = logr.FromSlogHandler(logr.ToSlogHandler(logr.Discard()))
+	doInfoSeveralArgs(b, log)
+}
+
+func BenchmarkSlogSinkLogInfoWithValues(b *testing.B) {
+	var log logr.Logger = logr.FromSlogHandler(logr.ToSlogHandler(logr.Discard()))
+	doInfoWithValues(b, log)
+}
+
+func BenchmarkSlogSinkLogV0Info(b *testing.B) {
+	var log logr.Logger = logr.FromSlogHandler(logr.ToSlogHandler(logr.Discard()))
+	doV0Info(b, log)
+}
+
+func BenchmarkSlogSinkLogV9Info(b *testing.B) {
+	var log logr.Logger = logr.FromSlogHandler(logr.ToSlogHandler(logr.Discard()))
+	doV9Info(b, log)
+}
+
+func BenchmarkSlogSinkLogError(b *testing.B) {
+	var log logr.Logger = logr.FromSlogHandler(logr.ToSlogHandler(logr.Discard()))
+	doError(b, log)
+}
+
+func BenchmarkSlogSinkWithValues(b *testing.B) {
+	var log logr.Logger = logr.FromSlogHandler(logr.ToSlogHandler(logr.Discard()))
+	doWithValues(b, log)
+}
+
+func BenchmarkSlogSinkWithName(b *testing.B) {
+	var log logr.Logger = logr.FromSlogHandler(logr.ToSlogHandler(logr.Discard()))
+	doWithName(b, log)
+}
+
+//
+// slogSink wrapper of slog's JSONHandler, for comparison
+//
+
+func makeSlogJSONLogger() logr.Logger {
+	devnull, _ := os.Open("/dev/null")
+	handler := slog.NewJSONHandler(devnull, nil)
+	return logr.FromSlogHandler(handler)
+}
+
+func BenchmarkSlogJSONLogInfoOneArg(b *testing.B) {
+	var log logr.Logger = makeSlogJSONLogger()
+	doInfoOneArg(b, log)
+}
+
+func BenchmarkSlogJSONLogInfoSeveralArgs(b *testing.B) {
+	var log logr.Logger = makeSlogJSONLogger()
+	doInfoSeveralArgs(b, log)
+}
+
+func BenchmarkSlogJSONLogInfoWithValues(b *testing.B) {
+	var log logr.Logger = makeSlogJSONLogger()
+	doInfoWithValues(b, log)
+}
+
+func BenchmarkSlogJSONLogV0Info(b *testing.B) {
+	var log logr.Logger = makeSlogJSONLogger()
+	doV0Info(b, log)
+}
+
+func BenchmarkSlogJSONLogV9Info(b *testing.B) {
+	var log logr.Logger = makeSlogJSONLogger()
+	doV9Info(b, log)
+}
+
+func BenchmarkSlogJSONLogError(b *testing.B) {
+	var log logr.Logger = makeSlogJSONLogger()
+	doError(b, log)
+}
+
+func BenchmarkSlogJSONLogWithValues(b *testing.B) {
+	var log logr.Logger = makeSlogJSONLogger()
+	doWithValues(b, log)
+}
+
+func BenchmarkSlogJSONWithName(b *testing.B) {
+	var log logr.Logger = makeSlogJSONLogger()
+	doWithName(b, log)
+}
+
+func BenchmarkSlogJSONWithCallDepth(b *testing.B) {
+	var log logr.Logger = makeSlogJSONLogger()
+	doWithCallDepth(b, log)
+}
+
+func BenchmarkSlogJSONLogInfoStringerValue(b *testing.B) {
+	var log logr.Logger = makeSlogJSONLogger()
+	doStringerValue(b, log)
+}
+
+func BenchmarkSlogJSONLogInfoErrorValue(b *testing.B) {
+	var log logr.Logger = makeSlogJSONLogger()
+	doErrorValue(b, log)
+}
+
+func BenchmarkSlogJSONLogInfoMarshalerValue(b *testing.B) {
+	var log logr.Logger = makeSlogJSONLogger()
+	doMarshalerValue(b, log)
+}

benchmark/benchmark_test.go

@@ -141,6 +141,10 @@ func doMarshalerValue(b *testing.B, log logr.Logger) {
 	}
 }
 
+//
+// discard
+//
+
 func BenchmarkDiscardLogInfoOneArg(b *testing.B) {
 	var log logr.Logger = logr.Discard()
 	doInfoOneArg(b, log)
@@ -181,6 +185,10 @@ func BenchmarkDiscardWithName(b *testing.B) {
 	doWithName(b, log)
 }
 
+//
+// funcr
+//
+
 func noopKV(_, _ string) {}
 func noopJSON(_ string)  {}
 

example_marshaler_secret_test.go

@@ -43,5 +43,5 @@ func ExampleMarshaler_secret() {
 	secret := ComplexObjectRef{Namespace: "kube-system", Name: "some-secret", Secret: "do-not-log-me"}
 	l.Info("simplified", "secret", secret)
 	// Output:
-	// "level"=0 "msg"="simplified" "secret"={"Name":"some-secret","Namespace":"kube-system"}
+	// "level"=0 "msg"="simplified" "secret"={"Name"="some-secret" "Namespace"="kube-system"}
 }

example_marshaler_test.go

@@ -51,5 +51,5 @@ func ExampleMarshaler() {
 	l.Info("as struct", "pod", pod)
 	// Output:
 	// "level"=0 "msg"="as string" "pod"="kube-system/some-pod"
-	// "level"=0 "msg"="as struct" "pod"={"name":"some-pod","namespace":"kube-system"}
+	// "level"=0 "msg"="as struct" "pod"={"name"="some-pod" "namespace"="kube-system"}
 }

example_slogr_test.go

@@ -0,0 +1,79 @@
+//go:build go1.21
+// +build go1.21
+
+/*
+Copyright 2023 The logr Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package logr_test
+
+import (
+	"errors"
+	"fmt"
+	"log/slog"
+	"os"
+
+	"github.com/go-logr/logr"
+	"github.com/go-logr/logr/funcr"
+)
+
+var debugWithoutTime = &slog.HandlerOptions{
+	ReplaceAttr: func(groups []string, a slog.Attr) slog.Attr {
+		if a.Key == "time" {
+			return slog.Attr{}
+		}
+		return a
+	},
+	Level: slog.LevelDebug,
+}
+
+func ExampleFromSlogHandler() {
+	logrLogger := logr.FromSlogHandler(slog.NewTextHandler(os.Stdout, debugWithoutTime))
+
+	logrLogger.Info("hello world")
+	logrLogger.Error(errors.New("fake error"), "ignore me")
+	logrLogger.WithValues("x", 1, "y", 2).WithValues("str", "abc").WithName("foo").WithName("bar").V(4).Info("with values, verbosity and name")
+
+	// Output:
+	// level=INFO msg="hello world"
+	// level=ERROR msg="ignore me" err="fake error"
+	// level=DEBUG msg="with values, verbosity and name" x=1 y=2 str=abc logger=foo/bar
+}
+
+func ExampleToSlogHandler() {
+	funcrLogger := funcr.New(func(prefix, args string) {
+		if prefix != "" {
+			fmt.Fprintln(os.Stdout, prefix, args)
+		} else {
+			fmt.Fprintln(os.Stdout, args)
+		}
+	}, funcr.Options{
+		Verbosity: 10,
+	})
+
+	slogLogger := slog.New(logr.ToSlogHandler(funcrLogger))
+	slogLogger.Info("hello world")
+	slogLogger.Error("ignore me", "err", errors.New("fake error"))
+	slogLogger.With("x", 1, "y", 2).WithGroup("group").With("str", "abc").Warn("with values and group")
+
+	slogLogger = slog.New(logr.ToSlogHandler(funcrLogger.V(int(-slog.LevelDebug))))
+	slogLogger.Info("info message reduced to debug level")
+
+	// Output:
+	// "level"=0 "msg"="hello world"
+	// "msg"="ignore me" "error"=null "err"="fake error"
+	// "level"=0 "msg"="with values and group" "x"=1 "y"=2 "group"={"str"="abc"}
+	// "level"=4 "msg"="info message reduced to debug level"
+}

funcr/example/main.go

@@ -41,17 +41,21 @@ func helper2(log logr.Logger, msg string) {
 }
 
 func main() {
-	log := funcr.New(
-		func(pfx, args string) { fmt.Println(pfx, args) },
+	// logr
+	log := funcr.NewJSON(
+		func(arg string) { fmt.Println(arg) },
 		funcr.Options{
 			LogCaller:    funcr.All,
 			LogTimestamp: true,
 			Verbosity:    1,
 		})
-	example(log.WithValues("module", "example"))
+	logrExample(log.WithName("logr").WithValues("mode", "funcr"))
+
+	// slog (if possible)
+	doSlog(log)
 }
 
-func example(log logr.Logger) {
+func logrExample(log logr.Logger) {
 	log.Info("hello", "val1", 1, "val2", map[string]int{"k": 1})
 	log.V(1).Info("you should see this")
 	log.V(1).V(1).Info("you should NOT see this")

logr_noslog_test.go → funcr/example/main_noslog.go

@@ -17,7 +17,13 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package logr
+// Package main is an example of using funcr.
+package main
 
-//nolint:unused
-type testSlogSink struct{}
+import (
+	"github.com/go-logr/logr"
+)
+
+func doSlog(log logr.Logger) {
+	log.Error(nil, "Sorry, slog is not supported on this version of Go")
+}

funcr/example/main_slog.go

@@ -0,0 +1,42 @@
+//go:build go1.21
+// +build go1.21
+
+/*
+Copyright 2023 The logr Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// Package main is an example of using funcr.
+package main
+
+import (
+	"log/slog"
+
+	"github.com/go-logr/logr"
+)
+
+func doSlog(log logr.Logger) {
+	slogger := slog.New(logr.ToSlogHandler(log.WithName("slog").WithValues("mode", "slog")))
+	slogExample(slogger)
+}
+
+func slogExample(log *slog.Logger) {
+	log.Warn("hello", "val1", 1, "val2", map[string]int{"k": 1})
+	log.Info("you should see this")
+	log.Debug("you should NOT see this")
+	log.Error("uh oh", "trouble", true, "reasons", []float64{0.1, 0.11, 3.14})
+	log.With("attr1", 1, "attr2", 2).Info("with attrs")
+	log.WithGroup("groupname").Info("with group", "slog2", false)
+	log.WithGroup("group1").With("attr1", 1).WithGroup("group2").With("attr2", 2).Info("msg", "arg", "val")
+}