forked from palantir/witchcraft-go-server
-
Notifications
You must be signed in to change notification settings - Fork 0
/
witchcraft.go
841 lines (724 loc) · 32.2 KB
/
witchcraft.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
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
// Copyright (c) 2018 Palantir Technologies. All rights reserved.
//
// 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 witchcraft
import (
"context"
"crypto/tls"
"io"
"io/ioutil"
"math"
"net"
"net/http"
"os"
"os/signal"
"reflect"
"runtime/debug"
"sync"
"syscall"
"time"
"github.com/palantir/go-encrypted-config-value/encryptedconfigvalue"
"github.com/palantir/pkg/metrics"
"github.com/palantir/pkg/signals"
"github.com/palantir/witchcraft-go-error"
"github.com/palantir/witchcraft-go-logging/conjure/witchcraft/api/logging"
"github.com/palantir/witchcraft-go-logging/wlog"
"github.com/palantir/witchcraft-go-logging/wlog/auditlog/audit2log"
"github.com/palantir/witchcraft-go-logging/wlog/diaglog/diag1log"
"github.com/palantir/witchcraft-go-logging/wlog/evtlog/evt2log"
"github.com/palantir/witchcraft-go-logging/wlog/extractor"
"github.com/palantir/witchcraft-go-logging/wlog/metriclog/metric1log"
"github.com/palantir/witchcraft-go-logging/wlog/reqlog/req2log"
"github.com/palantir/witchcraft-go-logging/wlog/svclog/svc1log"
"github.com/palantir/witchcraft-go-logging/wlog/trclog/trc1log"
"github.com/palantir/witchcraft-go-logging/wlog/wapp"
"github.com/palantir/witchcraft-go-server/config"
"github.com/palantir/witchcraft-go-server/status"
"github.com/palantir/witchcraft-go-server/witchcraft/refreshable"
"github.com/palantir/witchcraft-go-server/wrouter"
"github.com/palantir/witchcraft-go-server/wrouter/whttprouter"
"github.com/palantir/witchcraft-go-tracing/wtracing"
"github.com/palantir/witchcraft-go-tracing/wzipkin"
"gopkg.in/yaml.v2"
// Use zap as logger implementation: witchcraft-based applications are opinionated about the logging implementation used
_ "github.com/palantir/witchcraft-go-logging/wlog-zap"
)
type Server struct {
// handlers specifies any custom HTTP handlers that should be used by the server. The provided handlers are invoked
// in order after the built-in handlers (which provide things such as panic handling). The context in the request
// will have the appropriate loggers and logger parameters set.
handlers []wrouter.RequestHandlerMiddleware
// useSelfSignedServerCertificate specifies whether the server uses a dynamically generated self-signed certificate
// for TLS. No verification mechanism is provided for the self-signed certificate, so clients can only connect to a
// server using this mode in an untrusted manner. As such, this option should only be used in very specialized
// scenarios such as tests or in an environment where the server is exposed in a way that the connection to it can
// be trusted based on other external mechanisms (in the latter scenario, using HTTPS with an unverified certificate
// still provides the benefit that the traffic itself is encrypted).
//
// If false, the key material at the paths specified in serverConfig.CertFile and serverConfig.KeyFile is used.
useSelfSignedServerCertificate bool
// manages storing and retrieving server state (idle, initializing, running)
stateManager serverStateManager
// specifies the io.Writer to which goroutine dump will be written if a SIGQUIT is received while the server is
// running. If nil, os.Stdout is used as the default. If the value is ioutil.Discard, then no plaintext output will
// be emitted. A diagnostic.1 line is logged unless disableSigQuitHandler is true.
sigQuitHandlerWriter io.Writer
// if true, disables the default behavior of emitting a goroutine dump on SIGQUIT signals.
disableSigQuitHandler bool
// if true, disables the default behavior of shutting down the server on SIGTERM and SIGINT signals.
disableShutdownSignalHandler bool
// provides the bytes for the install configuration for the server. If nil, a default configuration provider that
// reads the file at "var/conf/install.yml" is used.
installConfigProvider ConfigBytesProvider
// a function that provides the refreshable.Refreshable that provides the bytes for the runtime configuration for
// the server. The ctx provided to the function is valid for the lifetime of the server. If nil, uses a function
// that returns a default file-based Refreshable that reads the file at "var/conf/runtime.yml". The value of the
// Refreshable is "[]byte", where the byte slice is the contents of the runtime configuration file.
runtimeConfigProvider func(ctx context.Context) (refreshable.Refreshable, error)
// specifies the source used to provide the readiness information for the server. If nil, a default value that uses
// the server's status is used.
readinessSource status.Source
// specifies the source used to provide the liveness information for the server. If nil, a default value that uses
// the server's status is used.
livenessSource status.Source
// specifies the sources that are used to determine the health of this service
healthCheckSources []status.HealthCheckSource
// provides the RouterImpl used by the server (and management server if it is separate). If nil, a default function
// that returns a new whttprouter is used.
routerImplProvider func() wrouter.RouterImpl
// called on server initialization before the server starts. Is provided with a context that is active for the
// duration of the server lifetime, the server router (which can be used to register endpoints), the unmarshaled
// install configuration and the refreshable runtime configuration.
//
// If this function returns an error, the server is not started and the error is returned.
initFn InitFunc
// installConfigStruct is a concrete struct used to determine the type into which the install configuration bytes
// are unmarshaled. If nil, a default value of config.Install{} is used.
installConfigStruct interface{}
// runtimeConfigStruct is a concrete struct used to determine the type into which the runtime configuration bytes
// are unmarshaled. If nil, a default value of config.Runtime{} is used.
runtimeConfigStruct interface{}
// provides the encrypted-config-value key that is used to decrypt encrypted values in configuration. If nil, a
// default provider that reads the key from the file at "var/conf/encrypted-config-value.key" is used.
ecvKeyProvider ECVKeyProvider
// if true, then Go runtime metrics will not be recorded. If false, Go runtime metrics will be recorded at a
// collection interval that matches the metric emit interval specified in the install configuration (or every 60
// seconds if an interval is not specified in configuration).
disableGoRuntimeMetrics bool
// specifies the TLS client authentication mode used by the server. If not specified, the default value is
// tls.NoClientCert.
clientAuth tls.ClientAuthType
// specifies the value used for the "origin" field for service logs. If not specified, the default value is set to
// be the package from which "Start" was called.
svcLogOrigin *string
// traceSampler is the function that is used to determine whether or not a trace should be sampled. If nil, the
// default behavior is to sample every trace.
traceSampler func(id uint64) bool
// disableKeepAlives disables keep-alives.
disableKeepAlives bool
// request logger configuration
// idsExtractor specifies the extractor used to extract identifiers (such as UID, SID, TokenID) from requests for
// request logging and middleware. If nil, uses extractor.NewDefaultIDsExtractor().
idsExtractor extractor.IDsFromRequest
safePathParams []string
safeQueryParams []string
safeHeaderParams []string
// loggerStdoutWriter specifies the io.Writer that is written to if the loggers are in a mode that specifies that
// they should write to Stdout. If nil, os.Stdout is used by default.
loggerStdoutWriter io.Writer
// loggers
svcLogger svc1log.Logger
evtLogger evt2log.Logger
auditLogger audit2log.Logger
metricLogger metric1log.Logger
trcLogger trc1log.Logger
diagLogger diag1log.Logger
reqLogger req2log.Logger
// the http.Server for the main server
httpServer *http.Server
// allows the server to wait until Close() or Shutdown() return prior to returning from Start()
shutdownFinished sync.WaitGroup
}
// InitFunc is a function type used to initialize a server. ctx is a context configured with loggers and is valid for
// the duration of the server. Refer to the documentation of InitInfo for its fields.
//
// If the returned cleanup function is non-nil, it is deferred and run on server shutdown. If the returned error is
// non-nil, the server will not start and will return the error.
type InitFunc func(ctx context.Context, info InitInfo) (cleanup func(), rErr error)
type InitInfo struct {
// Router is a ConfigurableRouter that implements wrouter.Router for the server. It can be
// used to register endpoints on the server and to configure things such as health, readiness and liveness sources and
// any middleware (note that any values set using router will override any values previously set on the server).
Router ConfigurableRouter
// InstallConfig the install configuration. Its type is determined by the struct provided to the
// "WithInstallConfigType" function (the default is config.Install).
InstallConfig interface{}
// RuntimeConfig is a refreshable that contains the initial runtime configuration. The type returned by the
// refreshable is determined by the struct provided to the "WithRuntimeConfigType" function (the default is
// config.Runtime).
RuntimeConfig refreshable.Refreshable
// ShutdownServer gracefully closes the server, waiting for any in-flight requests to finish (or the context to be cancelled).
// When the InitFunc is executed, the server is not yet started. This will most often be useful if launching a goroutine which
// requires access to shutdown the server in some error condition.
ShutdownServer func(context.Context) error
}
// ConfigurableRouter is a wrouter.Router that provides additional support for configuring things such as health,
// readiness, liveness and middleware.
type ConfigurableRouter interface {
wrouter.Router
WithHealth(healthSources ...status.HealthCheckSource) *Server
WithReadiness(readiness status.Source) *Server
WithLiveness(liveness status.Source) *Server
}
// NewServer returns a new uninitialized server.
func NewServer() *Server {
return &Server{}
}
// WithInitFunc configures the server to use the provided setup function to set up its initial state.
func (s *Server) WithInitFunc(initFn InitFunc) *Server {
s.initFn = initFn
return s
}
// WithInstallConfigType configures the server to use the type of the provided struct as the type for the install
// configuration. The YAML representation of the install configuration is unmarshaled into a newly created struct that
// has the same type as the provided struct, so the provided struct should either embed or be compatible with
// config.Install.
func (s *Server) WithInstallConfigType(installConfigStruct interface{}) *Server {
s.installConfigStruct = installConfigStruct
return s
}
// WithRuntimeConfigType configures the server to use the type of the provided struct as the type for the runtime
// configuration. The YAML representation of the runtime configuration is unmarshaled into a newly created struct that
// has the same type as the provided struct, so the provided struct should either embed or be compatible with
// config.Runtime.
func (s *Server) WithRuntimeConfigType(runtimeConfigStruct interface{}) *Server {
s.runtimeConfigStruct = runtimeConfigStruct
return s
}
// WithInstallConfig configures the server to use the provided install configuration. The provided install configuration
// must support being marshaled as YAML.
func (s *Server) WithInstallConfig(installConfigStruct interface{}) *Server {
s.installConfigProvider = cfgBytesProviderFn(func() ([]byte, error) {
return yaml.Marshal(installConfigStruct)
})
return s
}
// WithInstallConfigFromFile configures the server to read the install configuration from the file at the specified
// path.
func (s *Server) WithInstallConfigFromFile(fpath string) *Server {
s.installConfigProvider = cfgBytesProviderFn(func() ([]byte, error) {
return ioutil.ReadFile(fpath)
})
return s
}
// WithInstallConfigProvider configures the server to use the install configuration obtained by reading the bytes from
// the specified ConfigBytesProvider.
func (s *Server) WithInstallConfigProvider(p ConfigBytesProvider) *Server {
s.installConfigProvider = p
return s
}
// WithRuntimeConfig configures the server to use the provided runtime configuration. The provided runtime configuration
// must support being marshaled as YAML.
func (s *Server) WithRuntimeConfig(in interface{}) *Server {
s.runtimeConfigProvider = func(_ context.Context) (refreshable.Refreshable, error) {
runtimeCfgYAML, err := yaml.Marshal(in)
if err != nil {
return nil, err
}
return refreshable.NewDefaultRefreshable(runtimeCfgYAML), nil
}
return s
}
// WithRuntimeConfigProvider configures the server to use the provided Refreshable as its runtime configuration. The
// value provided by the refreshable must be the byte slice for the runtime configuration.
func (s *Server) WithRuntimeConfigProvider(r refreshable.Refreshable) *Server {
s.runtimeConfigProvider = func(_ context.Context) (refreshable.Refreshable, error) {
return r, nil
}
return s
}
// WithRuntimeConfigFromFile configures the server to use the file at the provided path as its runtime configuration.
// The server will create a refreshable.Refreshable using the file at the provided path (and will thus live-reload the
// configuration based on updates to the file).
func (s *Server) WithRuntimeConfigFromFile(fpath string) *Server {
s.runtimeConfigProvider = func(ctx context.Context) (refreshable.Refreshable, error) {
return refreshable.NewFileRefreshable(ctx, fpath)
}
return s
}
// WithSelfSignedCertificate configures the server to use a dynamically generated self-signed certificate for its TLS
// authentication. Because there is no way to verify the certificate used by the server, this option is typically only
// used in tests or very specialized circumstances where the connection to the server can be verified/authenticated
// using separate external mechanisms.
func (s *Server) WithSelfSignedCertificate() *Server {
s.useSelfSignedServerCertificate = true
return s
}
// WithECVKeyFromFile configures the server to use the ECV key in the file at the specified path as the ECV key for
// decrypting ECV values in configuration.
func (s *Server) WithECVKeyFromFile(fPath string) *Server {
s.ecvKeyProvider = ECVKeyFromFile(fPath)
return s
}
// WithECVKeyProvider configures the server to use the ECV key provided by the specified provider as the ECV key for
// decrypting ECV values in configuration.
func (s *Server) WithECVKeyProvider(ecvProvider ECVKeyProvider) *Server {
s.ecvKeyProvider = ecvProvider
return s
}
// WithClientAuth configures the server to use the specified client authentication type for its TLS connections.
func (s *Server) WithClientAuth(clientAuth tls.ClientAuthType) *Server {
s.clientAuth = clientAuth
return s
}
// WithHealth configures the server to use the specified health check sources to report the server's health. If multiple
// healthSource's results have the same key, the result from the latest entry in healthSources will be used. These
// results are combined with the server's built-in health source, which uses the `SERVER_STATUS` key.
func (s *Server) WithHealth(healthSources ...status.HealthCheckSource) *Server {
s.healthCheckSources = healthSources
return s
}
// WithReadiness configures the server to use the specified source to report readiness.
func (s *Server) WithReadiness(readiness status.Source) *Server {
s.readinessSource = readiness
return s
}
// WithLiveness configures the server to use the specified source to report liveness.
func (s *Server) WithLiveness(liveness status.Source) *Server {
s.livenessSource = liveness
return s
}
// WithOrigin configures the server to use the specified origin.
func (s *Server) WithOrigin(origin string) *Server {
s.svcLogOrigin = &origin
return s
}
// WithMiddleware configures the server to use the specified middleware. The provided middleware is added to any other
// specified middleware.
func (s *Server) WithMiddleware(middleware wrouter.RequestHandlerMiddleware) *Server {
s.handlers = append(s.handlers, middleware)
return s
}
// WithRouterImplProvider configures the server to use the specified routerImplProvider to provide router
// implementations.
func (s *Server) WithRouterImplProvider(routerImplProvider func() wrouter.RouterImpl) *Server {
s.routerImplProvider = routerImplProvider
return s
}
// WithTraceSampler configures the server's trace log tracer to use the specified traceSampler function to make a
// determination on whether or not a trace should be sampled (if such a decision needs to be made).
func (s *Server) WithTraceSampler(traceSampler func(id uint64) bool) *Server {
s.traceSampler = traceSampler
return s
}
// WithSigQuitHandlerWriter sets the output for the goroutine dump on SIGQUIT.
func (s *Server) WithSigQuitHandlerWriter(w io.Writer) *Server {
s.sigQuitHandlerWriter = w
return s
}
// WithDisableSigQuitHandler disables the server's enabled-by-default goroutine dump on SIGQUIT.
func (s *Server) WithDisableSigQuitHandler() *Server {
s.disableSigQuitHandler = true
return s
}
// WithDisableShutdownSignalHandler disables the server's enabled-by-default shutdown on SIGTERM and SIGINT.
func (s *Server) WithDisableShutdownSignalHandler() *Server {
s.disableShutdownSignalHandler = true
return s
}
// WithDisableKeepAlives disables keep-alives on the server by calling SetKeepAlivesEnabled(false) on the http.Server
// used by the server. Note that this setting is only applied to the main server -- if the management server is separate
// from the main server, this setting is not applied to the management server. Refer to the documentation for
// SetKeepAlivesEnabled in http.Server for more information on when a server may want to use this setting.
func (s *Server) WithDisableKeepAlives() *Server {
s.disableKeepAlives = true
return s
}
// WithDisableGoRuntimeMetrics disables the server's enabled-by-default collection of runtime memory statistics.
func (s *Server) WithDisableGoRuntimeMetrics() *Server {
s.disableGoRuntimeMetrics = true
return s
}
// WithLoggerStdoutWriter configures the writer that loggers will write to IF they are configured to write to STDOUT.
// This configuration is typically only used in specialized scenarios (for example, to write logger output to an
// in-memory buffer rather than Stdout for tests).
func (s *Server) WithLoggerStdoutWriter(loggerStdoutWriter io.Writer) *Server {
s.loggerStdoutWriter = loggerStdoutWriter
return s
}
const (
defaultMetricEmitFrequency = time.Second * 60
ecvKeyPath = "var/conf/encrypted-config-value.key"
installConfigPath = "var/conf/install.yml"
runtimeConfigPath = "var/conf/runtime.yml"
)
// Start begins serving HTTPS traffic and blocks until s.Close() or s.Shutdown() return.
// Errors are logged via s.svcLogger before being returned.
// Panics are recovered; in the case of a recovered panic, Start will log and return
// a non-nil error containing the recovered object (overwriting any existing error).
func (s *Server) Start() (rErr error) {
defer func() {
if r := recover(); r != nil {
if err, ok := r.(error); ok {
rErr = err
} else {
rErr = werror.Error("panic recovered", werror.UnsafeParam("recovered", r))
}
if s.svcLogger == nil {
// If we have not yet initialized our loggers, use default configuration as best-effort.
s.initLoggers(false, wlog.InfoLevel)
}
s.svcLogger.Error("panic recovered", svc1log.SafeParam("stack", diag1log.ThreadDumpV1FromGoroutines(debug.Stack())), svc1log.Stacktrace(rErr))
}
}()
defer func() {
if rErr != nil {
if s.svcLogger == nil {
// If we have not yet initialized our loggers, use default configuration as best-effort.
s.initLoggers(false, wlog.InfoLevel)
}
s.svcLogger.Error(rErr.Error(), svc1log.Stacktrace(rErr))
}
}()
// Set state to "initializing". Fails if current state is not "idle" (ensures that this instance is not being run
// concurrently).
if err := s.stateManager.Start(); err != nil {
return err
}
// Reset state if server terminated without calling s.Close() or s.Shutdown()
defer func() {
if s.State() != ServerIdle {
s.stateManager.setState(ServerIdle)
}
}()
// set provider for ECV key
if s.ecvKeyProvider == nil {
s.ecvKeyProvider = ECVKeyFromFile(ecvKeyPath)
}
// load install configuration
baseInstallCfg, fullInstallCfg, err := s.initInstallConfig()
if err != nil {
return err
}
if s.idsExtractor == nil {
s.idsExtractor = extractor.NewDefaultIDsExtractor()
}
// initialize loggers
s.initLoggers(baseInstallCfg.UseConsoleLog, wlog.InfoLevel)
ctx, cancelCtx := context.WithCancel(context.Background())
defer cancelCtx()
// add loggers to context
ctx = svc1log.WithLogger(ctx, s.svcLogger)
ctx = evt2log.WithLogger(ctx, s.evtLogger)
ctx = metric1log.WithLogger(ctx, s.metricLogger)
ctx = trc1log.WithLogger(ctx, s.trcLogger)
ctx = audit2log.WithLogger(ctx, s.auditLogger)
// load runtime configuration
baseRefreshableRuntimeCfg, refreshableRuntimeCfg, err := s.initRuntimeConfig(ctx)
if err != nil {
return err
}
if loggerCfg := baseRefreshableRuntimeCfg.CurrentBaseRuntimeConfig().LoggerConfig; loggerCfg != nil {
s.svcLogger.SetLevel(loggerCfg.Level)
}
if s.routerImplProvider == nil {
s.routerImplProvider = func() wrouter.RouterImpl {
return whttprouter.New()
}
}
// initialize routers
router, mgmtRouter := s.initRouters(baseInstallCfg)
// initialize metrics
metricsRegistry, metricsDeferFn, err := s.initMetrics(ctx, baseInstallCfg)
if err != nil {
return err
}
defer metricsDeferFn()
ctx = metrics.WithRegistry(ctx, metricsRegistry)
// add middleware
s.addMiddleware(router.RootRouter(), metricsRegistry, s.defaultTracerOptions(baseInstallCfg.ProductName, baseInstallCfg.Server.Address, baseInstallCfg.Server.Port, baseInstallCfg.TraceSampleRate))
if mgmtRouter != router {
// add middleware to management router as well if it is distinct
s.addMiddleware(mgmtRouter.RootRouter(), metricsRegistry, s.defaultTracerOptions(baseInstallCfg.ProductName, baseInstallCfg.Server.Address, baseInstallCfg.Server.ManagementPort, baseInstallCfg.TraceSampleRate))
}
// handle built-in runtime config changes
unsubscribe := baseRefreshableRuntimeCfg.Map(func(in interface{}) interface{} {
return in.(config.Runtime).LoggerConfig
}).Subscribe(func(in interface{}) {
if loggerCfg := in.(*config.LoggerConfig); loggerCfg != nil {
s.svcLogger.SetLevel(loggerCfg.Level)
}
})
defer unsubscribe()
s.initStackTraceHandler(ctx)
s.initShutdownSignalHandler(ctx)
// wait for s.Close() or s.Shutdown() to return if called
defer s.shutdownFinished.Wait()
if s.initFn != nil {
traceReporter := wtracing.NewNoopReporter()
if s.trcLogger != nil {
traceReporter = s.trcLogger
}
tracer, err := wzipkin.NewTracer(traceReporter, s.defaultTracerOptions(baseInstallCfg.ProductName, baseInstallCfg.Server.Address, baseInstallCfg.Server.Port, baseInstallCfg.TraceSampleRate)...)
if err != nil {
return err
}
ctx = wtracing.ContextWithTracer(ctx, tracer)
cleanupFn, err := s.initFn(
ctx,
InitInfo{
Router: &configurableRouterImpl{
Router: newMultiRouterImpl(router, mgmtRouter),
Server: s,
},
InstallConfig: fullInstallCfg,
RuntimeConfig: refreshableRuntimeCfg,
ShutdownServer: s.Shutdown,
},
)
if err != nil {
return err
}
if cleanupFn != nil {
defer cleanupFn()
}
}
// add routes for health, liveness and readiness. Must be done after initFn to ensure that any
// health/liveness/readiness configuration updated by initFn is applied.
if err := s.addRoutes(mgmtRouter, baseRefreshableRuntimeCfg); err != nil {
return err
}
// only create and start a separate management http server if management port is explicitly specified and differs
// from the main server port
if mgmtPort := baseInstallCfg.Server.ManagementPort; mgmtPort != 0 && baseInstallCfg.Server.Port != mgmtPort {
mgmtStart, mgmtShutdown, err := s.newMgmtServer(baseInstallCfg.ProductName, baseInstallCfg.Server, mgmtRouter.RootRouter())
if err != nil {
return err
}
// start management server in its own goroutine
go wapp.RunWithRecoveryLogging(ctx, func(ctx context.Context) {
if err := mgmtStart(); err != nil {
svc1log.FromContext(ctx).Error("management server failed", svc1log.Stacktrace(err))
}
})
defer func() {
if err := mgmtShutdown(ctx); err != nil {
svc1log.FromContext(ctx).Error("management server failed to shutdown", svc1log.Stacktrace(err))
}
}()
}
httpServer, svrStart, _, err := s.newServer(baseInstallCfg.ProductName, baseInstallCfg.Server, router.RootRouter())
if err != nil {
return err
}
s.httpServer = httpServer
if s.disableKeepAlives {
s.httpServer.SetKeepAlivesEnabled(false)
}
s.stateManager.setState(ServerRunning)
return svrStart()
}
type configurableRouterImpl struct {
wrouter.Router
*Server
}
func (s *Server) initInstallConfig() (config.Install, interface{}, error) {
if s.installConfigProvider == nil {
// if install config provider is not specified, use a file-based one
s.installConfigProvider = cfgBytesProviderFn(func() ([]byte, error) {
return ioutil.ReadFile(installConfigPath)
})
}
cfgBytes, err := s.installConfigProvider.LoadBytes()
if err != nil {
return config.Install{}, nil, werror.Wrap(err, "Failed to load install configuration bytes")
}
cfgBytes, err = s.decryptConfigBytes(cfgBytes)
if err != nil {
return config.Install{}, nil, werror.Wrap(err, "Failed to decrypt install configuration bytes")
}
var baseInstallCfg config.Install
if err := yaml.Unmarshal(cfgBytes, &baseInstallCfg); err != nil {
return config.Install{}, nil, werror.Wrap(err, "Failed to unmarshal install base configuration YAML")
}
installConfigStruct := s.installConfigStruct
if installConfigStruct == nil {
installConfigStruct = config.Install{}
}
specificInstallCfg := reflect.New(reflect.TypeOf(installConfigStruct)).Interface()
if err := yaml.Unmarshal(cfgBytes, *&specificInstallCfg); err != nil {
return config.Install{}, nil, werror.Wrap(err, "Failed to unmarshal install specific configuration YAML")
}
return baseInstallCfg, reflect.Indirect(reflect.ValueOf(specificInstallCfg)).Interface(), nil
}
func (s *Server) initRuntimeConfig(ctx context.Context) (rBaseCfg refreshableBaseRuntimeConfig, rCfg refreshable.Refreshable, rErr error) {
if s.runtimeConfigProvider == nil {
// if runtime provider is not specified, use a file-based one
s.runtimeConfigProvider = func(ctx context.Context) (refreshable.Refreshable, error) {
return refreshable.NewFileRefreshable(ctx, runtimeConfigPath)
}
}
runtimeConfigProvider, err := s.runtimeConfigProvider(ctx)
if err != nil {
return nil, nil, err
}
runtimeConfigProvider = runtimeConfigProvider.Map(func(cfgBytesVal interface{}) interface{} {
cfgBytes, err := s.decryptConfigBytes(cfgBytesVal.([]byte))
if err != nil {
s.svcLogger.Warn("Failed to decrypt encrypted runtime configuration", svc1log.Stacktrace(err))
}
return cfgBytes
})
return newRefreshableBaseRuntimeConfig(runtimeConfigProvider.Map(func(cfgBytesVal interface{}) interface{} {
var runtimeCfg config.Runtime
if err := yaml.Unmarshal(cfgBytesVal.([]byte), &runtimeCfg); err != nil {
s.svcLogger.Error("Failed to unmarshal runtime configuration", svc1log.Stacktrace(err))
}
return runtimeCfg
})),
runtimeConfigProvider.Map(func(cfgBytesVal interface{}) interface{} {
runtimeConfigStruct := s.runtimeConfigStruct
if runtimeConfigStruct == nil {
runtimeConfigStruct = config.Runtime{}
}
runtimeCfg := reflect.New(reflect.TypeOf(runtimeConfigStruct)).Interface()
if err := yaml.Unmarshal(cfgBytesVal.([]byte), *&runtimeCfg); err != nil {
s.svcLogger.Error("Failed to unmarshal runtime configuration", svc1log.Stacktrace(err))
}
return reflect.Indirect(reflect.ValueOf(runtimeCfg)).Interface()
}),
nil
}
func (s *Server) initStackTraceHandler(ctx context.Context) {
if s.disableSigQuitHandler {
return
}
stackTraceHandler := func(stackTraceOutput []byte) error {
if s.diagLogger != nil {
s.diagLogger.Diagnostic(logging.NewDiagnosticFromThreadDump(diag1log.ThreadDumpV1FromGoroutines(stackTraceOutput)))
}
if s.sigQuitHandlerWriter != nil {
if _, err := s.sigQuitHandlerWriter.Write(stackTraceOutput); err != nil {
return err
}
}
return nil
}
errHandler := func(err error) {
if s.svcLogger != nil && err != nil {
s.svcLogger.Error("Failed to dump goroutines", svc1log.Stacktrace(err))
}
}
signals.RegisterStackTraceHandlerOnSignals(ctx, stackTraceHandler, errHandler, syscall.SIGQUIT)
}
func (s *Server) initShutdownSignalHandler(ctx context.Context) {
if s.disableShutdownSignalHandler {
return
}
shutdownSignal := make(chan os.Signal, 1)
signal.Notify(shutdownSignal, syscall.SIGTERM, syscall.SIGINT)
go wapp.RunWithRecoveryLogging(ctx, func(ctx context.Context) {
<-shutdownSignal
if err := s.Shutdown(ctx); err != nil {
s.svcLogger.Warn("Failed to gracefully shutdown server.", svc1log.Stacktrace(err))
}
})
}
// Running returns true if the server is in the "running" state (as opposed to "idle" or "initializing"), false
// otherwise.
func (s *Server) Running() bool {
return s.stateManager.Running()
}
// State returns the state of the current server (idle, initializing or running).
func (s *Server) State() ServerState {
return s.stateManager.State()
}
func (s *Server) Shutdown(ctx context.Context) error {
s.shutdownFinished.Add(1)
defer s.shutdownFinished.Done()
s.svcLogger.Info("Shutting down server")
return stopServer(s, func(svr *http.Server) error {
return svr.Shutdown(ctx)
})
}
func (s *Server) Close() error {
s.shutdownFinished.Add(1)
defer s.shutdownFinished.Done()
s.svcLogger.Info("Closing server")
return stopServer(s, func(svr *http.Server) error {
return svr.Close()
})
}
func (s *Server) decryptConfigBytes(cfgBytes []byte) ([]byte, error) {
if !encryptedconfigvalue.ContainsEncryptedConfigValueStringVars(cfgBytes) {
// Nothing to do
return cfgBytes, nil
}
if s.ecvKeyProvider == nil {
return cfgBytes, werror.Error("No encryption key provider configured but config contains encrypted values")
}
ecvKey, err := s.ecvKeyProvider.Load()
if err != nil {
return cfgBytes, err
}
if ecvKey == nil {
return cfgBytes, werror.Error("No encryption key configured but config contains encrypted values")
}
return encryptedconfigvalue.DecryptAllEncryptedValueStringVars(cfgBytes, *ecvKey), nil
}
func stopServer(s *Server, stopper func(s *http.Server) error) error {
if s.State() != ServerRunning {
return werror.Error("server is not running")
}
s.stateManager.setState(ServerIdle)
return stopper(s.httpServer)
}
func (s *Server) defaultTracerOptions(serviceName, address string, port int, sampleRate *float64) []wtracing.TracerOption {
var options []wtracing.TracerOption
endpoint := &wtracing.Endpoint{
ServiceName: serviceName,
Port: uint16(port),
}
if parsedIP := net.ParseIP(address); len(parsedIP) > 0 {
if parsedIP.To4() != nil {
endpoint.IPv4 = parsedIP
} else {
endpoint.IPv6 = parsedIP
}
}
options = append(options, wtracing.WithLocalEndpoint(endpoint))
if s.traceSampler != nil {
options = append(options, wtracing.WithSampler(s.traceSampler))
} else if sampleRate != nil {
options = append(options, wtracing.WithSampler(s.samplerForRate(*sampleRate)))
}
return options
}
func (s *Server) samplerForRate(sampleRate float64) wtracing.Sampler {
if sampleRate <= 0 {
if s.svcLogger != nil {
s.svcLogger.Info("Trace logging will be disabled due to trace-sample-rate <= 0")
}
return func(id uint64) bool { return false }
}
if sampleRate >= 1 {
if s.svcLogger != nil {
s.svcLogger.Info("Trace logging will sample all traces due to trace-sample-rate >= 1")
}
return func(id uint64) bool { return true }
}
boundary := uint64(sampleRate * float64(math.MaxUint64)) // does not overflow because we already checked bounds
return func(id uint64) bool {
return id < boundary
}
}