forked from redpanda-data/connect
-
Notifications
You must be signed in to change notification settings - Fork 0
/
service.go
484 lines (423 loc) · 13.2 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
package service
import (
"context"
"crypto/tls"
"errors"
"fmt"
"net/http"
"os"
"os/signal"
"runtime/pprof"
"strings"
"sync"
"syscall"
"time"
iconfig "github.com/dafanshu/benthos/v3/internal/config"
"github.com/dafanshu/benthos/v3/internal/docs"
"github.com/dafanshu/benthos/v3/lib/api"
"github.com/dafanshu/benthos/v3/lib/config"
"github.com/dafanshu/benthos/v3/lib/log"
"github.com/dafanshu/benthos/v3/lib/manager"
"github.com/dafanshu/benthos/v3/lib/metrics"
"github.com/dafanshu/benthos/v3/lib/stream"
strmmgr "github.com/dafanshu/benthos/v3/lib/stream/manager"
"github.com/dafanshu/benthos/v3/lib/tracer"
"github.com/dafanshu/benthos/v3/lib/types"
"gopkg.in/yaml.v3"
)
//------------------------------------------------------------------------------
var conf = config.New()
var testSuffix = "_benthos_test"
// OptSetServiceName creates an opt func that allows the default service name
// config fields such as metrics and logging prefixes to be overridden.
func OptSetServiceName(name string) func() {
return func() {
testSuffix = fmt.Sprintf("_%v_test", name)
conf.HTTP.RootPath = "/" + name
conf.Logger.Prefix = name
conf.Logger.StaticFields["@service"] = name
conf.Metrics.HTTP.Prefix = name
conf.Metrics.Prometheus.Prefix = name
conf.Metrics.Statsd.Prefix = name
}
}
// OptOverrideConfigDefaults creates an opt func that allows the provided func
// to override config struct default values before the user config is parsed.
func OptOverrideConfigDefaults(fn func(c *config.Type)) func() {
return func() {
fn(&conf)
}
}
var apiOpts []api.OptFunc
// OptWithAPIMiddleware adds an HTTP middleware to the Benthos API.
func OptWithAPIMiddleware(m func(http.Handler) http.Handler) func() {
return func() {
apiOpts = append(apiOpts, api.OptWithMiddleware(m))
}
}
// OptWithAPITLS replaces the default TLS options of the Benthos API server.
func OptWithAPITLS(c *tls.Config) func() {
return func() {
apiOpts = append(apiOpts, api.OptWithTLS(c))
}
}
type stoppable interface {
Stop(timeout time.Duration) error
}
// ManagerInitFunc is a function to be called once the Benthos service manager,
// which manages resources shared across all components, is initialised. This is
// a useful time to add additional resources that might be required for custom
// plugins. If a non-nil error is returned the service will terminate.
type ManagerInitFunc func(manager types.Manager, logger log.Modular, stats metrics.Type) error
// TODO: V4 remove this
var onManagerInit ManagerInitFunc = func(manager types.Manager, logger log.Modular, stats metrics.Type) error {
return nil
}
// OptOnManagerInit creates an opt func that allows you to specify a function to
// be called once the service manager is constructed.
func OptOnManagerInit(fn ManagerInitFunc) func() {
return func() {
onManagerInit = fn
}
}
//------------------------------------------------------------------------------
func readConfig(path string, streamsMode bool, resourcesPaths, streamsPaths, overrides []string) *iconfig.Reader {
if path == "" {
// Iterate default config paths
for _, dpath := range []string{
"/benthos.yaml",
"/etc/benthos/config.yaml",
"/etc/benthos.yaml",
} {
if _, err := os.Stat(dpath); err == nil {
fmt.Fprintf(os.Stderr, "Config file not specified, reading from %v\n", dpath)
path = dpath
break
}
}
}
opts := []iconfig.OptFunc{
iconfig.OptAddOverrides(overrides...),
iconfig.OptTestSuffix(testSuffix),
}
if streamsMode {
opts = append(opts, iconfig.OptSetStreamPaths(streamsPaths...))
}
return iconfig.NewReader(path, resourcesPaths, opts...)
}
//------------------------------------------------------------------------------
func initStreamsMode(
strict, watching, enableAPI bool,
confReader *iconfig.Reader,
strmAPITimeout time.Duration,
manager *manager.Type,
logger log.Modular,
stats metrics.Type,
) stoppable {
lintlog := logger.NewModule(".linter")
streamMgr := strmmgr.New(
strmmgr.OptSetAPITimeout(strmAPITimeout),
strmmgr.OptSetLogger(logger),
strmmgr.OptSetManager(manager),
strmmgr.OptSetStats(stats),
strmmgr.OptAPIEnabled(enableAPI),
)
streamConfs := map[string]stream.Config{}
lints, err := confReader.ReadStreams(streamConfs)
if err != nil {
fmt.Fprintf(os.Stderr, "Stream configuration file read error: %v\n", err)
os.Exit(1)
}
if strict && len(lints) > 0 {
for _, lint := range lints {
fmt.Fprintln(os.Stderr, lint)
}
fmt.Println("Shutting down due to stream linter errors, to prevent shutdown run Benthos with --chilled")
os.Exit(1)
}
for _, lint := range lints {
lintlog.Infoln(lint)
}
for id, conf := range streamConfs {
if err := streamMgr.Create(id, conf); err != nil {
logger.Errorf("Failed to create stream (%v): %v\n", id, err)
os.Exit(1)
}
}
logger.Infoln("Launching benthos in streams mode, use CTRL+C to close.")
if err := confReader.SubscribeStreamChanges(func(id string, newStreamConf stream.Config) bool {
if err = streamMgr.Update(id, newStreamConf, time.Second*30); err != nil && errors.Is(err, strmmgr.ErrStreamDoesNotExist) {
err = streamMgr.Create(id, newStreamConf)
}
if err != nil {
logger.Errorf("Failed to update stream %v: %v", id, err)
return false
}
logger.Infof("Updated stream %v config from file.", id)
return true
}); err != nil {
logger.Errorf("Failed to create stream config watcher: %v", err)
os.Exit(1)
}
if watching {
if err := confReader.BeginFileWatching(manager, strict); err != nil {
logger.Errorf("Failed to create stream config watcher: %v", err)
os.Exit(1)
}
}
return streamMgr
}
type swappableStopper struct {
stopped bool
current stoppable
mut sync.Mutex
}
func (s *swappableStopper) Stop(timeout time.Duration) error {
s.mut.Lock()
defer s.mut.Unlock()
if s.stopped {
return nil
}
s.stopped = true
return s.current.Stop(timeout)
}
func (s *swappableStopper) Replace(fn func() (stoppable, error)) error {
s.mut.Lock()
defer s.mut.Unlock()
if s.stopped {
// If the outter stream has been stopped then do not create a new one.
return nil
}
if err := s.current.Stop(time.Second * 30); err != nil {
return fmt.Errorf("failed to stop active stream: %w", err)
}
newStoppable, err := fn()
if err != nil {
return fmt.Errorf("failed to init updated stream: %w", err)
}
s.current = newStoppable
return nil
}
func initNormalMode(
strict, watching bool,
confReader *iconfig.Reader,
manager *manager.Type,
logger log.Modular,
stats metrics.Type,
) (newStream stoppable, stoppedChan chan struct{}) {
stoppedChan = make(chan struct{})
streamInit := func() (stoppable, error) {
return stream.New(
conf.Config,
stream.OptSetLogger(logger),
stream.OptSetStats(stats),
stream.OptSetManager(manager),
stream.OptOnClose(func() {
if !watching {
close(stoppedChan)
}
}),
)
}
var stoppableStream swappableStopper
var err error
if stoppableStream.current, err = streamInit(); err != nil {
logger.Errorf("Service closing due to: %v\n", err)
os.Exit(1)
}
logger.Infoln("Launching a benthos instance, use CTRL+C to close.")
if err := confReader.SubscribeConfigChanges(func(newStreamConf stream.Config) bool {
if err := stoppableStream.Replace(func() (stoppable, error) {
conf.Config = newStreamConf
return streamInit()
}); err != nil {
logger.Errorf("Failed to update stream: %v", err)
return false
}
logger.Infoln("Updated main config from file.")
return true
}); err != nil {
logger.Errorf("Failed to create config file watcher: %v", err)
os.Exit(1)
}
if watching {
if err := confReader.BeginFileWatching(manager, strict); err != nil {
logger.Errorf("Failed to create config file watcher: %v", err)
os.Exit(1)
}
}
newStream = &stoppableStream
return
}
func cmdService(
confPath string,
resourcesPaths []string,
confOverrides []string,
overrideLogLevel string,
strict, watching, enableStreamsAPI bool,
streamsMode bool,
streamsPaths []string,
) int {
confReader := readConfig(confPath, streamsMode, resourcesPaths, streamsPaths, confOverrides)
lints, err := confReader.Read(&conf)
if err != nil {
fmt.Fprintf(os.Stderr, "Configuration file read error: %v\n", err)
os.Exit(1)
}
if strict && len(lints) > 0 {
for _, lint := range lints {
fmt.Fprintln(os.Stderr, lint)
}
fmt.Println("Shutting down due to linter errors, to prevent shutdown run Benthos with --chilled")
return 1
}
if len(overrideLogLevel) > 0 {
conf.Logger.LogLevel = strings.ToUpper(overrideLogLevel)
}
// Logging and stats aggregation.
var logger log.Modular
// Note: Only log to Stderr if our output is stdout, brokers aren't counted
// here as this is only a special circumstance for very basic use cases.
if !streamsMode && conf.Output.Type == "stdout" {
logger, err = log.NewV2(os.Stderr, conf.Logger)
} else {
logger, err = log.NewV2(os.Stdout, conf.Logger)
}
if err != nil {
fmt.Printf("Failed to create logger: %v\n", err)
return 1
}
lintlog := logger.NewModule(".linter")
for _, lint := range lints {
lintlog.Infoln(lint)
}
// Create our metrics type.
var stats metrics.Type
stats, err = metrics.New(conf.Metrics, metrics.OptSetLogger(logger))
for err != nil {
logger.Errorf("Failed to connect to metrics aggregator: %v\n", err)
<-time.After(time.Second)
stats, err = metrics.New(conf.Metrics, metrics.OptSetLogger(logger))
}
defer func() {
if sCloseErr := stats.Close(); sCloseErr != nil {
logger.Errorf("Failed to cleanly close metrics aggregator: %v\n", sCloseErr)
}
}()
// Create our tracer type.
var trac tracer.Type
if trac, err = tracer.New(conf.Tracer); err != nil {
logger.Errorf("Failed to initialise tracer: %v\n", err)
return 1
}
defer trac.Close()
// Create HTTP API with a sanitised service config.
var sanitNode yaml.Node
err = sanitNode.Encode(conf)
if err == nil {
err = config.Spec().SanitiseYAML(&sanitNode, docs.SanitiseConfig{
RemoveTypeField: true,
})
}
if err != nil {
logger.Warnf("Failed to generate sanitised config: %v\n", err)
}
var httpServer *api.Type
if httpServer, err = api.New(Version, DateBuilt, conf.HTTP, sanitNode, logger, stats, apiOpts...); err != nil {
logger.Errorf("Failed to initialise API: %v\n", err)
return 1
}
// Create resource manager.
manager, err := manager.NewV2(conf.ResourceConfig, httpServer, logger, stats)
if err != nil {
logger.Errorf("Failed to create resource: %v\n", err)
return 1
}
if err = onManagerInit(manager, logger, stats); err != nil {
logger.Errorf("Failed to initialise manager: %v\n", err)
return 1
}
var stoppableStream stoppable
var dataStreamClosedChan chan struct{}
strmAPITimeout := 5 * time.Second
if cTout := conf.HTTP.ReadTimeout; cTout != "" {
if tmpTout, _ := time.ParseDuration(cTout); tmpTout > 0 {
strmAPITimeout = tmpTout
}
}
// Create data streams.
if streamsMode {
stoppableStream = initStreamsMode(strict, watching, enableStreamsAPI, confReader, strmAPITimeout, manager, logger, stats)
} else {
stoppableStream, dataStreamClosedChan = initNormalMode(strict, watching, confReader, manager, logger, stats)
}
// Start HTTP server.
httpServerClosedChan := make(chan struct{})
go func() {
httpErr := httpServer.ListenAndServe()
if httpErr != nil && httpErr != http.ErrServerClosed {
logger.Errorf("HTTP Server error: %v\n", httpErr)
}
close(httpServerClosedChan)
}()
var exitTimeout time.Duration
if tout := conf.SystemCloseTimeout; len(tout) > 0 {
var err error
if exitTimeout, err = time.ParseDuration(tout); err != nil {
logger.Errorf("Failed to parse shutdown timeout period string: %v\n", err)
return 1
}
}
// Defer clean up.
defer func() {
go func() {
httpServer.Shutdown(context.Background())
select {
case <-httpServerClosedChan:
case <-time.After(exitTimeout / 2):
logger.Warnln("Service failed to close HTTP server gracefully in time.")
}
}()
go func() {
<-time.After(exitTimeout + time.Second)
logger.Warnln(
"Service failed to close cleanly within allocated time." +
" Exiting forcefully and dumping stack trace to stderr.",
)
pprof.Lookup("goroutine").WriteTo(os.Stderr, 1)
os.Exit(1)
}()
if err := confReader.Close(context.Background()); err != nil {
logger.Warnf("Failed to cleanly shut down file watcher: %v", err)
os.Exit(1)
}
timesOut := time.Now().Add(exitTimeout)
if err := stoppableStream.Stop(exitTimeout); err != nil {
os.Exit(1)
}
manager.CloseAsync()
if err := manager.WaitForClose(time.Until(timesOut)); err != nil {
logger.Warnf(
"Service failed to close cleanly within allocated time: %v."+
" Exiting forcefully and dumping stack trace to stderr.\n", err,
)
pprof.Lookup("goroutine").WriteTo(os.Stderr, 1)
os.Exit(1)
}
}()
sigChan := make(chan os.Signal, 1)
signal.Notify(sigChan, os.Interrupt, syscall.SIGTERM)
// Wait for termination signal
select {
case <-sigChan:
logger.Infoln("Received SIGTERM, the service is closing.")
case <-dataStreamClosedChan:
logger.Infoln("Pipeline has terminated. Shutting down the service.")
case <-httpServerClosedChan:
logger.Infoln("HTTP Server has terminated. Shutting down the service.")
case <-optContext.Done():
logger.Infoln("Run context was cancelled. Shutting down the service.")
}
return 0
}
//------------------------------------------------------------------------------