Logr 1.1.0 and implement stdr in terms of funcr

[thockin]

No description provided.

[pohly]

Would it make sense to avoid this if check and then perhaps the entire output helper function by ensuring in the constructor that l.std is always non-nil? If NewWithOptions is called with a nil interface, the constructor could create one which calls log.Output.

If l.std continues to be nil in some cases, then GetUnderlying might need a comment about that.

[thockin]

Good idea. Will add a commit

[pohly]

Unrelated to this PR:

stdr/stdr.go

Line 82 in 625208e

// LogCaller tells glogr to add a "caller" key to some or all log lines.

refers to "glogr" instead of "stdr".

The comment about "The glog implementation always logs this information in its per-line header, whether this option is set or not." can be removed, log.New has the flag parameter to control this.

[pohly]

There are no automated tests. Here's one that you can drop into example/example_test.go:

/*
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 main

import (
	"errors"
	"log"
	"os"

	"github.com/go-logr/stdr"
)

var errSome = errors.New("some error")

func newStdLogger(flags int) stdr.StdLogger {
	return log.New(os.Stdout, "", flags)
}

func ExampleNew() {
	log := stdr.New(newStdLogger(log.Lshortfile))
	log.Info("info message with default options")
	log.Error(errSome, "error message with default options")
	log.Info("invalid key", 42, "answer")
	log.Info("missing value", "answer")
	// Output:
	// example_test.go:35: "level"=0 "msg"="info message with default options"
	// example_test.go:36: "msg"="error message with default options" "error"="some error"
	// example_test.go:37: "level"=0 "msg"="invalid key" "<non-string-key-2>"="answer"
	// example_test.go:38: "level"=0 "msg"="missing value" "answer"="<no-value>"
}

func ExampleWithName() {
	log := stdr.New(newStdLogger(0))
	log.WithName("hello").WithName("world").Info("thanks for the fish")
	// Output:
	// hello/world: "level"=0 "msg"="thanks for the fish"
}

func ExampleNewWithOptions() {
	log := stdr.NewWithOptions(newStdLogger(0), stdr.Options{LogCaller: stdr.All})
	log.Info("with LogCaller=All")
	// Output:
	// "caller"={"file":"example_test.go","line":55} "level"=0 "msg"="with LogCaller=All"
}

[thockin]

Thanks, will add the test

[pohly]

The next sentence can be removed completely ("The glog implementation...").

[thockin]

oooops

…

On Tue, Aug 24, 2021 at 10:51 AM Patrick Ohly ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In stdr.go <#18 (comment)> : > @@ -84,7 +84,7 @@ type Options struct { // be treated as zero. Depth int - // LogCaller tells glogr to add a "caller" key to some or all log lines. + // LogCaller tells stdr to add a "caller" key to some or all log lines. The next sentence can be removed completely ("The glog implementation..."). — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#18 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABKWAVCSY3YBLHVMBUPAZ6LT6PLZ7ANCNFSM5CVFR6MA> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&utm_campaign=notification-email> .

[thockin]

all glog refs removed

[pohly]

LGTM