-
Notifications
You must be signed in to change notification settings - Fork 488
/
modules.go
449 lines (372 loc) · 15.4 KB
/
modules.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
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
package app
import (
"fmt"
"net/http"
"path"
"github.com/go-kit/log/level"
"github.com/grafana/dskit/kv/codec"
"github.com/grafana/dskit/kv/memberlist"
"github.com/grafana/dskit/modules"
"github.com/grafana/dskit/ring"
"github.com/grafana/dskit/services"
"github.com/prometheus/client_golang/prometheus"
"github.com/thanos-io/thanos/pkg/discovery/dns"
"github.com/weaveworks/common/middleware"
"github.com/weaveworks/common/server"
"github.com/grafana/tempo/modules/compactor"
"github.com/grafana/tempo/modules/distributor"
"github.com/grafana/tempo/modules/frontend"
frontend_v1pb "github.com/grafana/tempo/modules/frontend/v1/frontendv1pb"
"github.com/grafana/tempo/modules/generator"
"github.com/grafana/tempo/modules/ingester"
"github.com/grafana/tempo/modules/overrides"
"github.com/grafana/tempo/modules/querier"
tempo_storage "github.com/grafana/tempo/modules/storage"
"github.com/grafana/tempo/pkg/api"
tempo_ring "github.com/grafana/tempo/pkg/ring"
"github.com/grafana/tempo/pkg/tempopb"
"github.com/grafana/tempo/pkg/usagestats"
"github.com/grafana/tempo/pkg/util/log"
util_log "github.com/grafana/tempo/pkg/util/log"
"github.com/grafana/tempo/tempodb/backend"
"github.com/grafana/tempo/tempodb/backend/azure"
"github.com/grafana/tempo/tempodb/backend/gcs"
"github.com/grafana/tempo/tempodb/backend/local"
"github.com/grafana/tempo/tempodb/backend/s3"
)
// The various modules that make up tempo.
const (
Ring string = "ring"
MetricsGeneratorRing string = "metrics-generator-ring"
Overrides string = "overrides"
Server string = "server"
Distributor string = "distributor"
Ingester string = "ingester"
MetricsGenerator string = "metrics-generator"
Querier string = "querier"
QueryFrontend string = "query-frontend"
Compactor string = "compactor"
Store string = "store"
MemberlistKV string = "memberlist-kv"
SingleBinary string = "all"
ScalableSingleBinary string = "scalable-single-binary"
UsageReport string = "usage-report"
)
func (t *App) initServer() (services.Service, error) {
t.cfg.Server.MetricsNamespace = metricsNamespace
t.cfg.Server.ExcludeRequestInLog = true
prometheus.MustRegister(&t.cfg)
DisableSignalHandling(&t.cfg.Server)
server, err := server.New(t.cfg.Server)
if err != nil {
return nil, fmt.Errorf("failed to create server %w", err)
}
servicesToWaitFor := func() []services.Service {
svs := []services.Service(nil)
for m, s := range t.serviceMap {
// Server should not wait for itself.
if m != Server {
svs = append(svs, s)
}
}
return svs
}
t.Server = server
s := NewServerService(server, servicesToWaitFor)
return s, nil
}
func (t *App) initRing() (services.Service, error) {
ring, err := tempo_ring.New(t.cfg.Ingester.LifecyclerConfig.RingConfig, "ingester", t.cfg.Ingester.OverrideRingKey, prometheus.DefaultRegisterer)
if err != nil {
return nil, fmt.Errorf("failed to create ring %w", err)
}
t.ring = ring
t.Server.HTTP.Handle("/ingester/ring", t.ring)
return t.ring, nil
}
func (t *App) initGeneratorRing() (services.Service, error) {
generatorRing, err := tempo_ring.New(t.cfg.Generator.Ring.ToRingConfig(), "metrics-generator", generator.RingKey, prometheus.DefaultRegisterer)
if err != nil {
return nil, fmt.Errorf("failed to create metrics-generator ring %w", err)
}
t.generatorRing = generatorRing
t.Server.HTTP.Handle("/metrics-generator/ring", t.generatorRing)
return t.generatorRing, nil
}
func (t *App) initOverrides() (services.Service, error) {
overrides, err := overrides.NewOverrides(t.cfg.LimitsConfig)
if err != nil {
return nil, fmt.Errorf("failed to create overrides %w", err)
}
t.overrides = overrides
prometheus.MustRegister(&t.cfg.LimitsConfig)
if t.cfg.LimitsConfig.PerTenantOverrideConfig != "" {
prometheus.MustRegister(t.overrides)
}
return t.overrides, nil
}
func (t *App) initDistributor() (services.Service, error) {
// todo: make ingester client a module instead of passing the config everywhere
distributor, err := distributor.New(t.cfg.Distributor, t.cfg.IngesterClient, t.ring, t.cfg.GeneratorClient, t.generatorRing, t.overrides, t.TracesConsumerMiddleware, log.Logger, t.cfg.Server.LogLevel, t.cfg.SearchEnabled, t.cfg.MetricsGeneratorEnabled, prometheus.DefaultRegisterer)
if err != nil {
return nil, fmt.Errorf("failed to create distributor %w", err)
}
t.distributor = distributor
if distributor.DistributorRing != nil {
t.Server.HTTP.Handle("/distributor/ring", distributor.DistributorRing)
}
return t.distributor, nil
}
func (t *App) initIngester() (services.Service, error) {
t.cfg.Ingester.LifecyclerConfig.ListenPort = t.cfg.Server.GRPCListenPort
ingester, err := ingester.New(t.cfg.Ingester, t.store, t.overrides, prometheus.DefaultRegisterer)
if err != nil {
return nil, fmt.Errorf("failed to create ingester: %w", err)
}
t.ingester = ingester
tempopb.RegisterPusherServer(t.Server.GRPC, t.ingester)
tempopb.RegisterQuerierServer(t.Server.GRPC, t.ingester)
t.Server.HTTP.Path("/flush").Handler(http.HandlerFunc(t.ingester.FlushHandler))
t.Server.HTTP.Path("/shutdown").Handler(http.HandlerFunc(t.ingester.ShutdownHandler))
return t.ingester, nil
}
func (t *App) initGenerator() (services.Service, error) {
t.cfg.Generator.Ring.ListenPort = t.cfg.Server.GRPCListenPort
generator, err := generator.New(&t.cfg.Generator, t.overrides, prometheus.DefaultRegisterer, log.Logger)
if err != nil {
return nil, fmt.Errorf("failed to create metrics-generator %w", err)
}
t.generator = generator
tempopb.RegisterMetricsGeneratorServer(t.Server.GRPC, t.generator)
return t.generator, nil
}
func (t *App) initQuerier() (services.Service, error) {
// validate worker config
// if we're not in single binary mode and worker address is not specified - bail
if t.cfg.Target != SingleBinary && t.cfg.Querier.Worker.FrontendAddress == "" {
return nil, fmt.Errorf("frontend worker address not specified")
} else if t.cfg.Target == SingleBinary {
// if we're in single binary mode with no worker address specified, register default endpoint
if t.cfg.Querier.Worker.FrontendAddress == "" {
t.cfg.Querier.Worker.FrontendAddress = fmt.Sprintf("127.0.0.1:%d", t.cfg.Server.GRPCListenPort)
level.Warn(log.Logger).Log("msg", "Worker address is empty in single binary mode. Attempting automatic worker configuration. If queries are unresponsive consider configuring the worker explicitly.", "address", t.cfg.Querier.Worker.FrontendAddress)
}
}
// do not enable polling if this is the single binary. in that case the compactor will take care of polling
if t.cfg.Target == Querier {
t.store.EnablePolling(nil)
}
// todo: make ingester client a module instead of passing config everywhere
querier, err := querier.New(t.cfg.Querier, t.cfg.IngesterClient, t.ring, t.store, t.overrides)
if err != nil {
return nil, fmt.Errorf("failed to create querier %w", err)
}
t.querier = querier
middleware := middleware.Merge(
t.HTTPAuthMiddleware,
)
tracesHandler := middleware.Wrap(http.HandlerFunc(t.querier.TraceByIDHandler))
t.Server.HTTP.Handle(path.Join(api.PathPrefixQuerier, addHTTPAPIPrefix(&t.cfg, api.PathTraces)), tracesHandler)
if t.cfg.SearchEnabled {
searchHandler := t.HTTPAuthMiddleware.Wrap(http.HandlerFunc(t.querier.SearchHandler))
t.Server.HTTP.Handle(path.Join(api.PathPrefixQuerier, addHTTPAPIPrefix(&t.cfg, api.PathSearch)), searchHandler)
searchTagsHandler := t.HTTPAuthMiddleware.Wrap(http.HandlerFunc(t.querier.SearchTagsHandler))
t.Server.HTTP.Handle(path.Join(api.PathPrefixQuerier, addHTTPAPIPrefix(&t.cfg, api.PathSearchTags)), searchTagsHandler)
searchTagValuesHandler := t.HTTPAuthMiddleware.Wrap(http.HandlerFunc(t.querier.SearchTagValuesHandler))
t.Server.HTTP.Handle(path.Join(api.PathPrefixQuerier, addHTTPAPIPrefix(&t.cfg, api.PathSearchTagValues)), searchTagValuesHandler)
}
return t.querier, t.querier.CreateAndRegisterWorker(t.Server.HTTPServer.Handler)
}
func (t *App) initQueryFrontend() (services.Service, error) {
// cortexTripper is a bridge between http and httpgrpc. it does the job of passing data to the cortex
// frontend code
cortexTripper, v1, _, err := frontend.InitFrontend(t.cfg.Frontend.Config, frontend.CortexNoQuerierLimits{}, 0, log.Logger, prometheus.DefaultRegisterer)
if err != nil {
return nil, err
}
t.frontend = v1
// create query frontend
queryFrontend, err := frontend.New(t.cfg.Frontend, cortexTripper, t.overrides, t.store, log.Logger, prometheus.DefaultRegisterer)
if err != nil {
return nil, err
}
// wrap handlers with auth
middleware := middleware.Merge(
t.HTTPAuthMiddleware,
httpGzipMiddleware(),
)
traceByIDHandler := middleware.Wrap(queryFrontend.TraceByID)
searchHandler := middleware.Wrap(queryFrontend.Search)
// register grpc server for queriers to connect to
frontend_v1pb.RegisterFrontendServer(t.Server.GRPC, t.frontend)
// http trace by id endpoint
t.Server.HTTP.Handle(addHTTPAPIPrefix(&t.cfg, api.PathTraces), traceByIDHandler)
// http search endpoints
if t.cfg.SearchEnabled {
t.Server.HTTP.Handle(addHTTPAPIPrefix(&t.cfg, api.PathSearch), searchHandler)
t.Server.HTTP.Handle(addHTTPAPIPrefix(&t.cfg, api.PathSearchTags), searchHandler)
t.Server.HTTP.Handle(addHTTPAPIPrefix(&t.cfg, api.PathSearchTagValues), searchHandler)
t.store.EnablePolling(nil) // the query frontend does not need to have knowledge of the backend unless it is building jobs for backend search
}
// http query echo endpoint
t.Server.HTTP.Handle(addHTTPAPIPrefix(&t.cfg, api.PathEcho), echoHandler())
// todo: queryFrontend should implement service.Service and take the cortex frontend a submodule
return t.frontend, nil
}
func (t *App) initCompactor() (services.Service, error) {
compactor, err := compactor.New(t.cfg.Compactor, t.store, t.overrides, prometheus.DefaultRegisterer)
if err != nil {
return nil, fmt.Errorf("failed to create compactor %w", err)
}
t.compactor = compactor
if t.compactor.Ring != nil {
t.Server.HTTP.Handle("/compactor/ring", t.compactor.Ring)
}
return t.compactor, nil
}
func (t *App) initStore() (services.Service, error) {
store, err := tempo_storage.NewStore(t.cfg.StorageConfig, log.Logger)
if err != nil {
return nil, fmt.Errorf("failed to create store %w", err)
}
t.store = store
return t.store, nil
}
func (t *App) initMemberlistKV() (services.Service, error) {
reg := prometheus.DefaultRegisterer
t.cfg.MemberlistKV.MetricsRegisterer = reg
t.cfg.MemberlistKV.MetricsNamespace = metricsNamespace
t.cfg.MemberlistKV.Codecs = []codec.Codec{
ring.GetCodec(),
usagestats.JSONCodec,
}
dnsProviderReg := prometheus.WrapRegistererWithPrefix(
"tempo_",
prometheus.WrapRegistererWith(
prometheus.Labels{"name": "memberlist"},
reg,
),
)
dnsProvider := dns.NewProvider(log.Logger, dnsProviderReg, dns.GolangResolverType)
t.MemberlistKV = memberlist.NewKVInitService(&t.cfg.MemberlistKV, log.Logger, dnsProvider, reg)
t.cfg.Ingester.LifecyclerConfig.RingConfig.KVStore.MemberlistKV = t.MemberlistKV.GetMemberlistKV
t.cfg.Generator.Ring.KVStore.MemberlistKV = t.MemberlistKV.GetMemberlistKV
t.cfg.Distributor.DistributorRing.KVStore.MemberlistKV = t.MemberlistKV.GetMemberlistKV
t.cfg.Compactor.ShardingRing.KVStore.MemberlistKV = t.MemberlistKV.GetMemberlistKV
t.Server.HTTP.Handle("/memberlist", t.MemberlistKV)
return t.MemberlistKV, nil
}
func (t *App) initUsageReport() (services.Service, error) {
if !t.cfg.UsageReport.Enabled {
return nil, nil
}
t.cfg.UsageReport.Leader = false
if t.isModuleActive(Ingester) {
t.cfg.UsageReport.Leader = true
}
usagestats.Target(t.cfg.Target)
var err error
var reader backend.RawReader
var writer backend.RawWriter
switch t.cfg.StorageConfig.Trace.Backend {
case "local":
reader, writer, _, err = local.New(t.cfg.StorageConfig.Trace.Local)
case "gcs":
reader, writer, _, err = gcs.New(t.cfg.StorageConfig.Trace.GCS)
case "s3":
reader, writer, _, err = s3.New(t.cfg.StorageConfig.Trace.S3)
case "azure":
reader, writer, _, err = azure.New(t.cfg.StorageConfig.Trace.Azure)
default:
err = fmt.Errorf("unknown backend %s", t.cfg.StorageConfig.Trace.Backend)
}
if err != nil {
return nil, fmt.Errorf("failed to initialize usage report: %w", err)
}
ur, err := usagestats.NewReporter(t.cfg.UsageReport, t.cfg.Ingester.LifecyclerConfig.RingConfig.KVStore, reader, writer, util_log.Logger, prometheus.DefaultRegisterer)
if err != nil {
level.Info(util_log.Logger).Log("msg", "failed to initialize usage report", "err", err)
return nil, nil
}
t.usageReport = ur
return ur, nil
}
func (t *App) setupModuleManager() error {
mm := modules.NewManager(log.Logger)
mm.RegisterModule(Server, t.initServer, modules.UserInvisibleModule)
mm.RegisterModule(MemberlistKV, t.initMemberlistKV, modules.UserInvisibleModule)
mm.RegisterModule(Ring, t.initRing, modules.UserInvisibleModule)
mm.RegisterModule(MetricsGeneratorRing, t.initGeneratorRing, modules.UserInvisibleModule)
mm.RegisterModule(Overrides, t.initOverrides, modules.UserInvisibleModule)
mm.RegisterModule(Distributor, t.initDistributor)
mm.RegisterModule(Ingester, t.initIngester)
mm.RegisterModule(Querier, t.initQuerier)
mm.RegisterModule(QueryFrontend, t.initQueryFrontend)
mm.RegisterModule(Compactor, t.initCompactor)
mm.RegisterModule(MetricsGenerator, t.initGenerator)
mm.RegisterModule(Store, t.initStore, modules.UserInvisibleModule)
mm.RegisterModule(SingleBinary, nil)
mm.RegisterModule(ScalableSingleBinary, nil)
mm.RegisterModule(UsageReport, t.initUsageReport)
deps := map[string][]string{
// Server: nil,
// Store: nil,
Overrides: {Server},
MemberlistKV: {Server},
QueryFrontend: {Store, Server, Overrides, UsageReport},
Ring: {Server, MemberlistKV},
MetricsGeneratorRing: {Server, MemberlistKV},
Distributor: {Ring, Server, Overrides, UsageReport},
Ingester: {Store, Server, Overrides, MemberlistKV, UsageReport},
MetricsGenerator: {Server, Overrides, MemberlistKV, UsageReport},
Querier: {Store, Ring, Overrides, UsageReport},
Compactor: {Store, Server, Overrides, MemberlistKV, UsageReport},
SingleBinary: {Compactor, QueryFrontend, Querier, Ingester, Distributor},
ScalableSingleBinary: {SingleBinary},
UsageReport: {MemberlistKV},
}
if t.cfg.MetricsGeneratorEnabled {
// If metrics-generator is enabled, the distributor needs the metrics-generator ring
deps[Distributor] = append(deps[Distributor], MetricsGeneratorRing)
// Add the metrics generator as dependency for when target is {,scalable-}single-binary
deps[SingleBinary] = append(deps[SingleBinary], MetricsGenerator)
}
for mod, targets := range deps {
if err := mm.AddDependency(mod, targets...); err != nil {
return err
}
}
t.ModuleManager = mm
t.deps = deps
return nil
}
func (t *App) isModuleActive(m string) bool {
if t.cfg.Target == m {
return true
}
if t.recursiveIsModuleActive(t.cfg.Target, m) {
return true
}
return false
}
func (t *App) recursiveIsModuleActive(target, m string) bool {
if targetDeps, ok := t.deps[target]; ok {
for _, dep := range targetDeps {
if dep == m {
return true
}
if t.recursiveIsModuleActive(dep, m) {
return true
}
}
}
return false
}
func addHTTPAPIPrefix(cfg *Config, apiPath string) string {
return path.Join(cfg.HTTPAPIPrefix, apiPath)
}
func echoHandler() http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
http.Error(w, "echo", http.StatusOK)
}
}