From 3aceb31568b531063369c191636a36b68f48ae59 Mon Sep 17 00:00:00 2001
From: Andrew Wilkins <axw@elastic.co>
Date: Mon, 12 Oct 2020 12:34:58 +0800
Subject: [PATCH] libbeat/logp: introduce Logger.WithOptions (#21671)

* libbeat/logp: introduce Logger.WithOptions

Add a Logger.WithOptions method, which clones
the logger and applies given options. For example,
this can be used to obtain a clone of the logger
with sampling/rate limiting applied.
---
 libbeat/logp/logger.go      |  6 +++++
 libbeat/logp/logger_test.go | 52 +++++++++++++++++++++++++++++++++++++
 2 files changed, 58 insertions(+)
 create mode 100644 libbeat/logp/logger_test.go

diff --git a/libbeat/logp/logger.go b/libbeat/logp/logger.go
index 6f1c42fe022..2bbe6b3ce53 100644
--- a/libbeat/logp/logger.go
+++ b/libbeat/logp/logger.go
@@ -50,6 +50,12 @@ func NewLogger(selector string, options ...LogOption) *Logger {
 	return newLogger(loadLogger().rootLogger, selector, options...)
 }
 
+// WithOptions returns a clone of l with options applied.
+func (l *Logger) WithOptions(options ...LogOption) *Logger {
+	cloned := l.logger.WithOptions(options...)
+	return &Logger{cloned, cloned.Sugar()}
+}
+
 // With creates a child logger and adds structured context to it. Fields added
 // to the child don't affect the parent, and vice versa.
 func (l *Logger) With(args ...interface{}) *Logger {
diff --git a/libbeat/logp/logger_test.go b/libbeat/logp/logger_test.go
new file mode 100644
index 00000000000..eaf8a1070ce
--- /dev/null
+++ b/libbeat/logp/logger_test.go
@@ -0,0 +1,52 @@
+// Licensed to Elasticsearch B.V. under one or more contributor
+// license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright
+// ownership. Elasticsearch B.V. licenses this file to you 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 logp
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"go.uber.org/zap"
+	"go.uber.org/zap/zapcore"
+	"go.uber.org/zap/zaptest/observer"
+)
+
+func TestLoggerWithOptions(t *testing.T) {
+	core1, observed1 := observer.New(zapcore.DebugLevel)
+	core2, observed2 := observer.New(zapcore.DebugLevel)
+
+	logger1 := NewLogger("bo", zap.WrapCore(func(in zapcore.Core) zapcore.Core {
+		return zapcore.NewTee(in, core1)
+	}))
+	logger2 := logger1.WithOptions(zap.WrapCore(func(in zapcore.Core) zapcore.Core {
+		return zapcore.NewTee(in, core2)
+	}))
+
+	logger1.Info("hello logger1")             // should just go to the first observer
+	logger2.Info("hello logger1 and logger2") // should go to both observers
+
+	observedEntries1 := observed1.All()
+	require.Len(t, observedEntries1, 2)
+	assert.Equal(t, "hello logger1", observedEntries1[0].Message)
+	assert.Equal(t, "hello logger1 and logger2", observedEntries1[1].Message)
+
+	observedEntries2 := observed2.All()
+	require.Len(t, observedEntries2, 1)
+	assert.Equal(t, "hello logger1 and logger2", observedEntries2[0].Message)
+}