Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add SlogSink support to funcr #241

Merged
merged 11 commits into from
Dec 8, 2023
5 changes: 5 additions & 0 deletions .github/workflows/lint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that we should cover the new code with linting. I don't think it's worth to lint also with older Go because the non-slog code isn't that complex and going away at some point.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i cant tell if you are agreeing with me or want a change?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with you.

- name: Lint
uses: golangci/golangci-lint-action@3a919529898de77ec3da873e3063ca4b10e7f5cc # v3.7.0
with:
Expand Down
2 changes: 1 addition & 1 deletion example_marshaler_secret_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"}
}
2 changes: 1 addition & 1 deletion example_marshaler_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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"}
}
12 changes: 8 additions & 4 deletions funcr/example/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down
29 changes: 29 additions & 0 deletions funcr/example/main_noslog.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
//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 (
"github.com/go-logr/logr"
)

func doSlog(log logr.Logger) {
log.Error(nil, "Sorry, slog is not supported on this version of Go")
}
42 changes: 42 additions & 0 deletions funcr/example/main_slog.go
Original file line number Diff line number Diff line change
@@ -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")
}
Loading