-
Notifications
You must be signed in to change notification settings - Fork 1.4k
/
service.go
597 lines (503 loc) · 17.4 KB
/
service.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
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
// Copyright The OpenTelemetry 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 service handles the command-line, configuration, and runs the
// OpenTelemetry Collector.
package service
import (
"context"
"flag"
"fmt"
"net/http"
"os"
"os/signal"
"path"
"runtime"
"sort"
"syscall"
"github.com/pkg/errors"
"github.com/spf13/cobra"
"github.com/spf13/viper"
"go.uber.org/zap"
"go.opentelemetry.io/collector/component"
"go.opentelemetry.io/collector/component/componenterror"
"go.opentelemetry.io/collector/config"
"go.opentelemetry.io/collector/config/configcheck"
"go.opentelemetry.io/collector/config/configmodels"
"go.opentelemetry.io/collector/internal/collector/telemetry"
"go.opentelemetry.io/collector/internal/version"
"go.opentelemetry.io/collector/service/builder"
"go.opentelemetry.io/collector/service/internal"
)
const (
servicezPath = "servicez"
pipelinezPath = "pipelinez"
extensionzPath = "extensionz"
)
// State defines Application's state.
type State int
const (
Starting State = iota
Running
Closing
Closed
)
// GetStateChannel returns state channel of the application.
func (app *Application) GetStateChannel() chan State {
return app.stateChannel
}
// Application represents a collector application
type Application struct {
info ApplicationStartInfo
rootCmd *cobra.Command
v *viper.Viper
logger *zap.Logger
builtExporters builder.Exporters
builtReceivers builder.Receivers
builtPipelines builder.BuiltPipelines
builtExtensions builder.Extensions
stateChannel chan State
factories config.Factories
config *configmodels.Config
// stopTestChan is used to terminate the application in end to end tests.
stopTestChan chan struct{}
// asyncErrorChannel is used to signal a fatal error from any component.
asyncErrorChannel chan error
}
// Command returns Application's root command.
func (app *Application) Command() *cobra.Command {
return app.rootCmd
}
// ApplicationStartInfo is the information that is logged at the application start.
// This information can be overridden in custom builds.
type ApplicationStartInfo struct {
// Executable file name, e.g. "otelcol".
ExeName string
// Long name, used e.g. in the logs.
LongName string
// Version string.
Version string
// Git hash of the source code.
GitHash string
}
// Parameters holds configuration for creating a new Application.
type Parameters struct {
// Factories component factories.
Factories config.Factories
// ApplicationStartInfo provides application start information.
ApplicationStartInfo ApplicationStartInfo
// ConfigFactory that creates the configuration.
// If it is not provided the default factory (FileLoaderConfigFactory) is used.
// The default factory loads the configuration specified as a command line flag.
ConfigFactory ConfigFactory
}
// ConfigFactory creates config.
type ConfigFactory func(v *viper.Viper, factories config.Factories) (*configmodels.Config, error)
// FileLoaderConfigFactory implements ConfigFactory and it creates configuration from file.
func FileLoaderConfigFactory(v *viper.Viper, factories config.Factories) (*configmodels.Config, error) {
file := builder.GetConfigFile()
if file == "" {
return nil, errors.New("config file not specified")
}
v.SetConfigFile(file)
err := v.ReadInConfig()
if err != nil {
return nil, fmt.Errorf("error loading config file %q: %v", file, err)
}
return config.Load(v, factories)
}
// New creates and returns a new instance of Application.
func New(params Parameters) (*Application, error) {
app := &Application{
info: params.ApplicationStartInfo,
v: config.NewViper(),
factories: params.Factories,
stateChannel: make(chan State, Closed+1),
}
factory := params.ConfigFactory
if factory == nil {
// use default factory that loads the configuration file
factory = FileLoaderConfigFactory
}
rootCmd := &cobra.Command{
Use: params.ApplicationStartInfo.ExeName,
Long: params.ApplicationStartInfo.LongName,
RunE: func(cmd *cobra.Command, args []string) error {
err := app.init()
if err != nil {
return err
}
err = app.execute(context.Background(), factory)
if err != nil {
return err
}
return nil
},
}
// TODO: coalesce this code and expose this information to other components.
flagSet := new(flag.FlagSet)
addFlagsFns := []func(*flag.FlagSet){
telemetry.Flags,
builder.Flags,
loggerFlags,
}
for _, addFlags := range addFlagsFns {
addFlags(flagSet)
}
rootCmd.Flags().AddGoFlagSet(flagSet)
app.rootCmd = rootCmd
return app, nil
}
// ReportFatalError is used to report to the host that the receiver encountered
// a fatal error (i.e.: an error that the instance can't recover from) after
// its start function has already returned.
func (app *Application) ReportFatalError(err error) {
app.asyncErrorChannel <- err
}
// GetLogger returns logger used by the Application.
// The logger is initialized after application start.
func (app *Application) GetLogger() *zap.Logger {
return app.logger
}
func (app *Application) GetFactory(kind component.Kind, componentType configmodels.Type) component.Factory {
switch kind {
case component.KindReceiver:
return app.factories.Receivers[componentType]
case component.KindProcessor:
return app.factories.Processors[componentType]
case component.KindExporter:
return app.factories.Exporters[componentType]
case component.KindExtension:
return app.factories.Extensions[componentType]
}
return nil
}
func (app *Application) GetExtensions() map[configmodels.Extension]component.ServiceExtension {
return app.builtExtensions.ToMap()
}
func (app *Application) GetExporters() map[configmodels.DataType]map[configmodels.Exporter]component.Exporter {
return app.builtExporters.ToMapByDataType()
}
func (app *Application) RegisterZPages(mux *http.ServeMux, pathPrefix string) {
mux.HandleFunc(path.Join(pathPrefix, servicezPath), app.handleServicezRequest)
mux.HandleFunc(path.Join(pathPrefix, pipelinezPath), app.handlePipelinezRequest)
mux.HandleFunc(path.Join(pathPrefix, extensionzPath), app.handleExtensionzRequest)
}
func (app *Application) SignalTestComplete() {
defer func() {
if r := recover(); r != nil {
app.logger.Info("stopTestChan already closed")
}
}()
close(app.stopTestChan)
}
func (app *Application) init() error {
l, err := newLogger()
if err != nil {
return errors.Wrap(err, "failed to get logger")
}
app.logger = l
return nil
}
func (app *Application) setupTelemetry(ballastSizeBytes uint64) error {
app.logger.Info("Setting up own telemetry...")
err := AppTelemetry.init(app.asyncErrorChannel, ballastSizeBytes, app.logger)
if err != nil {
return errors.Wrap(err, "failed to initialize telemetry")
}
return nil
}
// runAndWaitForShutdownEvent waits for one of the shutdown events that can happen.
func (app *Application) runAndWaitForShutdownEvent() {
app.logger.Info("Everything is ready. Begin running and processing data.")
// Plug SIGTERM signal into a channel.
signalsChannel := make(chan os.Signal, 1)
signal.Notify(signalsChannel, os.Interrupt, syscall.SIGTERM)
// set the channel to stop testing.
app.stopTestChan = make(chan struct{})
// notify tests that it is ready.
app.stateChannel <- Running
select {
case err := <-app.asyncErrorChannel:
app.logger.Error("Asynchronous error received, terminating process", zap.Error(err))
case s := <-signalsChannel:
app.logger.Info("Received signal from OS", zap.String("signal", s.String()))
case <-app.stopTestChan:
app.logger.Info("Received stop test request")
}
app.stateChannel <- Closing
}
func (app *Application) setupConfigurationComponents(ctx context.Context, factory ConfigFactory) error {
if err := configcheck.ValidateConfigFromFactories(app.factories); err != nil {
return err
}
app.logger.Info("Loading configuration...")
cfg, err := factory(app.v, app.factories)
if err != nil {
return errors.Wrap(err, "cannot load configuration")
}
err = config.ValidateConfig(cfg, app.logger)
if err != nil {
return errors.Wrap(err, "cannot load configuration")
}
app.config = cfg
app.logger.Info("Applying configuration...")
err = app.setupExtensions(ctx)
if err != nil {
return errors.Wrap(err, "cannot setup extensions")
}
err = app.setupPipelines(ctx)
if err != nil {
return errors.Wrap(err, "cannot setup pipelines")
}
return nil
}
func (app *Application) setupExtensions(ctx context.Context) error {
var err error
app.builtExtensions, err = builder.NewExtensionsBuilder(app.logger, app.config, app.factories.Extensions).Build()
if err != nil {
return errors.Wrap(err, "cannot build builtExtensions")
}
app.logger.Info("Starting extensions...")
return app.builtExtensions.StartAll(ctx, app)
}
func (app *Application) setupPipelines(ctx context.Context) error {
// Pipeline is built backwards, starting from exporters, so that we create objects
// which are referenced before objects which reference them.
// First create exporters.
var err error
app.builtExporters, err = builder.NewExportersBuilder(app.logger, app.config, app.factories.Exporters).Build()
if err != nil {
return errors.Wrap(err, "cannot build builtExporters")
}
app.logger.Info("Starting exporters...")
err = app.builtExporters.StartAll(ctx, app)
if err != nil {
return errors.Wrap(err, "cannot start builtExporters")
}
// Create pipelines and their processors and plug exporters to the
// end of the pipelines.
app.builtPipelines, err = builder.NewPipelinesBuilder(app.logger, app.config, app.builtExporters, app.factories.Processors).Build()
if err != nil {
return errors.Wrap(err, "cannot build pipelines")
}
app.logger.Info("Starting processors...")
err = app.builtPipelines.StartProcessors(ctx, app)
if err != nil {
return errors.Wrap(err, "cannot start processors")
}
// Create receivers and plug them into the start of the pipelines.
app.builtReceivers, err = builder.NewReceiversBuilder(app.logger, app.config, app.builtPipelines, app.factories.Receivers).Build()
if err != nil {
return errors.Wrap(err, "cannot build receivers")
}
app.logger.Info("Starting receivers...")
err = app.builtReceivers.StartAll(ctx, app)
if err != nil {
return errors.Wrap(err, "cannot start receivers")
}
return nil
}
func (app *Application) shutdownPipelines(ctx context.Context) error {
// Shutdown order is the reverse of building: first receivers, then flushing pipelines
// giving senders a chance to send all their data. This may take time, the allowed
// time should be part of configuration.
var errs []error
app.logger.Info("Stopping receivers...")
err := app.builtReceivers.ShutdownAll(ctx)
if err != nil {
errs = append(errs, errors.Wrap(err, "failed to stop receivers"))
}
app.logger.Info("Stopping processors...")
err = app.builtPipelines.ShutdownProcessors(ctx)
if err != nil {
errs = append(errs, errors.Wrap(err, "failed to shutdown processors"))
}
app.logger.Info("Stopping exporters...")
err = app.builtExporters.ShutdownAll(ctx)
if err != nil {
errs = append(errs, errors.Wrap(err, "failed to shutdown exporters"))
}
if len(errs) != 0 {
return componenterror.CombineErrors(errs)
}
return nil
}
func (app *Application) shutdownExtensions(ctx context.Context) error {
app.logger.Info("Stopping extensions...")
err := app.builtExtensions.ShutdownAll(ctx)
if err != nil {
return errors.Wrap(err, "failed to shutdown extensions")
}
return nil
}
func (app *Application) execute(ctx context.Context, factory ConfigFactory) error {
app.logger.Info("Starting "+app.info.LongName+"...",
zap.String("Version", app.info.Version),
zap.String("GitHash", app.info.GitHash),
zap.Int("NumCPU", runtime.NumCPU()),
)
app.stateChannel <- Starting
// Set memory ballast
ballast, ballastSizeBytes := app.createMemoryBallast()
app.asyncErrorChannel = make(chan error)
// Setup everything.
err := app.setupTelemetry(ballastSizeBytes)
if err != nil {
return err
}
err = app.setupConfigurationComponents(ctx, factory)
if err != nil {
return err
}
err = app.builtExtensions.NotifyPipelineReady()
if err != nil {
return err
}
// Everything is ready, now run until an event requiring shutdown happens.
app.runAndWaitForShutdownEvent()
// Accumulate errors and proceed with shutting down remaining components.
var errs []error
// Begin shutdown sequence.
runtime.KeepAlive(ballast)
app.logger.Info("Starting shutdown...")
err = app.builtExtensions.NotifyPipelineNotReady()
if err != nil {
errs = append(errs, errors.Wrap(err, "failed to notify that pipeline is not ready"))
}
err = app.shutdownPipelines(ctx)
if err != nil {
errs = append(errs, errors.Wrap(err, "failed to shutdown pipelines"))
}
err = app.shutdownExtensions(ctx)
if err != nil {
errs = append(errs, errors.Wrap(err, "failed to shutdown extensions"))
}
AppTelemetry.shutdown()
app.logger.Info("Shutdown complete.")
app.stateChannel <- Closed
close(app.stateChannel)
if len(errs) != 0 {
return componenterror.CombineErrors(errs)
}
return nil
}
// Start starts the collector according to the command and configuration
// given by the user.
func (app *Application) Start() error {
// From this point on do not show usage in case of error.
app.rootCmd.SilenceUsage = true
return app.rootCmd.Execute()
}
const (
zPipelineName = "zpipelinename"
zComponentName = "zcomponentname"
zComponentKind = "zcomponentkind"
zExtensionName = "zextensionname"
)
func (app *Application) handleServicezRequest(w http.ResponseWriter, r *http.Request) {
r.ParseForm()
w.Header().Set("Content-Type", "text/html; charset=utf-8")
internal.WriteHTMLHeader(w, internal.HeaderData{Title: "Service"})
internal.WriteHTMLComponentHeader(w, internal.ComponentHeaderData{
Name: "Pipelines",
ComponentEndpoint: pipelinezPath,
Link: true,
})
internal.WriteHTMLComponentHeader(w, internal.ComponentHeaderData{
Name: "Extensions",
ComponentEndpoint: extensionzPath,
Link: true,
})
internal.WriteHTMLPropertiesTable(w, internal.PropertiesTableData{Name: "Build And Runtime", Properties: version.InfoVar})
internal.WriteHTMLFooter(w)
}
func (app *Application) handlePipelinezRequest(w http.ResponseWriter, r *http.Request) {
r.ParseForm()
w.Header().Set("Content-Type", "text/html; charset=utf-8")
pipelineName := r.Form.Get(zPipelineName)
componentName := r.Form.Get(zComponentName)
componentKind := r.Form.Get(zComponentKind)
internal.WriteHTMLHeader(w, internal.HeaderData{Title: "Pipelines"})
internal.WriteHTMLPipelinesSummaryTable(w, app.getPipelinesSummaryTableData())
if pipelineName != "" && componentName != "" && componentKind != "" {
fullName := componentName
if componentKind == "processor" {
fullName = pipelineName + "/" + componentName
}
internal.WriteHTMLComponentHeader(w, internal.ComponentHeaderData{
Name: componentKind + ": " + fullName,
})
// TODO: Add config + status info.
}
internal.WriteHTMLFooter(w)
}
func (app *Application) handleExtensionzRequest(w http.ResponseWriter, r *http.Request) {
r.ParseForm()
w.Header().Set("Content-Type", "text/html; charset=utf-8")
extensionName := r.Form.Get(zExtensionName)
internal.WriteHTMLHeader(w, internal.HeaderData{Title: "Extensions"})
internal.WriteHTMLExtensionsSummaryTable(w, app.getExtensionsSummaryTableData())
if extensionName != "" {
internal.WriteHTMLComponentHeader(w, internal.ComponentHeaderData{
Name: extensionName,
})
// TODO: Add config + status info.
}
internal.WriteHTMLFooter(w)
}
func (app *Application) getPipelinesSummaryTableData() internal.SummaryPipelinesTableData {
data := internal.SummaryPipelinesTableData{
ComponentEndpoint: pipelinezPath,
}
data.Rows = make([]internal.SummaryPipelinesTableRowData, 0, len(app.builtExtensions))
for c, p := range app.builtPipelines {
row := internal.SummaryPipelinesTableRowData{
FullName: c.Name,
InputType: string(c.InputType),
MutatesConsumedData: p.MutatesConsumedData,
Receivers: c.Receivers,
Processors: c.Processors,
Exporters: c.Exporters,
}
data.Rows = append(data.Rows, row)
}
sort.Slice(data.Rows, func(i, j int) bool {
return data.Rows[i].FullName < data.Rows[j].FullName
})
return data
}
func (app *Application) getExtensionsSummaryTableData() internal.SummaryExtensionsTableData {
data := internal.SummaryExtensionsTableData{
ComponentEndpoint: extensionzPath,
}
data.Rows = make([]internal.SummaryExtensionsTableRowData, 0, len(app.builtExtensions))
for c := range app.builtExtensions {
row := internal.SummaryExtensionsTableRowData{FullName: c.Name()}
data.Rows = append(data.Rows, row)
}
sort.Slice(data.Rows, func(i, j int) bool {
return data.Rows[i].FullName < data.Rows[j].FullName
})
return data
}
func (app *Application) createMemoryBallast() ([]byte, uint64) {
ballastSizeMiB := builder.MemBallastSize()
if ballastSizeMiB > 0 {
ballastSizeBytes := uint64(ballastSizeMiB) * 1024 * 1024
ballast := make([]byte, ballastSizeBytes)
app.logger.Info("Using memory ballast", zap.Int("MiBs", ballastSizeMiB))
return ballast, ballastSizeBytes
}
return nil, 0
}