forked from golang/glog
-
Notifications
You must be signed in to change notification settings - Fork 214
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
contextual logging: SetContextualLogger -> SetLoggerWithOptions
The advantage of SetLoggerWithOptions is that it can be used as a drop-in replacement for SetLogger, which allows us to deprecate SetLogger. Whether we actually do that is kept open for now.
- Loading branch information
Showing
2 changed files
with
94 additions
and
2 deletions.
There are no files selected for viewing
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 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
/* | ||
Copyright 2022 The Kubernetes Authors. | ||
Licensed 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 klog_test | ||
|
||
import ( | ||
"fmt" | ||
|
||
"github.com/go-logr/logr" | ||
"k8s.io/klog/v2" | ||
) | ||
|
||
func ExampleSetLogger() { | ||
// Logger is only used as backend, Background() returns klogr. | ||
klog.SetLogger(logr.Discard()) | ||
fmt.Printf("logger after SetLogger: %T\n", klog.Background().GetSink()) | ||
|
||
// Logger is only used as backend, Background() returns klogr. | ||
klog.SetLoggerWithOptions(logr.Discard(), klog.ContextualLogger(false)) | ||
fmt.Printf("logger after SetLoggerWithOptions with ContextualLogger(false): %T\n", klog.Background().GetSink()) | ||
|
||
// Logger is used as backend and directly. | ||
klog.SetLoggerWithOptions(logr.Discard(), klog.ContextualLogger(true)) | ||
fmt.Printf("logger after SetLoggerWithOptions with ContextualLogger(true): %T\n", klog.Background().GetSink()) | ||
|
||
// Output: | ||
// logger after SetLogger: *klog.klogger | ||
// logger after SetLoggerWithOptions with ContextualLogger(false): *klog.klogger | ||
// logger after SetLoggerWithOptions with ContextualLogger(true): logr.discardLogSink | ||
} |