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

Fix issue where default go logger is not discarded when either * or stdout is selected. #15708

Merged
merged 6 commits into from
Jan 27, 2020
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions libbeat/logp/core.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ import (
)

var (
_log unsafe.Pointer // Pointer to a coreLogger. Access via atomic.LoadPointer.
_log unsafe.Pointer // Pointer to a coreLogger. Access via atomic.LoadPointer.
_defaultGoLog = golog.Writer()
)

func init() {
Expand Down Expand Up @@ -86,6 +87,10 @@ func Configure(cfg Config) error {
return errors.Wrap(err, "failed to build log output")
}

// Default logger is always discard, debug level below will
// possibly re-enable it.
golog.SetOutput(ioutil.Discard)

// Enabled selectors when debug is enabled.
selectors := make(map[string]struct{}, len(cfg.Selectors))
if cfg.Level.Enabled(DebugLevel) && len(cfg.Selectors) > 0 {
Expand All @@ -98,10 +103,12 @@ func Configure(cfg Config) error {
selectors["*"] = struct{}{}
}

if _, enabled := selectors["stdlog"]; !enabled {
// Disable standard logging by default (this is sometimes used by
// libraries and we don't want their spam).
golog.SetOutput(ioutil.Discard)
// Re-enable the default go logger output when either stdlog
// or all selector is enabled.
_, stdlogEnabled := selectors["stdlog"]
_, allEnabled := selectors["*"]
if stdlogEnabled || allEnabled {
golog.SetOutput(_defaultGoLog)
}

sink = selectiveWrapper(sink, selectors)
Expand Down
30 changes: 30 additions & 0 deletions libbeat/logp/core_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
package logp

import (
"io/ioutil"
golog "log"
"testing"

"github.com/stretchr/testify/assert"
Expand Down Expand Up @@ -116,3 +118,31 @@ func TestL(t *testing.T) {
assert.Equal(t, "warning 1", log.Message)
}
}

func TestDebugAllStdoutEnablesDefaultGoLogger(t *testing.T) {
DevelopmentSetup(WithSelectors("*"))
assert.Equal(t, _defaultGoLog, golog.Writer())

DevelopmentSetup(WithSelectors("stdlog"))
assert.Equal(t, _defaultGoLog, golog.Writer())

DevelopmentSetup(WithSelectors("*", "stdlog"))
assert.Equal(t, _defaultGoLog, golog.Writer())

DevelopmentSetup(WithSelectors("other"))
assert.Equal(t, ioutil.Discard, golog.Writer())
}

func TestNotDebugAllStdoutDisablesDefaultGoLogger(t *testing.T) {
DevelopmentSetup(WithSelectors("*"), WithLevel(InfoLevel))
assert.Equal(t, ioutil.Discard, golog.Writer())

DevelopmentSetup(WithSelectors("stdlog"), WithLevel(InfoLevel))
assert.Equal(t, ioutil.Discard, golog.Writer())

DevelopmentSetup(WithSelectors("*", "stdlog"), WithLevel(InfoLevel))
assert.Equal(t, ioutil.Discard, golog.Writer())

DevelopmentSetup(WithSelectors("other"), WithLevel(InfoLevel))
assert.Equal(t, ioutil.Discard, golog.Writer())
}