Skip to content

Commit 8546fda

Browse files
committed
Bump github.com/go-logr/zapr & github.com/go-logr/logr to v1
1 parent 0cce21b commit 8546fda

File tree

16 files changed

+144
-142
lines changed

16 files changed

+144
-142
lines changed

examples/configfile/custom/v1alpha1/zz_generated.deepcopy.go

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

go.mod

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ go 1.16
55
require (
66
github.com/evanphx/json-patch v4.11.0+incompatible
77
github.com/fsnotify/fsnotify v1.4.9
8-
github.com/go-logr/logr v0.4.0
9-
github.com/go-logr/zapr v0.4.0
8+
github.com/go-logr/logr v1.1.0
9+
github.com/go-logr/zapr v1.1.0
1010
github.com/imdario/mergo v0.3.12 // indirect
1111
github.com/onsi/ginkgo v1.16.4
1212
github.com/onsi/gomega v1.15.0
@@ -23,6 +23,7 @@ require (
2323
k8s.io/apimachinery v0.22.2
2424
k8s.io/client-go v0.22.2
2525
k8s.io/component-base v0.22.2
26+
k8s.io/klog/v2 v2.20.0 // indirect
2627
k8s.io/utils v0.0.0-20210819203725-bdf08cb9a70a
2728
sigs.k8s.io/yaml v1.2.0
2829
)

go.sum

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -124,10 +124,12 @@ github.com/go-logfmt/logfmt v0.4.0/go.mod h1:3RMwSq7FuexP4Kalkev3ejPJsZTpXXBr9+V
124124
github.com/go-logfmt/logfmt v0.5.0/go.mod h1:wCYkCAKZfumFQihp8CzCvQ3paCTfi41vtzG1KdI/P7A=
125125
github.com/go-logr/logr v0.1.0/go.mod h1:ixOQHD9gLJUVQQ2ZOR7zLEifBX6tGkNJF4QyIY7sIas=
126126
github.com/go-logr/logr v0.2.0/go.mod h1:z6/tIYblkpsD+a4lm/fGIIU9mZ+XfAiaFtq7xTgseGU=
127-
github.com/go-logr/logr v0.4.0 h1:K7/B1jt6fIBQVd4Owv2MqGQClcgf0R266+7C/QjRcLc=
128127
github.com/go-logr/logr v0.4.0/go.mod h1:z6/tIYblkpsD+a4lm/fGIIU9mZ+XfAiaFtq7xTgseGU=
129-
github.com/go-logr/zapr v0.4.0 h1:uc1uML3hRYL9/ZZPdgHS/n8Nzo+eaYL/Efxkkamf7OM=
130-
github.com/go-logr/zapr v0.4.0/go.mod h1:tabnROwaDl0UNxkVeFRbY8bwB37GwRv0P8lg6aAiEnk=
128+
github.com/go-logr/logr v1.0.0/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=
129+
github.com/go-logr/logr v1.1.0 h1:nAbevmWlS2Ic4m4+/An5NXkaGqlqpbBgdcuThZxnZyI=
130+
github.com/go-logr/logr v1.1.0/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A=
131+
github.com/go-logr/zapr v1.1.0 h1:rZHor2gcVGCG11UlKl+WUsfCMOOi2k/mTCDKDK6zZws=
132+
github.com/go-logr/zapr v1.1.0/go.mod h1:YShqdLLTU346TNVu8Tvwe3bOo6gc75oZ1joeE+1lYdQ=
131133
github.com/go-openapi/jsonpointer v0.19.3/go.mod h1:Pl9vOtqEWErmShwVjC8pYs9cog34VGT37dQOVbmoatg=
132134
github.com/go-openapi/jsonpointer v0.19.5/go.mod h1:Pl9vOtqEWErmShwVjC8pYs9cog34VGT37dQOVbmoatg=
133135
github.com/go-openapi/jsonreference v0.19.3/go.mod h1:rjx6GuL8TTa9VaixXglHmQmIL98+wF9xc8zWvFonSJ8=
@@ -752,8 +754,9 @@ k8s.io/gengo v0.0.0-20200413195148-3a45101e95ac/go.mod h1:ezvh/TsK7cY6rbqRK0oQQ8
752754
k8s.io/gengo v0.0.0-20201214224949-b6c5ce23f027/go.mod h1:FiNAH4ZV3gBg2Kwh89tzAEV2be7d5xI0vBa/VySYy3E=
753755
k8s.io/klog/v2 v2.0.0/go.mod h1:PBfzABfn139FHAV07az/IF9Wp1bkk3vpT2XSJ76fSDE=
754756
k8s.io/klog/v2 v2.2.0/go.mod h1:Od+F08eJP+W3HUb4pSrPpgp9DGU4GzlpG/TmITuYh/Y=
755-
k8s.io/klog/v2 v2.9.0 h1:D7HV+n1V57XeZ0m6tdRkfknthUaM06VFbWldOFh8kzM=
756757
k8s.io/klog/v2 v2.9.0/go.mod h1:hy9LJ/NvuK+iVyP4Ehqva4HxZG/oXyIS3n3Jmire4Ec=
758+
k8s.io/klog/v2 v2.20.0 h1:tlyxlSvd63k7axjhuchckaRJm+a92z5GSOrTOQY5sHw=
759+
k8s.io/klog/v2 v2.20.0/go.mod h1:Gm8eSIfQN6457haJuPaMxZw4wyP5k+ykPFlrhQDvhvw=
757760
k8s.io/kube-openapi v0.0.0-20210421082810-95288971da7e h1:KLHHjkdQFomZy8+06csTWZ0m1343QqxZhR2LJ1OxCYM=
758761
k8s.io/kube-openapi v0.0.0-20210421082810-95288971da7e/go.mod h1:vHXdDvt9+2spS2Rx9ql3I8tycm3H9FDfdUoIuKCefvw=
759762
k8s.io/utils v0.0.0-20210819203725-bdf08cb9a70a h1:8dYfu/Fc9Gz2rNJKB9IQRGgQOh2clmRzNIPPY1xLY5g=

pkg/builder/controller.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,7 @@ func (blder *Builder) doController(r reconcile.Reconciler) error {
305305
}
306306

307307
// Setup the logger.
308-
if ctrlOptions.Log == nil {
308+
if ctrlOptions.Log.GetSink() == nil {
309309
ctrlOptions.Log = blder.mgr.GetLogger()
310310
}
311311
ctrlOptions.Log = ctrlOptions.Log.WithValues("reconciler group", gvk.Group, "reconciler kind", gvk.Kind)

pkg/builder/controller_test.go

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,22 @@ type testLogger struct {
5757
logr.Logger
5858
}
5959

60-
func (l *testLogger) WithName(_ string) logr.Logger {
60+
func (l *testLogger) Init(info logr.RuntimeInfo) {
61+
}
62+
63+
func (l *testLogger) Enabled(level int) bool {
64+
return true
65+
}
66+
67+
func (l *testLogger) Info(level int, msg string, keysAndValues ...interface{}) {
68+
69+
}
70+
71+
func (l *testLogger) WithValues(keysAndValues ...interface{}) logr.LogSink {
6172
return l
6273
}
63-
func (l *testLogger) WithValues(_ ...interface{}) logr.Logger {
74+
75+
func (l *testLogger) WithName(name string) logr.LogSink {
6476
return l
6577
}
6678

@@ -227,7 +239,7 @@ var _ = Describe("application", func() {
227239

228240
logger := &testLogger{}
229241
newController = func(name string, mgr manager.Manager, options controller.Options) (controller.Controller, error) {
230-
if options.Log == logger {
242+
if options.Log.GetSink() == logger {
231243
return controller.New(name, mgr, options)
232244
}
233245
return nil, fmt.Errorf("logger expected %T but found %T", logger, options.Log)
@@ -240,7 +252,7 @@ var _ = Describe("application", func() {
240252
instance, err := ControllerManagedBy(m).
241253
For(&appsv1.ReplicaSet{}).
242254
Owns(&appsv1.ReplicaSet{}).
243-
WithLogger(logger).
255+
WithLogger(logr.New(logger)).
244256
Build(noop)
245257
Expect(err).NotTo(HaveOccurred())
246258
Expect(instance).NotTo(BeNil())

pkg/cluster/cluster.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ func setOptionsDefaults(options Options) Options {
245245
}
246246
}
247247

248-
if options.Logger == nil {
248+
if options.Logger.GetSink() == nil {
249249
options.Logger = logf.RuntimeLog.WithName("cluster")
250250
}
251251

pkg/config/v1alpha1/zz_generated.deepcopy.go

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pkg/controller/controller.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ func NewUnmanaged(name string, mgr manager.Manager, options Options) (Controller
104104
return nil, fmt.Errorf("must specify Name for Controller")
105105
}
106106

107-
if options.Log == nil {
107+
if options.Log.GetSink() == nil {
108108
options.Log = mgr.GetLogger()
109109
}
110110

pkg/internal/recorder/recorder_test.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ var _ = Describe("recorder.Provider", func() {
2929
makeBroadcaster := func() (record.EventBroadcaster, bool) { return record.NewBroadcaster(), true }
3030
Describe("NewProvider", func() {
3131
It("should return a provider instance and a nil error.", func() {
32-
provider, err := recorder.NewProvider(cfg, scheme.Scheme, logr.DiscardLogger{}, makeBroadcaster)
32+
provider, err := recorder.NewProvider(cfg, scheme.Scheme, logr.Discard(), makeBroadcaster)
3333
Expect(provider).NotTo(BeNil())
3434
Expect(err).NotTo(HaveOccurred())
3535
})
@@ -38,14 +38,14 @@ var _ = Describe("recorder.Provider", func() {
3838
// Invalid the config
3939
cfg1 := *cfg
4040
cfg1.Host = "invalid host"
41-
_, err := recorder.NewProvider(&cfg1, scheme.Scheme, logr.DiscardLogger{}, makeBroadcaster)
41+
_, err := recorder.NewProvider(&cfg1, scheme.Scheme, logr.Discard(), makeBroadcaster)
4242
Expect(err).NotTo(BeNil())
4343
Expect(err.Error()).To(ContainSubstring("failed to init client"))
4444
})
4545
})
4646
Describe("GetEventRecorder", func() {
4747
It("should return a recorder instance.", func() {
48-
provider, err := recorder.NewProvider(cfg, scheme.Scheme, logr.DiscardLogger{}, makeBroadcaster)
48+
provider, err := recorder.NewProvider(cfg, scheme.Scheme, logr.Discard(), makeBroadcaster)
4949
Expect(err).NotTo(HaveOccurred())
5050

5151
recorder := provider.GetEventRecorderFor("test")

pkg/log/deleg.go

Lines changed: 36 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,15 @@ import (
2525
// loggerPromise knows how to populate a concrete logr.Logger
2626
// with options, given an actual base logger later on down the line.
2727
type loggerPromise struct {
28-
logger *DelegatingLogger
28+
logger *DelegatingLogSink
2929
childPromises []*loggerPromise
3030
promisesLock sync.Mutex
3131

32-
name *string
33-
tags []interface{}
34-
level int
32+
name *string
33+
tags []interface{}
3534
}
3635

37-
func (p *loggerPromise) WithName(l *DelegatingLogger, name string) *loggerPromise {
36+
func (p *loggerPromise) WithName(l *DelegatingLogSink, name string) *loggerPromise {
3837
res := &loggerPromise{
3938
logger: l,
4039
name: &name,
@@ -48,7 +47,7 @@ func (p *loggerPromise) WithName(l *DelegatingLogger, name string) *loggerPromis
4847
}
4948

5049
// WithValues provides a new Logger with the tags appended.
51-
func (p *loggerPromise) WithValues(l *DelegatingLogger, tags ...interface{}) *loggerPromise {
50+
func (p *loggerPromise) WithValues(l *DelegatingLogSink, tags ...interface{}) *loggerPromise {
5251
res := &loggerPromise{
5352
logger: l,
5453
tags: tags,
@@ -61,61 +60,54 @@ func (p *loggerPromise) WithValues(l *DelegatingLogger, tags ...interface{}) *lo
6160
return res
6261
}
6362

64-
func (p *loggerPromise) V(l *DelegatingLogger, level int) *loggerPromise {
65-
res := &loggerPromise{
66-
logger: l,
67-
level: level,
68-
promisesLock: sync.Mutex{},
69-
}
70-
71-
p.promisesLock.Lock()
72-
defer p.promisesLock.Unlock()
73-
p.childPromises = append(p.childPromises, res)
74-
return res
75-
}
76-
7763
// Fulfill instantiates the Logger with the provided logger.
78-
func (p *loggerPromise) Fulfill(parentLogger logr.Logger) {
79-
logger := logr.WithCallDepth(parentLogger, 1)
64+
func (p *loggerPromise) Fulfill(parentLogSink logr.LogSink) {
65+
sink := parentLogSink
66+
8067
if p.name != nil {
81-
logger = logger.WithName(*p.name)
68+
sink = sink.WithName(*p.name)
8269
}
8370

8471
if p.tags != nil {
85-
logger = logger.WithValues(p.tags...)
86-
}
87-
if p.level != 0 {
88-
logger = logger.V(p.level)
72+
sink = sink.WithValues(p.tags...)
8973
}
9074

9175
p.logger.lock.Lock()
92-
p.logger.logger = logger
76+
p.logger.logger = sink
9377
p.logger.promise = nil
9478
p.logger.lock.Unlock()
9579

9680
for _, childPromise := range p.childPromises {
97-
childPromise.Fulfill(logger)
81+
childPromise.Fulfill(sink)
9882
}
9983
}
10084

101-
// DelegatingLogger is a logr.Logger that delegates to another logr.Logger.
85+
// DelegatingLogSink is a logr.LogSink that delegates to another logr.LogSink.
10286
// If the underlying promise is not nil, it registers calls to sub-loggers with
10387
// the logging factory to be populated later, and returns a new delegating
10488
// logger. It expects to have *some* logr.Logger set at all times (generally
10589
// a no-op logger before the promises are fulfilled).
106-
type DelegatingLogger struct {
90+
type DelegatingLogSink struct {
10791
lock sync.RWMutex
108-
logger logr.Logger
92+
logger logr.LogSink
10993
promise *loggerPromise
94+
info logr.RuntimeInfo
95+
}
96+
97+
// Init implements logr.LogSink.
98+
func (l *DelegatingLogSink) Init(info logr.RuntimeInfo) {
99+
l.lock.Lock()
100+
defer l.lock.Unlock()
101+
l.info = info
110102
}
111103

112104
// Enabled tests whether this Logger is enabled. For example, commandline
113105
// flags might be used to set the logging verbosity and disable some info
114106
// logs.
115-
func (l *DelegatingLogger) Enabled() bool {
107+
func (l *DelegatingLogSink) Enabled(v int) bool {
116108
l.lock.RLock()
117109
defer l.lock.RUnlock()
118-
return l.logger.Enabled()
110+
return l.logger.Enabled(v)
119111
}
120112

121113
// Info logs a non-error message with the given key/value pairs as context.
@@ -124,10 +116,10 @@ func (l *DelegatingLogger) Enabled() bool {
124116
// the log line. The key/value pairs can then be used to add additional
125117
// variable information. The key/value pairs should alternate string
126118
// keys and arbitrary values.
127-
func (l *DelegatingLogger) Info(msg string, keysAndValues ...interface{}) {
119+
func (l *DelegatingLogSink) Info(level int, msg string, keysAndValues ...interface{}) {
128120
l.lock.RLock()
129121
defer l.lock.RUnlock()
130-
l.logger.Info(msg, keysAndValues...)
122+
l.logger.Info(level, msg, keysAndValues...)
131123
}
132124

133125
// Error logs an error, with the given message and key/value pairs as context.
@@ -138,57 +130,38 @@ func (l *DelegatingLogger) Info(msg string, keysAndValues ...interface{}) {
138130
// The msg field should be used to add context to any underlying error,
139131
// while the err field should be used to attach the actual error that
140132
// triggered this log line, if present.
141-
func (l *DelegatingLogger) Error(err error, msg string, keysAndValues ...interface{}) {
133+
func (l *DelegatingLogSink) Error(err error, msg string, keysAndValues ...interface{}) {
142134
l.lock.RLock()
143135
defer l.lock.RUnlock()
144136
l.logger.Error(err, msg, keysAndValues...)
145137
}
146138

147-
// V returns an Logger value for a specific verbosity level, relative to
148-
// this Logger. In other words, V values are additive. V higher verbosity
149-
// level means a log message is less important. It's illegal to pass a log
150-
// level less than zero.
151-
func (l *DelegatingLogger) V(level int) logr.Logger {
152-
l.lock.RLock()
153-
defer l.lock.RUnlock()
154-
155-
if l.promise == nil {
156-
return l.logger.V(level)
157-
}
158-
159-
res := &DelegatingLogger{logger: l.logger}
160-
promise := l.promise.V(res, level)
161-
res.promise = promise
162-
163-
return res
164-
}
165-
166139
// WithName provides a new Logger with the name appended.
167-
func (l *DelegatingLogger) WithName(name string) logr.Logger {
140+
func (l *DelegatingLogSink) WithName(name string) logr.LogSink {
168141
l.lock.RLock()
169142
defer l.lock.RUnlock()
170143

171144
if l.promise == nil {
172145
return l.logger.WithName(name)
173146
}
174147

175-
res := &DelegatingLogger{logger: l.logger}
148+
res := &DelegatingLogSink{logger: l.logger}
176149
promise := l.promise.WithName(res, name)
177150
res.promise = promise
178151

179152
return res
180153
}
181154

182155
// WithValues provides a new Logger with the tags appended.
183-
func (l *DelegatingLogger) WithValues(tags ...interface{}) logr.Logger {
156+
func (l *DelegatingLogSink) WithValues(tags ...interface{}) logr.LogSink {
184157
l.lock.RLock()
185158
defer l.lock.RUnlock()
186159

187160
if l.promise == nil {
188161
return l.logger.WithValues(tags...)
189162
}
190163

191-
res := &DelegatingLogger{logger: l.logger}
164+
res := &DelegatingLogSink{logger: l.logger}
192165
promise := l.promise.WithValues(res, tags...)
193166
res.promise = promise
194167

@@ -198,16 +171,16 @@ func (l *DelegatingLogger) WithValues(tags ...interface{}) logr.Logger {
198171
// Fulfill switches the logger over to use the actual logger
199172
// provided, instead of the temporary initial one, if this method
200173
// has not been previously called.
201-
func (l *DelegatingLogger) Fulfill(actual logr.Logger) {
174+
func (l *DelegatingLogSink) Fulfill(actual logr.LogSink) {
202175
if l.promise != nil {
203176
l.promise.Fulfill(actual)
204177
}
205178
}
206179

207-
// NewDelegatingLogger constructs a new DelegatingLogger which uses
180+
// NewDelegatingLogSink constructs a new DelegatingLogSink which uses
208181
// the given logger before it's promise is fulfilled.
209-
func NewDelegatingLogger(initial logr.Logger) *DelegatingLogger {
210-
l := &DelegatingLogger{
182+
func NewDelegatingLogSink(initial logr.LogSink) *DelegatingLogSink {
183+
l := &DelegatingLogSink{
211184
logger: initial,
212185
promise: &loggerPromise{promisesLock: sync.Mutex{}},
213186
}

0 commit comments

Comments
 (0)