/
configurator_environment.go
174 lines (146 loc) · 5.65 KB
/
configurator_environment.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
/*
Copyright 2022 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 adapter
import (
"context"
"errors"
"fmt"
"net/http"
"go.uber.org/zap"
"knative.dev/pkg/logging"
"knative.dev/pkg/metrics"
"knative.dev/pkg/profiling"
"knative.dev/eventing/pkg/adapter/v2/util/crstatusevent"
)
// loggerConfiguratorFromEnvironment configures
// a logger using environment variables.
type loggerConfiguratorFromEnvironment struct {
env EnvConfigAccessor
}
// NewLoggerConfiguratorFromEnvironment returns an environment based logger configurator.
func NewLoggerConfiguratorFromEnvironment(env EnvConfigAccessor) LoggerConfigurator {
return &loggerConfiguratorFromEnvironment{
env: env,
}
}
// CreateLogger based on environment variables.
func (c *loggerConfiguratorFromEnvironment) CreateLogger(ctx context.Context) *zap.SugaredLogger {
return c.env.GetLogger()
}
// metricsExporterConfiguratorFromEnvironment configures
// a metrics exporter using environment variables.
type metricsExporterConfiguratorFromEnvironment struct {
env EnvConfigAccessor
}
// NewMetricsExporterConfiguratorFromEnvironment returns an environment based metrics exporter configurator.
func NewMetricsExporterConfiguratorFromEnvironment(env EnvConfigAccessor) MetricsExporterConfigurator {
return &metricsExporterConfiguratorFromEnvironment{
env: env,
}
}
// SetupMetricsExporter based on environment variables.
func (c *metricsExporterConfiguratorFromEnvironment) SetupMetricsExporter(ctx context.Context) {
logger := logging.FromContext(ctx)
mc, err := getMetricsConfigFromEnvironment(c.env)
if err != nil {
logger.Warn("metrics exporter not configured", zap.Error(err))
return
}
if err = metrics.UpdateExporter(ctx, *mc, logger); err != nil {
logger.Errorw("failed to create the metrics exporter", zap.Error(err))
}
}
// tracingConfiguratorFromEnvironment configures tracing using
// environment variables.
type tracingConfiguratorFromEnvironment struct {
env EnvConfigAccessor
}
// NewTracingConfiguratorFromEnvironment returns an environment based tracing configurator.
func NewTracingConfiguratorFromEnvironment(env EnvConfigAccessor) TracingConfigurator {
return &tracingConfiguratorFromEnvironment{
env: env,
}
}
// SetupTracing based on environment variables.
func (c *tracingConfiguratorFromEnvironment) SetupTracing(ctx context.Context, _ *TracingConfiguration) {
logger := logging.FromContext(ctx)
if err := c.env.SetupTracing(logger); err != nil {
// If tracing doesn't work, we will log an error, but allow the adapter
// to continue to start.
logger.Errorw("Error setting up trace publishing", zap.Error(err))
}
}
// cloudEventsStatusReporterConfiguratorFromEnvironment configures
// the CloudEvents status reporter using environment variables.
type cloudEventsStatusReporterConfiguratorFromEnvironment struct {
env EnvConfigAccessor
}
// NewCloudEventsStatusReporterConfiguratorFromEnvironment returns an environment based CloudEvents
// status reporter configurator.
func NewCloudEventsStatusReporterConfiguratorFromEnvironment(env EnvConfigAccessor) CloudEventsStatusReporterConfigurator {
return &cloudEventsStatusReporterConfiguratorFromEnvironment{
env: env,
}
}
// CreateCloudEventsStatusReporter based on environment variables.
// The reporter object is returned.
func (c *cloudEventsStatusReporterConfiguratorFromEnvironment) CreateCloudEventsStatusReporter(ctx context.Context) *crstatusevent.CRStatusEventClient {
logger := logging.FromContext(ctx)
mc, err := getMetricsConfigFromEnvironment(c.env)
if err != nil {
logger.Warn("CloudEvents client reporter not configured", zap.Error(err))
return nil
}
return crstatusevent.NewCRStatusEventClient(mc.ConfigMap)
}
// profilerConfiguratorFromEnvironment configures
// the profiler using environment variables.
type profilerConfiguratorFromEnvironment struct {
env EnvConfigAccessor
}
// NewProfilerConfiguratorFromEnvironment returns an environment based profiler configurator.
func NewProfilerConfiguratorFromEnvironment(env EnvConfigAccessor) ProfilerConfigurator {
return &profilerConfiguratorFromEnvironment{
env: env,
}
}
// CreateProfilingServer creates and return a profiling server when profiling is enabled,
// nil when it is not.
func (c *profilerConfiguratorFromEnvironment) CreateProfilingServer(ctx context.Context) *http.Server {
logger := logging.FromContext(ctx)
mc, err := getMetricsConfigFromEnvironment(c.env)
if err != nil {
logger.Warn("profiler not configured", zap.Error(err))
return nil
}
// Configure profiler using environment varibles.
enabled, err := profiling.ReadProfilingFlag(mc.ConfigMap)
switch {
case err != nil:
logger.Errorw("wrong profiler configuration", zap.Error(err))
return nil
case !enabled:
return nil
}
return profiling.NewServer(profiling.NewHandler(logger, true))
}
func getMetricsConfigFromEnvironment(env EnvConfigAccessor) (*metrics.ExporterOptions, error) {
metricsConfig, err := env.GetMetricsConfig()
switch {
case err != nil:
return nil, fmt.Errorf("failed to process metrics options from environment: %w", err)
case metricsConfig == nil || metricsConfig.ConfigMap == nil:
return nil, errors.New("environment metrics options not provided")
}
return metricsConfig, nil
}