gateway-api: set controller-runtime logger #27961
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit adds the dependency github.com/bombsimon/logrusr which is the logrus implementation of go-logr. It's used to pass a Cilium logrus logger instance to the controller-runtime (which uses go-logr). Signed-off-by: Marco Hofstetter <marco.hofstetter@isovalent.com>
Currently, the controller-runtime emits an error in the log, if the global logger instance (go-logr) isn't set after 30 seconds. (https://github.com/kubernetes-sigs/controller-runtime/blob/v0.15.1/pkg/log/log.go#L57-L62) ``` [controller-runtime] log.SetLogger(...) was never called, logs will not be displayed: goroutine 663 [running]: runtime/debug.Stack() /usr/local/go/src/runtime/debug/stack.go:24 +0x6b sigs.k8s.io/controller-runtime/pkg/log.eventuallyFulfillRoot() /go/pkg/mod/sigs.k8s.io/controller-runtime@v0.15.1/pkg/log/log.go:59 +0x9b sigs.k8s.io/controller-runtime/pkg/log.(*delegatingLogSink).WithValues(0xc00093fa00, {0xc00092e780, 0x2, 0x2}) /go/pkg/mod/sigs.k8s.io/controller-runtime@v0.15.1/pkg/log/deleg.go:168 +0x4b github.com/go-logr/logr.Logger.WithValues({{0x43f19e0, 0xc00093fa00}, 0x0}, {0xc00092e780, 0x2, 0x2}) /go/pkg/mod/github.com/go-logr/logr@v1.2.4/logr.go:323 +0x70 sigs.k8s.io/controller-runtime/pkg/builder.(*Builder).doController.func1(0xc00092e760) /go/pkg/mod/sigs.k8s.io/controller-runtime@v0.15.1/pkg/builder/controller.go:398 +0x227 sigs.k8s.io/controller-runtime/pkg/internal/controller.(*Controller).reconcileHandler(0xc00077c460, {0x43ec290, 0xc00003f360}, {0x3d2c480, 0xc00092e740}) /go/pkg/mod/sigs.k8s.io/controller-runtime@v0.15.1/pkg/internal/controller/controller.go:305 +0x276 sigs.k8s.io/controller-runtime/pkg/internal/controller.(*Controller).processNextWorkItem(0xc00077c460, {0x43ec290, 0xc00003f360}) /go/pkg/mod/sigs.k8s.io/controller-runtime@v0.15.1/pkg/internal/controller/controller.go:265 +0x3c5 sigs.k8s.io/controller-runtime/pkg/internal/controller.(*Controller).Start.func2.2() /go/pkg/mod/sigs.k8s.io/controller-runtime@v0.15.1/pkg/internal/controller/controller.go:226 +0xca created by sigs.k8s.io/controller-runtime/pkg/internal/controller.(*Controller).Start.func2 in goroutine 532 /go/pkg/mod/sigs.k8s.io/controller-runtime@v0.15.1/pkg/internal/controller/controller.go:222 +0x985 ``` Therefore, this commit explicitly sets the logger instances that should be used by the controller-runtime: * global logger * gateway-api controller logger Signed-off-by: Marco Hofstetter <marco.hofstetter@isovalent.com>
mhofstetter
added
kind/cleanup
|
/test |
joamaki
approved these changes
Sep 12, 2023
rolinh
approved these changes
Sep 15, 2023
maintainer-s-little-helper
bot
added
the
ready-to-merge
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently, the controller-runtime emits an error in the Cilium operator log, if the global logger instance (go-logr) isn't set after 30 seconds.
(https://github.com/kubernetes-sigs/controller-runtime/blob/v0.15.1/pkg/log/log.go#L57-L62)
In addition, the log messages of the controller-runtime aren't logged at all (
SetLogger(logr.New(NullLogSink{})))Therefore, this commit explicitly sets the logger instances that should be used by the controller-runtime: