/
event.go
123 lines (102 loc) · 3.24 KB
/
event.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
/*
Copyright 2022 Nokia.
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 event records Kubernetes events.
package event
import (
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/client-go/tools/record"
)
// A Type of event.
type Type string
// Event types. See below for valid types.
// https://godoc.org/k8s.io/client-go/tools/record#EventRecorder
var (
TypeNormal Type = "Normal"
TypeWarning Type = "Warning"
)
// Reason an event occurred.
type Reason string
// An Event relating to a Network device driver resource.
type Event struct {
Type Type
Reason Reason
Message string
Annotations map[string]string
}
// Normal returns a normal, informational event.
func Normal(r Reason, message string, keysAndValues ...string) Event {
e := Event{
Type: TypeNormal,
Reason: r,
Message: message,
Annotations: map[string]string{},
}
sliceMap(keysAndValues, e.Annotations)
return e
}
// Warning returns a warning event, typically due to an error.
func Warning(r Reason, err error, keysAndValues ...string) Event {
e := Event{
Type: TypeWarning,
Reason: r,
Message: err.Error(),
Annotations: map[string]string{},
}
sliceMap(keysAndValues, e.Annotations)
return e
}
// A Recorder records Kubernetes events.
type Recorder interface {
Event(obj runtime.Object, e Event)
WithAnnotations(keysAndValues ...string) Recorder
}
// An APIRecorder records Kubernetes events to an API server.
type APIRecorder struct {
kube record.EventRecorder
annotations map[string]string
}
// NewAPIRecorder returns an APIRecorder that records Kubernetes events to an
// APIServer using the supplied EventRecorder.
func NewAPIRecorder(r record.EventRecorder) *APIRecorder {
return &APIRecorder{kube: r, annotations: map[string]string{}}
}
// Event records the supplied event.
func (r *APIRecorder) Event(obj runtime.Object, e Event) {
r.kube.AnnotatedEventf(obj, r.annotations, string(e.Type), string(e.Reason), e.Message)
}
// WithAnnotations returns a new *APIRecorder that includes the supplied
// annotations with all recorded events.
func (r *APIRecorder) WithAnnotations(keysAndValues ...string) Recorder {
ar := NewAPIRecorder(r.kube)
for k, v := range r.annotations {
ar.annotations[k] = v
}
sliceMap(keysAndValues, ar.annotations)
return ar
}
func sliceMap(from []string, to map[string]string) {
for i := 0; i+1 < len(from); i += 2 {
k, v := from[i], from[i+1]
to[k] = v
}
}
// A NopRecorder does nothing.
type NopRecorder struct{}
// NewNopRecorder returns a Recorder that does nothing.
func NewNopRecorder() *NopRecorder {
return &NopRecorder{}
}
// Event does nothing.
func (r *NopRecorder) Event(_ runtime.Object, _ Event) {}
// WithAnnotations does nothing.
func (r *NopRecorder) WithAnnotations(_ ...string) Recorder { return r }