mirror of
https://github.com/kubernetes/client-go.git
synced 2026-02-21 23:53:16 +00:00
3595e5242a
Using StartRecordingToSinkWithContext instead of StartRecordingToSink and StartLogging instead of StartStructuredLogging has several advantages: - Spawned goroutines no longer get stuck for extended periods of time during shutdown when passing in a context that gets canceled. - Log output can be directed towards a specific logger instead of the global default, for example one which writes to a testing.T instance. - The new methods return an error when something went wrong instead of merely recording the error. That last point is the reason for deprecating the old methods instead of merely adding new alternatives. Setting a context when constructing an EventBroadcaster makes calling Shutdown optional. It can also be used to specify the logger. Both EventRecorder interfaces in tools/events and tools/record now have a WithLogger helper. Using that method is optional, but recommended to support contextual logging properly. Without it, errors that occur while emitting an event are not associated with the caller. Kubernetes-commit: 27a68aee3a48340f7c14235f7fc24aa69aaeb8f6
85 lines
2.5 KiB
Go
85 lines
2.5 KiB
Go
/*
|
|
Copyright 2015 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 record
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"k8s.io/apimachinery/pkg/runtime"
|
|
"k8s.io/klog/v2"
|
|
)
|
|
|
|
// FakeRecorder is used as a fake during tests. It is thread safe. It is usable
|
|
// when created manually and not by NewFakeRecorder, however all events may be
|
|
// thrown away in this case.
|
|
type FakeRecorder struct {
|
|
Events chan string
|
|
|
|
IncludeObject bool
|
|
}
|
|
|
|
var _ EventRecorderLogger = &FakeRecorder{}
|
|
|
|
func objectString(object runtime.Object, includeObject bool) string {
|
|
if !includeObject {
|
|
return ""
|
|
}
|
|
return fmt.Sprintf(" involvedObject{kind=%s,apiVersion=%s}",
|
|
object.GetObjectKind().GroupVersionKind().Kind,
|
|
object.GetObjectKind().GroupVersionKind().GroupVersion(),
|
|
)
|
|
}
|
|
|
|
func annotationsString(annotations map[string]string) string {
|
|
if len(annotations) == 0 {
|
|
return ""
|
|
} else {
|
|
return " " + fmt.Sprint(annotations)
|
|
}
|
|
}
|
|
|
|
func (f *FakeRecorder) writeEvent(object runtime.Object, annotations map[string]string, eventtype, reason, messageFmt string, args ...interface{}) {
|
|
if f.Events != nil {
|
|
f.Events <- fmt.Sprintf(eventtype+" "+reason+" "+messageFmt, args...) +
|
|
objectString(object, f.IncludeObject) + annotationsString(annotations)
|
|
}
|
|
}
|
|
|
|
func (f *FakeRecorder) Event(object runtime.Object, eventtype, reason, message string) {
|
|
f.writeEvent(object, nil, eventtype, reason, "%s", message)
|
|
}
|
|
|
|
func (f *FakeRecorder) Eventf(object runtime.Object, eventtype, reason, messageFmt string, args ...interface{}) {
|
|
f.writeEvent(object, nil, eventtype, reason, messageFmt, args...)
|
|
}
|
|
|
|
func (f *FakeRecorder) AnnotatedEventf(object runtime.Object, annotations map[string]string, eventtype, reason, messageFmt string, args ...interface{}) {
|
|
f.writeEvent(object, annotations, eventtype, reason, messageFmt, args...)
|
|
}
|
|
|
|
func (f *FakeRecorder) WithLogger(logger klog.Logger) EventRecorderLogger {
|
|
return f
|
|
}
|
|
|
|
// NewFakeRecorder creates new fake event recorder with event channel with
|
|
// buffer of given size.
|
|
func NewFakeRecorder(bufferSize int) *FakeRecorder {
|
|
return &FakeRecorder{
|
|
Events: make(chan string, bufferSize),
|
|
}
|
|
}
|