-
Notifications
You must be signed in to change notification settings - Fork 2
/
core.go
426 lines (387 loc) · 13.2 KB
/
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
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
package core
import (
"context"
"crypto/tls"
"errors"
"fmt"
"io"
"net"
"net/http"
"net/http/pprof"
"strings"
"sync"
"time"
"github.com/NYTimes/gziphandler"
"github.com/go-coldbrew/core/config"
"github.com/go-coldbrew/interceptors"
"github.com/go-coldbrew/log"
"github.com/go-coldbrew/log/loggers"
"github.com/go-coldbrew/options"
grpc_opentracing "github.com/grpc-ecosystem/go-grpc-middleware/tracing/opentracing"
grpc_prometheus "github.com/grpc-ecosystem/go-grpc-prometheus"
"github.com/grpc-ecosystem/grpc-gateway/v2/runtime"
"github.com/opentracing/opentracing-go"
"github.com/opentracing/opentracing-go/ext"
"github.com/prometheus/client_golang/prometheus/promhttp"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials"
"google.golang.org/grpc/credentials/insecure"
"google.golang.org/grpc/keepalive"
"google.golang.org/grpc/reflection"
)
type cb struct {
svc []CBService
openAPIHandler http.Handler
config config.Config
closers []io.Closer
grpcServer *grpc.Server
httpServer *http.Server
cancelFunc context.CancelFunc
gracefulWait sync.WaitGroup
creds credentials.TransportCredentials
}
func (c *cb) SetService(svc CBService) error {
if svc == nil {
return errors.New("service is nil")
}
c.svc = append(c.svc, svc)
return nil
}
// SetOpenAPIHandler sets the openapi handler
// This is used to serve the openapi spec
// This is optional
func (c *cb) SetOpenAPIHandler(handler http.Handler) {
c.openAPIHandler = handler
}
// processConfig processes the config and sets up the logger, newrelic, sentry, environment, release name, jaeger, hystrix prometheus and signal handler
func (c *cb) processConfig() {
SetupLogger(c.config.LogLevel, c.config.JSONLogs)
if !c.config.DisableVTProtobuf {
InitializeVTProto()
}
nrName := c.config.AppName
if nrName == "" {
nrName = c.config.AppName
}
if !c.config.DisableAutoMaxProcs {
SetupAutoMaxProcs()
}
SetupNewRelic(nrName, c.config.NewRelicLicenseKey, c.config.NewRelicDistributedTracing)
SetupSentry(c.config.SentryDSN)
SetupEnvironment(c.config.Environment)
SetupReleaseName(c.config.ReleaseName)
cls := setupJaeger(c.config.AppName)
if cls != nil {
c.closers = append(c.closers, cls)
}
SetupHystrixPrometheus()
ConfigureInterceptors(c.config.DoNotLogGRPCReflection, c.config.TraceHeaderName)
if !c.config.DisableSignalHandler {
dur := time.Second * 10
if c.config.ShutdownDurationInSeconds > 0 {
dur = time.Second * time.Duration(c.config.ShutdownDurationInSeconds)
}
startSignalHandler(c, dur)
}
if c.config.EnablePrometheusGRPCHistogram {
grpc_prometheus.EnableHandlingTimeHistogram()
}
if c.config.NewRelicOpentelemetry {
SetupNROpenTelemetry(nrName, c.config.NewRelicLicenseKey, c.config.ReleaseName, c.config.NewRelicOpentelemetrySample)
}
}
// https://grpc-ecosystem.github.io/grpc-gateway/docs/operations/tracing/#opentracing-support
var grpcGatewayTag = opentracing.Tag{Key: string(ext.Component), Value: "grpc-gateway"}
// tracingWrapper is a middleware that creates a new span for each incoming request.
// It also adds the span to the context so it can be used by other middlewares or handlers to add additional tags.
func tracingWrapper(h http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
parentSpanContext, err := opentracing.GlobalTracer().Extract(
opentracing.HTTPHeaders,
opentracing.HTTPHeadersCarrier(r.Header))
if err == nil || err == opentracing.ErrSpanContextNotFound {
if interceptors.FilterMethodsFunc(r.Context(), r.URL.Path) {
serverSpan := opentracing.GlobalTracer().StartSpan(
"ServeHTTP",
// this is magical, it attaches the new span to the parent parentSpanContext, and creates an unparented one if empty.
ext.RPCServerOption(parentSpanContext),
grpcGatewayTag,
opentracing.Tag{Key: string(ext.HTTPUrl), Value: r.URL.Path},
opentracing.Tag{Key: string(ext.HTTPMethod), Value: r.Method},
)
r = r.WithContext(opentracing.ContextWithSpan(r.Context(), serverSpan))
defer serverSpan.Finish()
}
}
_, han := interceptors.NRHttpTracer("", h.ServeHTTP)
// add this info to log
ctx := r.Context()
ctx = options.AddToOptions(ctx, "", "")
ctx = loggers.AddToLogContext(ctx, "httpPath", r.URL.Path)
r = r.WithContext(ctx)
han(w, r)
})
}
// getCustomHeaderMatcher returns a matcher that matches the given header and prefix
func getCustomHeaderMatcher(prefixes []string, header string) func(string) (string, bool) {
header = strings.ToLower(header)
return func(key string) (string, bool) {
key = strings.ToLower(key)
if key == header {
return key, true
} else if len(prefixes) > 0 {
for _, prefix := range prefixes {
if len(prefix) > 0 && strings.HasPrefix(key, strings.ToLower(prefix)) {
return key, true
}
}
}
return runtime.DefaultHeaderMatcher(key)
}
}
func (c *cb) initHTTP(ctx context.Context) (*http.Server, error) {
// Register gRPC server endpoint
// Note: Make sure the gRPC server is running properly and accessible
grpcServerEndpoint := fmt.Sprintf("%s:%d", c.config.ListenHost, c.config.GRPCPort)
pMar := &runtime.ProtoMarshaller{}
allowedHttpHeaderPrefixes := c.config.HTTPHeaderPrefixes
// maintaining backward compatibility
if len(c.config.HTTPHeaderPrefix) > 0 && len(allowedHttpHeaderPrefixes) == 0 {
allowedHttpHeaderPrefixes = []string{c.config.HTTPHeaderPrefix}
}
muxOpts := []runtime.ServeMuxOption{
runtime.WithIncomingHeaderMatcher(getCustomHeaderMatcher(allowedHttpHeaderPrefixes, c.config.TraceHeaderName)),
runtime.WithMarshalerOption("application/proto", pMar),
runtime.WithMarshalerOption("application/protobuf", pMar),
}
if c.config.UseJSONBuiltinMarshaller {
muxOpts = append(muxOpts, runtime.WithMarshalerOption(c.config.JSONBuiltinMarshallerMime, &runtime.JSONBuiltin{}))
}
mux := runtime.NewServeMux(muxOpts...)
creds := c.creds
if creds == nil {
creds = insecure.NewCredentials()
}
opts := []grpc.DialOption{
grpc.WithTransportCredentials(creds),
grpc.WithUnaryInterceptor(
interceptors.DefaultClientInterceptor(
grpc_opentracing.WithTraceHeaderName(c.config.TraceHeaderName),
grpc_opentracing.WithFilterFunc(interceptors.FilterMethodsFunc),
interceptors.WithoutHystrix(),
),
),
}
for _, s := range c.svc {
if err := s.InitHTTP(ctx, mux, grpcServerEndpoint, opts); err != nil {
return nil, err
}
}
// Start HTTP server (and proxy calls to gRPC server endpoint)
gatewayAddr := fmt.Sprintf("%s:%d", c.config.ListenHost, c.config.HTTPPort)
gwServer := &http.Server{
Addr: gatewayAddr,
Handler: http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
if !c.config.DisableSwagger && c.openAPIHandler != nil && strings.HasPrefix(r.URL.Path, c.config.SwaggerURL) {
http.StripPrefix(c.config.SwaggerURL, c.openAPIHandler).ServeHTTP(w, r)
return
} else if !c.config.DisableDebug && strings.HasPrefix(r.URL.Path, "/debug/pprof/cmdline") {
pprof.Cmdline(w, r)
return
} else if !c.config.DisableDebug && strings.HasPrefix(r.URL.Path, "/debug/pprof/profile") {
pprof.Profile(w, r)
return
} else if !c.config.DisableDebug && strings.HasPrefix(r.URL.Path, "/debug/pprof/symbol") {
pprof.Symbol(w, r)
return
} else if !c.config.DisableDebug && strings.HasPrefix(r.URL.Path, "/debug/pprof/trace") {
pprof.Trace(w, r)
return
} else if !c.config.DisableDebug && strings.HasPrefix(r.URL.Path, "/debug/pprof/") {
pprof.Index(w, r)
return
} else if !c.config.DisablePormetheus && strings.HasPrefix(r.URL.Path, "/metrics") {
promhttp.Handler().ServeHTTP(w, r)
return
}
gziphandler.GzipHandler(tracingWrapper(mux)).ServeHTTP(w, r)
}),
}
log.Info(ctx, "msg", "Starting HTTP server", "address", gatewayAddr)
return gwServer, nil
}
func (c *cb) runHTTP(_ context.Context, svr *http.Server) error {
return svr.ListenAndServe()
}
func (c *cb) getGRPCServerOptions() []grpc.ServerOption {
so := make([]grpc.ServerOption, 0)
so = append(so,
grpc.ChainUnaryInterceptor(interceptors.DefaultInterceptors()...),
grpc.ChainStreamInterceptor(interceptors.DefaultStreamInterceptors()...),
)
if c.config.GRPCServerMaxConnectionAgeGraceInSeconds > 0 ||
c.config.GRPCServerMaxConnectionAgeInSeconds > 0 ||
c.config.GRPCServerMaxConnectionIdleInSeconds > 0 {
option := keepalive.ServerParameters{}
if c.config.GRPCServerMaxConnectionIdleInSeconds > 0 {
option.MaxConnectionIdle = time.Duration(c.config.GRPCServerMaxConnectionIdleInSeconds) * time.Second
}
if c.config.GRPCServerMaxConnectionAgeInSeconds > 0 {
option.MaxConnectionAge = time.Duration(c.config.GRPCServerMaxConnectionAgeInSeconds) * time.Second
}
if c.config.GRPCServerMaxConnectionAgeGraceInSeconds > 0 {
option.MaxConnectionAgeGrace = time.Duration(c.config.GRPCServerMaxConnectionAgeGraceInSeconds) * time.Second
}
so = append(so, grpc.KeepaliveParams(option))
}
return so
}
func loadTLSCredentials(certFile, keyFile string, insecureSkipVerify bool) (credentials.TransportCredentials, error) {
// Load server's certificate and private key
serverCert, err := tls.LoadX509KeyPair(certFile, keyFile)
if err != nil {
return nil, err
}
// Create the credentials and return it
config := &tls.Config{
Certificates: []tls.Certificate{serverCert},
ClientAuth: tls.NoClientCert,
InsecureSkipVerify: insecureSkipVerify,
}
return credentials.NewTLS(config), nil
}
func (c *cb) initGRPC(ctx context.Context) (*grpc.Server, error) {
so := c.getGRPCServerOptions()
if c.config.GRPCTLSCertFile != "" && c.config.GRPCTLSKeyFile != "" {
creds, err := loadTLSCredentials(c.config.GRPCTLSCertFile, c.config.GRPCTLSKeyFile, c.config.GRPCTLSInsecureSkipVerify)
if err != nil {
return nil, err
}
c.creds = creds
so = append(so, grpc.Creds(creds))
}
grpcServer := grpc.NewServer(so...)
for _, s := range c.svc {
if err := s.InitGRPC(ctx, grpcServer); err != nil {
return nil, err
}
}
return grpcServer, nil
}
func (c *cb) runGRPC(ctx context.Context, svr *grpc.Server) error {
grpcServerEndpoint := fmt.Sprintf("%s:%d", c.config.ListenHost, c.config.GRPCPort)
lis, err := net.Listen("tcp", grpcServerEndpoint)
if err != nil {
return fmt.Errorf("failed to listen: %v", err)
}
if !c.config.DisableGRPCReflection {
reflection.Register(svr)
}
log.Info(ctx, "msg", "Starting GRPC server", "address", grpcServerEndpoint)
return svr.Serve(lis)
}
// Run starts the service
// It will block until the service is stopped
// It will return an error if the service fails to start
// It will return nil if the service is stopped
// It will return an error if the service fails to stop
// It will return an error if the service fails to run
func (c *cb) Run() error {
ctx := context.Background()
ctx, c.cancelFunc = context.WithCancel(ctx)
defer c.cancelFunc()
var err error
c.grpcServer, err = c.initGRPC(ctx)
if err != nil {
return err
}
c.httpServer, err = c.initHTTP(ctx)
if err != nil {
return err
}
errChan := make(chan error, 2)
go func() {
errChan <- c.runGRPC(ctx, c.grpcServer)
}()
go func() {
errChan <- c.runHTTP(ctx, c.httpServer)
}()
err = <-errChan
c.gracefulWait.Wait() // if graceful shutdown is in progress wait for it to finish
c.close()
return err
}
func (c *cb) close() {
for _, closer := range c.closers {
if closer != nil {
log.Info(context.Background(), "closing", closer)
closer.Close()
}
}
}
// Stop stops the server gracefully
// It will wait for the duration specified in the config for the healthcheck to pass
func (c *cb) Stop(dur time.Duration) error {
c.gracefulWait.Add(1) // tell runner that a graceful shutdow is in progress
defer c.gracefulWait.Done()
ctx, cancel := context.WithTimeout(context.Background(), dur)
defer func() {
cancel()
if c.cancelFunc != nil {
c.cancelFunc()
}
}()
for _, svc := range c.svc {
if s, ok := svc.(CBGracefulStopper); ok {
s.FailCheck(true)
}
}
if c.config.HealthcheckWaitDurationInSeconds > 0 {
d := time.Second * time.Duration(c.config.HealthcheckWaitDurationInSeconds)
log.Info(context.Background(), "msg", "graceful shutdown timer started", "duration", d)
time.Sleep(d)
log.Info(context.Background(), "msg", "graceful shutdown timer finished", "duration", d)
}
log.Info(context.Background(), "msg", "Server shut down started, bye bye")
if c.httpServer != nil {
go c.httpServer.Shutdown(ctx)
}
if c.grpcServer != nil {
timedCall(ctx, c.grpcServer.GracefulStop)
c.grpcServer.Stop()
}
for _, svc := range c.svc {
// call stopper to stop services
if s, ok := svc.(CBStopper); ok {
s.Stop()
}
}
return nil
}
func timedCall(ctx context.Context, f func()) {
done := make(chan struct{})
go func() {
f()
close(done)
}()
select {
case <-done:
log.Info(context.Background(), "grpc graceful shutdown complete")
case <-ctx.Done():
log.Info(context.Background(), "grpc graceful shutdown failed, forcing shutdown")
}
}
// New creates a new ColdBrew object
// It takes a config object and returns a CB interface
// The CB interface is used to start and stop the server
// The CB interface also provides a way to add services to the server
// The services are added using the AddService method
// The services are started and stopped in the order they are added
func New(c config.Config) CB {
impl := &cb{
config: c,
svc: make([]CBService, 0),
}
impl.processConfig()
return impl
}