/
config_watcher.go
271 lines (215 loc) · 7.15 KB
/
config_watcher.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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
/*
Copyright 2020 The Knative 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 source
import (
"context"
"go.uber.org/zap"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"knative.dev/pkg/configmap"
"knative.dev/pkg/logging"
"knative.dev/pkg/metrics"
tracingconfig "knative.dev/pkg/tracing/config"
)
const (
EnvLoggingCfg = "K_LOGGING_CONFIG"
EnvMetricsCfg = "K_METRICS_CONFIG"
EnvTracingCfg = "K_TRACING_CONFIG"
)
type ConfigAccessor interface {
ToEnvVars() []corev1.EnvVar
LoggingConfig() *logging.Config
MetricsConfig() *metrics.ExporterOptions
TracingConfig() *tracingconfig.Config
}
var _ ConfigAccessor = (*ConfigWatcher)(nil)
// ConfigWatcher keeps track of logging, metrics and tracing configurations by
// watching corresponding ConfigMaps.
type ConfigWatcher struct {
logger *zap.SugaredLogger
component string
// configurations remain nil if disabled
loggingCfg *logging.Config
metricsCfg *metrics.ExporterOptions
tracingCfg *tracingconfig.Config
}
// configWatcherOption is a function option for ConfigWatchers.
type configWatcherOption func(*ConfigWatcher, configmap.Watcher)
// WatchConfigurations returns a ConfigWatcher initialized with the given
// options. If no option is passed, the ConfigWatcher observes ConfigMaps for
// logging, metrics and tracing.
func WatchConfigurations(loggingCtx context.Context, component string,
cmw configmap.Watcher, opts ...configWatcherOption) *ConfigWatcher {
cw := &ConfigWatcher{
logger: logging.FromContext(loggingCtx),
component: component,
}
if len(opts) == 0 {
WithLogging(cw, cmw)
WithMetrics(cw, cmw)
WithTracing(cw, cmw)
} else {
for _, opt := range opts {
opt(cw, cmw)
}
}
return cw
}
// WithLogging observes a logging ConfigMap.
func WithLogging(cw *ConfigWatcher, cmw configmap.Watcher) {
cw.loggingCfg = &logging.Config{}
watchConfigMap(cmw, logging.ConfigMapName(), cw.updateFromLoggingConfigMap)
}
// WithMetrics observes a metrics ConfigMap.
func WithMetrics(cw *ConfigWatcher, cmw configmap.Watcher) {
cw.metricsCfg = &metrics.ExporterOptions{}
watchConfigMap(cmw, metrics.ConfigMapName(), cw.updateFromMetricsConfigMap)
}
// WithTracing observes a tracing ConfigMap.
func WithTracing(cw *ConfigWatcher, cmw configmap.Watcher) {
cw.tracingCfg = &tracingconfig.Config{}
watchConfigMap(cmw, tracingconfig.ConfigName, cw.updateFromTracingConfigMap)
}
func watchConfigMap(cmw configmap.Watcher, cmName string, obs configmap.Observer) {
if dcmw, ok := cmw.(configmap.DefaultingWatcher); ok {
dcmw.WatchWithDefault(corev1.ConfigMap{
ObjectMeta: metav1.ObjectMeta{Name: cmName},
Data: map[string]string{},
}, obs)
} else {
cmw.Watch(cmName, obs)
}
}
// LoggingConfig returns the logging configuration from the ConfigWatcher.
func (cw *ConfigWatcher) LoggingConfig() *logging.Config {
if cw == nil {
return nil
}
return cw.loggingCfg
}
// MetricsConfig returns the metrics configuration from the ConfigWatcher.
func (cw *ConfigWatcher) MetricsConfig() *metrics.ExporterOptions {
if cw == nil {
return nil
}
return cw.metricsCfg
}
// TracingConfig returns the tracing configuration from the ConfigWatcher.
func (cw *ConfigWatcher) TracingConfig() *tracingconfig.Config {
if cw == nil {
return nil
}
return cw.tracingCfg
}
func (cw *ConfigWatcher) updateFromLoggingConfigMap(cfg *corev1.ConfigMap) {
if cfg == nil {
return
}
delete(cfg.Data, "_example")
loggingCfg, err := logging.NewConfigFromConfigMap(cfg)
if err != nil {
cw.logger.Warnw("failed to create logging config from ConfigMap", zap.String("cfg.Name", cfg.Name))
return
}
cw.loggingCfg = loggingCfg
cw.logger.Debugw("Updated logging config from ConfigMap", zap.Any("ConfigMap", cfg))
}
func (cw *ConfigWatcher) updateFromMetricsConfigMap(cfg *corev1.ConfigMap) {
if cfg == nil {
return
}
delete(cfg.Data, "_example")
cw.metricsCfg = &metrics.ExporterOptions{
Domain: metrics.Domain(),
Component: cw.component,
ConfigMap: cfg.Data,
}
cw.logger.Debugw("Updated metrics config from ConfigMap", zap.Any("ConfigMap", cfg))
}
func (cw *ConfigWatcher) updateFromTracingConfigMap(cfg *corev1.ConfigMap) {
if cfg == nil {
return
}
delete(cfg.Data, "_example")
tracingCfg, err := tracingconfig.NewTracingConfigFromMap(cfg.Data)
if err != nil {
cw.logger.Warnw("failed to create tracing config from ConfigMap", zap.String("cfg.Name", cfg.Name))
return
}
cw.tracingCfg = tracingCfg
cw.logger.Debugw("Updated tracing config from ConfigMap", zap.Any("ConfigMap", cfg))
}
// ToEnvVars serializes the contents of the ConfigWatcher to individual
// environment variables.
func (cw *ConfigWatcher) ToEnvVars() []corev1.EnvVar {
envs := make([]corev1.EnvVar, 0, 3)
envs = maybeAppendEnvVar(envs, cw.loggingConfigEnvVar(), cw.LoggingConfig() != nil)
envs = maybeAppendEnvVar(envs, cw.metricsConfigEnvVar(), cw.MetricsConfig() != nil)
envs = maybeAppendEnvVar(envs, cw.tracingConfigEnvVar(), cw.TracingConfig() != nil)
return envs
}
// maybeAppendEnvVar appends an EnvVar only if the condition boolean is true.
func maybeAppendEnvVar(envs []corev1.EnvVar, env corev1.EnvVar, cond bool) []corev1.EnvVar {
if !cond {
return envs
}
return append(envs, env)
}
// loggingConfigEnvVar returns an EnvVar containing the serialized logging
// configuration from the ConfigWatcher.
func (cw *ConfigWatcher) loggingConfigEnvVar() corev1.EnvVar {
cfg, err := logging.ConfigToJSON(cw.LoggingConfig())
if err != nil {
cw.logger.Warnw("Error while serializing logging config", zap.Error(err))
}
return corev1.EnvVar{
Name: EnvLoggingCfg,
Value: cfg,
}
}
// metricsConfigEnvVar returns an EnvVar containing the serialized metrics
// configuration from the ConfigWatcher.
func (cw *ConfigWatcher) metricsConfigEnvVar() corev1.EnvVar {
cfg, err := metrics.OptionsToJSON(cw.MetricsConfig())
if err != nil {
cw.logger.Warnw("Error while serializing metrics config", zap.Error(err))
}
return corev1.EnvVar{
Name: EnvMetricsCfg,
Value: cfg,
}
}
// tracingConfigEnvVar returns an EnvVar containing the serialized tracing
// configuration from the ConfigWatcher.
func (cw *ConfigWatcher) tracingConfigEnvVar() corev1.EnvVar {
cfg, err := tracingconfig.TracingConfigToJSON(cw.TracingConfig())
if err != nil {
cw.logger.Warnw("Error while serializing tracing config", zap.Error(err))
}
return corev1.EnvVar{
Name: EnvTracingCfg,
Value: cfg,
}
}
// EmptyVarsGenerator generates empty env vars. Intended to be used in tests.
type EmptyVarsGenerator struct {
ConfigAccessor
}
var _ ConfigAccessor = (*EmptyVarsGenerator)(nil)
func (g *EmptyVarsGenerator) ToEnvVars() []corev1.EnvVar {
return []corev1.EnvVar{
{Name: EnvLoggingCfg},
{Name: EnvMetricsCfg},
{Name: EnvTracingCfg},
}
}