-
Notifications
You must be signed in to change notification settings - Fork 281
/
service_core.go
255 lines (215 loc) · 6.64 KB
/
service_core.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
// Copyright (c) 2017 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package service
import (
"io"
"reflect"
"sync"
"time"
"go.uber.org/fx/auth"
"go.uber.org/fx/config"
"go.uber.org/fx/internal/util"
"go.uber.org/fx/metrics"
"go.uber.org/fx/tracing"
"go.uber.org/fx/ulog"
"go.uber.org/zap"
"github.com/go-validator/validator"
"github.com/opentracing/opentracing-go"
"github.com/pkg/errors"
"github.com/uber-go/tally"
jaegerconfig "github.com/uber/jaeger-client-go/config"
)
const instanceConfigName = "ServiceConfig"
type metricsCore struct {
metrics tally.Scope
statsReporter tally.CachedStatsReporter
metricsCloser io.Closer
runtimeCollector *metrics.RuntimeCollector
versionEmitter *versionMetricsEmitter
}
func (mc *metricsCore) Metrics() tally.Scope {
return mc.metrics
}
func (mc *metricsCore) MetricsCloser() io.Closer {
return mc.metricsCloser
}
func (mc *metricsCore) RuntimeMetricsCollector() *metrics.RuntimeCollector {
return mc.runtimeCollector
}
type tracerCore struct {
tracer opentracing.Tracer
tracerCloser io.Closer
tracerConfig jaegerconfig.Configuration
}
func (tc *tracerCore) Tracer() opentracing.Tracer {
return tc.tracer
}
type serviceConfig struct {
Name string `yaml:"name" validate:"nonzero"`
Owner string `yaml:"owner" validate:"nonzero"`
Description string `yaml:"description"`
Roles []string `yaml:"roles"`
}
// Implements Host interface
type serviceCore struct {
metricsCore
tracerCore
authClient auth.Client
configProvider config.Provider
logConfig ulog.Configuration
observer Observer
roles []string
scopeMux sync.Mutex
standardConfig serviceConfig
state State
moduleName string
}
var _ Host = &serviceCore{}
func (s *serviceCore) AuthClient() auth.Client {
return s.authClient
}
func (s *serviceCore) Name() string {
return s.standardConfig.Name
}
func (s *serviceCore) ModuleName() string {
return s.moduleName
}
func (s *serviceCore) Description() string {
return s.standardConfig.Description
}
// ServiceOwner is a string in config.
// Manager is also a struct that embeds Host
func (s *serviceCore) Owner() string {
return s.standardConfig.Owner
}
func (s *serviceCore) State() State {
return s.state
}
func (s *serviceCore) Roles() []string {
return s.standardConfig.Roles
}
func (s *serviceCore) Observer() Observer {
return s.observer
}
func (s *serviceCore) Config() config.Provider {
return s.configProvider
}
func (s *serviceCore) setupLogging() error {
cfg := s.configProvider.Get("logging")
if cfg.HasValue() {
if err := s.logConfig.Configure(cfg); err != nil {
return errors.Wrap(err, "failed to initialize logging from config")
}
} else {
// if no config - default to the regular one
s.logConfig = ulog.DefaultConfiguration()
}
logger, err := s.logConfig.Build(zap.Hooks(ulog.Metrics(s.metrics)))
if err != nil {
return errors.Wrap(err, "failed to build the logger")
}
// TODO(glib): SetLogger returns a deferral to clean up global log which is not used
ulog.SetLogger(logger)
return nil
}
func (s *serviceCore) setupStandardConfig() error {
if err := s.configProvider.Get(config.Root).Populate(&s.standardConfig); err != nil {
return errors.Wrap(err, "unable to load standard configuration")
}
if errs := validator.Validate(s.standardConfig); errs != nil {
zap.L().Error("Invalid service configuration", zap.Error(errs))
return errors.Wrap(errs, "service configuration failed validation")
}
return nil
}
func (s *serviceCore) setupMetrics() {
if s.Metrics() == nil {
s.metrics, s.statsReporter, s.metricsCloser = metrics.RootScope(s)
metrics.Freeze()
}
}
func (s *serviceCore) setupRuntimeMetricsCollector() error {
if s.RuntimeMetricsCollector() != nil {
return nil
}
var runtimeMetricsConfig metrics.RuntimeConfig
err := s.configProvider.Get("metrics.runtime").Populate(&runtimeMetricsConfig)
if err != nil {
return errors.Wrap(err, "unable to load runtime metrics configuration")
}
s.runtimeCollector = metrics.StartCollectingRuntimeMetrics(
s.metrics.SubScope("runtime"), time.Second, runtimeMetricsConfig,
)
return nil
}
func (s *serviceCore) setupVersionMetricsEmitter() {
s.versionEmitter = newVersionMetricsEmitter(s.metrics)
s.versionEmitter.start()
}
func (s *serviceCore) setupTracer() error {
if s.Tracer() != nil {
return nil
}
if err := s.configProvider.Get("tracing").Populate(&s.tracerConfig); err != nil {
return errors.Wrap(err, "unable to load tracing configuration")
}
tracer, closer, err := tracing.InitGlobalTracer(
&s.tracerConfig,
s.standardConfig.Name,
zap.L(),
s.metrics,
)
if err != nil {
return errors.Wrap(err, "unable to initialize global tracer")
}
s.tracer = tracer
s.tracerCloser = closer
return nil
}
func (s *serviceCore) setupObserver() {
if s.observer != nil {
loadInstanceConfig(s.configProvider, "service", s.observer)
if shc, ok := s.observer.(SetContainerer); ok {
shc.SetContainer(s)
}
}
}
func (s *serviceCore) setupAuthClient() {
if s.authClient != nil {
return
}
s.authClient = auth.Load(s)
}
func loadInstanceConfig(cfg config.Provider, key string, instance interface{}) bool {
fieldName := instanceConfigName
if field, found := util.FindField(instance, &fieldName, nil); found {
configValue := reflect.New(field.Type())
// Try to load the service config
err := cfg.Get(key).Populate(configValue.Interface())
if err != nil {
zap.L().Error("Unable to load instance config", zap.Error(err))
return false
}
instanceValue := reflect.ValueOf(instance).Elem()
instanceValue.FieldByName(fieldName).Set(configValue.Elem())
return true
}
return false
}