diff --git a/log/experimental_level/benchmark_test.go b/log/experimental_level/benchmark_test.go index 11aaec1..65b06c4 100644 --- a/log/experimental_level/benchmark_test.go +++ b/log/experimental_level/benchmark_test.go @@ -44,7 +44,7 @@ return l }}, {"DisallowedLevel", func(l log.Logger) log.Logger { - return level.NewFilter(l, level.AllowInfoAndAbove()) + return level.NewFilter(l, level.AllowInfo()) }}, {"AllowedLevel", func(l log.Logger) log.Logger { return level.NewFilter(l, level.AllowAll()) diff --git a/log/experimental_level/example_test.go b/log/experimental_level/example_test.go index 54d6500..d181877 100644 --- a/log/experimental_level/example_test.go +++ b/log/experimental_level/example_test.go @@ -11,7 +11,7 @@ func Example_basic() { // setup logger with level filter logger := log.NewLogfmtLogger(os.Stdout) - logger = level.NewFilter(logger, level.AllowInfoAndAbove()) + logger = level.NewFilter(logger, level.AllowInfo()) logger = log.NewContext(logger).With("caller", log.DefaultCaller) // use level helpers to log at different levels diff --git a/log/experimental_level/level.go b/log/experimental_level/level.go index 1669db9..3d29f15 100644 --- a/log/experimental_level/level.go +++ b/log/experimental_level/level.go @@ -66,32 +66,32 @@ // Option sets a parameter for the leveled logger. type Option func(*logger) -// AllowAll is an alias for AllowDebugAndAbove. +// AllowAll is an alias for AllowDebug. func AllowAll() Option { - return AllowDebugAndAbove() + return AllowDebug() } -// AllowDebugAndAbove allows all of the four default log levels. -func AllowDebugAndAbove() Option { - return allowed(levelDebug | levelInfo | levelWarn | levelError) +// AllowDebug allows error, warn, info and debug level log events to pass. +func AllowDebug() Option { + return allowed(levelError | levelWarn | levelInfo | levelDebug) } -// AllowInfoAndAbove allows the default info, warn, and error log levels. -func AllowInfoAndAbove() Option { - return allowed(levelInfo | levelWarn | levelError) +// AllowInfo allows error, warn and info level log events to pass. +func AllowInfo() Option { + return allowed(levelError | levelWarn | levelInfo) } -// AllowWarnAndAbove allows the default warn and error log levels. -func AllowWarnAndAbove() Option { - return allowed(levelWarn | levelError) +// AllowWarn allows error and warn level log events to pass. +func AllowWarn() Option { + return allowed(levelError | levelWarn) } -// AllowErrorOnly allows only the default error log level. -func AllowErrorOnly() Option { +// AllowError allows only error level log events to pass. +func AllowError() Option { return allowed(levelError) } -// AllowNone allows none of the default log levels. +// AllowNone allows no leveled log events to pass. func AllowNone() Option { return allowed(0) } @@ -101,8 +101,9 @@ } // ErrNotAllowed sets the error to return from Log when it squelches a log -// event below the configured filtering level. By default, ErrNotAllowed is -// nil; in this case, the log event is squelched with no error. +// event disallowed by the configured Allow[Level] option. By default, +// ErrNotAllowed is nil; in this case the log event is squelched with no +// error. func ErrNotAllowed(err error) Option { return func(l *logger) { l.errNotAllowed = err } } @@ -116,8 +117,8 @@ } // ErrNoLevel sets the error to return from Log when it squelches a log event -// with no level. By default, ErrNoLevel is nil; in this case, the log event -// is squelched with no error. +// with no level. By default, ErrNoLevel is nil; in this case the log event is +// squelched with no error. func ErrNoLevel(err error) Option { return func(l *logger) { l.errNoLevel = err } } diff --git a/log/experimental_level/level_test.go b/log/experimental_level/level_test.go index d284463..b173072 100644 --- a/log/experimental_level/level_test.go +++ b/log/experimental_level/level_test.go @@ -26,7 +26,7 @@ }, "\n"), }, { - level.AllowDebugAndAbove(), + level.AllowDebug(), strings.Join([]string{ `{"level":"debug","this is":"debug log"}`, `{"level":"info","this is":"info log"}`, @@ -35,7 +35,7 @@ }, "\n"), }, { - level.AllowInfoAndAbove(), + level.AllowInfo(), strings.Join([]string{ `{"level":"info","this is":"info log"}`, `{"level":"warn","this is":"warn log"}`, @@ -43,14 +43,14 @@ }, "\n"), }, { - level.AllowWarnAndAbove(), + level.AllowWarn(), strings.Join([]string{ `{"level":"warn","this is":"warn log"}`, `{"level":"error","this is":"error log"}`, }, "\n"), }, { - level.AllowErrorOnly(), + level.AllowError(), strings.Join([]string{ `{"level":"error","this is":"error log"}`, }, "\n"), @@ -77,7 +77,7 @@ func TestErrNotAllowed(t *testing.T) { myError := errors.New("squelched!") opts := []level.Option{ - level.AllowWarnAndAbove(), + level.AllowWarn(), level.ErrNotAllowed(myError), } logger := level.NewFilter(log.NewNopLogger(), opts...)