forked from cerc-io/plugeth
28e7371701
This PR replaces Geth's logger package (a fork of [log15](https://github.com/inconshreveable/log15)) with an implementation using slog, a logging library included as part of the Go standard library as of Go1.21. Main changes are as follows: * removes any log handlers that were unused in the Geth codebase. * Json, logfmt, and terminal formatters are now slog handlers. * Verbosity level constants are changed to match slog constant values. Internal translation is done to make this opaque to the user and backwards compatible with existing `--verbosity` and `--vmodule` options. * `--log.backtraceat` and `--log.debug` are removed. The external-facing API is largely the same as the existing Geth logger. Logger method signatures remain unchanged. A small semantic difference is that a `Handler` can only be set once per `Logger` and not changed dynamically. This just means that a new logger must be instantiated every time the handler of the root logger is changed. ---- For users of the `go-ethereum/log` module. If you were using this module for your own project, you will need to change the initialization. If you previously did ```golang log.Root().SetHandler(log.LvlFilterHandler(log.LvlInfo, log.StreamHandler(os.Stderr, log.TerminalFormat(true)))) ``` You now instead need to do ```golang log.SetDefault(log.NewLogger(log.NewTerminalHandlerWithLevel(os.Stderr, log.LevelInfo, true))) ``` See more about reasoning here: https://github.com/ethereum/go-ethereum/issues/28558#issuecomment-1820606613
54 lines
1.6 KiB
Go
54 lines
1.6 KiB
Go
package log
|
|
|
|
import (
|
|
"bytes"
|
|
"os"
|
|
"strings"
|
|
"testing"
|
|
|
|
"golang.org/x/exp/slog"
|
|
)
|
|
|
|
// TestLoggingWithVmodule checks that vmodule works.
|
|
func TestLoggingWithVmodule(t *testing.T) {
|
|
out := new(bytes.Buffer)
|
|
glog := NewGlogHandler(NewTerminalHandlerWithLevel(out, LevelTrace, false))
|
|
glog.Verbosity(LevelCrit)
|
|
logger := NewLogger(glog)
|
|
logger.Warn("This should not be seen", "ignored", "true")
|
|
glog.Vmodule("logger_test.go=5")
|
|
logger.Trace("a message", "foo", "bar")
|
|
have := out.String()
|
|
// The timestamp is locale-dependent, so we want to trim that off
|
|
// "INFO [01-01|00:00:00.000] a messag ..." -> "a messag..."
|
|
have = strings.Split(have, "]")[1]
|
|
want := " a message foo=bar\n"
|
|
if have != want {
|
|
t.Errorf("\nhave: %q\nwant: %q\n", have, want)
|
|
}
|
|
}
|
|
|
|
func TestTerminalHandlerWithAttrs(t *testing.T) {
|
|
out := new(bytes.Buffer)
|
|
glog := NewGlogHandler(NewTerminalHandlerWithLevel(out, LevelTrace, false).WithAttrs([]slog.Attr{slog.String("baz", "bat")}))
|
|
glog.Verbosity(LevelTrace)
|
|
logger := NewLogger(glog)
|
|
logger.Trace("a message", "foo", "bar")
|
|
have := out.String()
|
|
// The timestamp is locale-dependent, so we want to trim that off
|
|
// "INFO [01-01|00:00:00.000] a messag ..." -> "a messag..."
|
|
have = strings.Split(have, "]")[1]
|
|
want := " a message baz=bat foo=bar\n"
|
|
if have != want {
|
|
t.Errorf("\nhave: %q\nwant: %q\n", have, want)
|
|
}
|
|
}
|
|
|
|
func BenchmarkTraceLogging(b *testing.B) {
|
|
SetDefault(NewLogger(NewTerminalHandler(os.Stderr, true)))
|
|
b.ResetTimer()
|
|
for i := 0; i < b.N; i++ {
|
|
Trace("a message", "v", i)
|
|
}
|
|
}
|