-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathcore.go
More file actions
982 lines (905 loc) · 31.7 KB
/
core.go
File metadata and controls
982 lines (905 loc) · 31.7 KB
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
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
package core
import (
"context"
"crypto/tls"
"errors"
"fmt"
"io"
"net"
"net/http"
"net/http/pprof"
"os"
"strconv"
"strings"
"sync"
"time"
"golang.org/x/sync/errgroup"
"github.com/cloudflare/certinel/fswatcher"
"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"
grpcprom "github.com/grpc-ecosystem/go-grpc-middleware/providers/prometheus"
"github.com/grpc-ecosystem/grpc-gateway/v2/runtime"
"github.com/klauspost/compress/gzhttp"
"github.com/prometheus/client_golang/prometheus/promhttp"
"go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc"
"go.opentelemetry.io/otel"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/codes"
"go.opentelemetry.io/otel/propagation"
sdkmetric "go.opentelemetry.io/otel/sdk/metric"
semconv "go.opentelemetry.io/otel/semconv/v1.40.0"
oteltrace "go.opentelemetry.io/otel/trace"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials"
"google.golang.org/grpc/credentials/insecure"
_ "google.golang.org/grpc/encoding/gzip"
experimental "google.golang.org/grpc/experimental/opentelemetry"
"google.golang.org/grpc/keepalive"
"google.golang.org/grpc/reflection"
"google.golang.org/grpc/stats"
grpcotel "google.golang.org/grpc/stats/opentelemetry"
)
// SupportPackageIsVersion1 is a compile-time assertion constant.
// Downstream packages reference this to enforce version compatibility.
const SupportPackageIsVersion1 = true
// Compile-time version compatibility checks.
const _ = interceptors.SupportPackageIsVersion1
type cb struct {
svc []CBService
openAPIHandler http.Handler
config config.Config
closers []io.Closer
grpcServer *grpc.Server
httpServer *http.Server
adminServer *http.Server
cancelFunc context.CancelFunc
gracefulWait sync.WaitGroup
creds credentials.TransportCredentials
certWatcher *fswatcher.Sentinel
unixSocketPath string
}
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
}
// parseHeaders parses a comma-separated string of key=value pairs into a map
// Example: "key1=value1,key2=value2" -> map[string]string{"key1": "value1", "key2": "value2"}
func parseHeaders(headerString string) map[string]string {
headers := make(map[string]string)
if headerString == "" {
return headers
}
pairs := strings.SplitSeq(headerString, ",")
for pair := range pairs {
kv := strings.SplitN(strings.TrimSpace(pair), "=", 2)
if len(kv) == 2 {
headers[strings.TrimSpace(kv[0])] = strings.TrimSpace(kv[1])
} else {
log.Warn(context.Background(), "msg", "Ignoring malformed header pair Expected format 'key=value'", "pair", pair)
}
}
return headers
}
// processConfig processes the config and sets up the logger, newrelic, sentry, environment, release name, OpenTelemetry tracing, hystrix prometheus and signal handler
func (c *cb) processConfig() {
if err := SetupLogger(c.config.LogLevel, c.config.JSONLogs); err != nil {
log.Error(context.Background(), "msg", "failed to setup logger", "err", err)
}
if !c.config.DisableVTProtobuf {
InitializeVTProto()
}
nrName := c.config.AppName
if nrName == "" {
nrName = c.config.AppName
}
if !c.config.DisableAutoMaxProcs {
SetupAutoMaxProcs()
}
// Auto-disable NewRelic when no license key is configured to avoid
// interceptor overhead for services that don't use NR.
if !c.config.DisableNewRelic && strings.TrimSpace(c.config.NewRelicLicenseKey) == "" {
c.config.DisableNewRelic = true
}
if !c.config.DisableNewRelic {
err := SetupNewRelic(nrName, c.config.NewRelicLicenseKey, c.config.NewRelicDistributedTracing)
if err != nil {
log.Error(context.Background(), "Error setting up NewRelic tracing", "error", err)
}
}
SetupSentry(c.config.SentryDSN)
SetupEnvironment(c.config.Environment)
SetupReleaseName(c.config.ReleaseName)
SetupHystrixPrometheus()
configureInterceptors(c.config.DoNotLogGRPCReflection, c.config.TraceHeaderName, c.config.ResponseTimeLogLevel, c.config.ResponseTimeLogErrorOnly, c.config.GRPCServerDefaultTimeoutInSeconds)
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.DisableProtoValidate {
interceptors.SetDisableProtoValidate(true)
}
if c.config.DisableDebugLogInterceptor {
interceptors.SetDisableDebugLogInterceptor(true)
}
if c.config.DebugLogHeaderName != "" {
interceptors.SetDebugLogHeaderName(c.config.DebugLogHeaderName)
}
if c.config.DisableRateLimit {
interceptors.SetDisableRateLimit(true)
}
if c.config.RateLimitPerSecond > 0 {
interceptors.SetDefaultRateLimit(c.config.RateLimitPerSecond, c.config.RateLimitBurst)
}
if c.config.EnablePrometheusGRPCHistogram {
if len(c.config.PrometheusGRPCHistogramBuckets) > 0 {
interceptors.SetServerMetricsOptions(
grpcprom.WithServerHandlingTimeHistogram(
grpcprom.WithHistogramBuckets(c.config.PrometheusGRPCHistogramBuckets),
),
)
} else {
interceptors.SetServerMetricsOptions(
grpcprom.WithServerHandlingTimeHistogram(),
)
}
}
// Warn if deprecated OpenTracing bridge env var is still set.
if c.config.OTLPUseOpenTracingBridge { //nolint:staticcheck // reading deprecated field to emit warning
log.Warn(context.Background(), "msg", "OTLP_USE_OPENTRACING_BRIDGE is set but OpenTracing bridge has been removed; this setting is ignored")
}
// Setup OpenTelemetry - custom OTLP takes precedence over New Relic
prevTP := otelTracerProvider // track whether this call initializes a new provider
var otlpConfig OTLPConfig
if c.config.OTLPEndpoint != "" {
headers := parseHeaders(c.config.OTLPHeaders)
otlpConfig = OTLPConfig{
Endpoint: c.config.OTLPEndpoint,
Headers: headers,
ServiceName: c.config.AppName,
ServiceVersion: c.config.ReleaseName,
SamplingRatio: c.config.OTLPSamplingRatio,
Compression: c.config.OTLPCompression,
Insecure: c.config.OTLPInsecure,
}
if err := SetupOpenTelemetry(otlpConfig); err != nil {
log.Error(context.Background(), "msg", "Failed to setup custom OTLP", "err", err)
}
} else if c.config.NewRelicOpentelemetry {
err := SetupNROpenTelemetry(
nrName,
c.config.NewRelicLicenseKey,
c.config.ReleaseName,
c.config.NewRelicOpentelemetrySample,
)
if err != nil {
log.Error(context.Background(), "msg", "Failed to setup New Relic OpenTelemetry", "err", err)
}
// Build otlpConfig for NR path so OTEL metrics can reuse the endpoint.
// Only populate when the license key is non-empty (SetupNROpenTelemetry
// no-ops without it, so metrics would just get auth failures).
if strings.TrimSpace(c.config.NewRelicLicenseKey) != "" {
otlpConfig = OTLPConfig{
Endpoint: nrOTLPEndpoint,
Headers: map[string]string{"api-key": c.config.NewRelicLicenseKey},
ServiceName: nrName,
ServiceVersion: c.config.ReleaseName,
Compression: "gzip",
}
}
}
// Register TracerProvider for graceful shutdown — only if this
// processConfig() call actually initialized a new one.
if tp := otelTracerProvider; tp != nil && tp != prevTP {
c.closers = append(c.closers, closerFunc(func() error {
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
return tp.Shutdown(ctx)
}))
}
if c.config.EnableOTELMetrics {
if otlpConfig.Endpoint == "" {
log.Error(context.Background(), "msg", "ENABLE_OTEL_METRICS is true but no OTLP endpoint is configured; OTEL metrics will not be exported")
} else {
interval := time.Duration(c.config.OTELMetricsInterval) * time.Second
mp, err := SetupOTELMetrics(otlpConfig, interval)
if err != nil {
log.Error(context.Background(), "msg", "Failed to setup OTEL metrics", "err", err)
} else {
otelMeterProvider = mp
c.closers = append(c.closers, closerFunc(func() error {
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
return mp.Shutdown(ctx)
}))
}
}
}
// Record legacy preference so getGRPCServerOptions/initHTTP respect it
// even if SetOTELOptions() was called during init.
otelUseLegacy = c.config.OTELUseLegacyInstrumentation
// Build native stats/opentelemetry options unless user already called
// SetOTELOptions() or legacy instrumentation is requested.
if !otelUseLegacy && !otelGRPCOptionsSet {
otelGRPCOptions = buildOTELOptions()
otelGRPCOptionsSet = true
}
}
// statusRecorder wraps http.ResponseWriter to capture the final HTTP status code.
// It records the first status >= 200, plus 101 Switching Protocols (which is
// terminal). Other 1xx statuses are informational and skipped.
// Unwrap() is provided for http.ResponseController (Go 1.20+) to access optional
// interfaces (http.Flusher, http.Hijacker, etc.) from the underlying writer.
type statusRecorder struct {
http.ResponseWriter
status int
wroteHeader bool
}
var statusRecorderPool = sync.Pool{
New: func() any {
return &statusRecorder{}
},
}
func (sr *statusRecorder) WriteHeader(code int) {
if !sr.wroteHeader && (code >= 200 || code == http.StatusSwitchingProtocols) {
sr.status = code
sr.wroteHeader = true
}
sr.ResponseWriter.WriteHeader(code)
}
func (sr *statusRecorder) Write(b []byte) (int, error) {
if !sr.wroteHeader {
sr.status = http.StatusOK
sr.wroteHeader = true
}
return sr.ResponseWriter.Write(b)
}
// Unwrap returns the underlying ResponseWriter so that http.ResponseController
// and middleware can access optional interfaces (http.Flusher, http.Hijacker, etc.).
func (sr *statusRecorder) Unwrap() http.ResponseWriter {
return sr.ResponseWriter
}
// endSpan records the HTTP status code on the span, marks it as error for 5xx, and ends it.
func endSpan(span oteltrace.Span, rec *statusRecorder) {
span.SetAttributes(semconv.HTTPResponseStatusCode(rec.status))
if rec.status >= 500 {
span.SetStatus(codes.Error, http.StatusText(rec.status))
}
span.End()
}
// httpSpanAttributes returns the OTEL attributes for an incoming HTTP request,
// omitting empty-valued attributes (e.g. scheme behind a reverse proxy).
func httpSpanAttributes(r *http.Request) []attribute.KeyValue {
host, port, err := net.SplitHostPort(r.Host)
if err != nil {
host = r.Host
}
host = strings.TrimPrefix(strings.TrimSuffix(host, "]"), "[")
// Pre-allocate for the common case: method + path + host + scheme + optional port/query.
var attrBuf [6]attribute.KeyValue
attrBuf[0] = semconv.HTTPRequestMethodKey.String(r.Method)
attrBuf[1] = semconv.URLPath(r.URL.Path)
attrs := attrBuf[:2]
if host != "" {
attrs = append(attrs, semconv.ServerAddress(host))
}
if port != "" {
if p, err := strconv.Atoi(port); err == nil {
attrs = append(attrs, semconv.ServerPort(p))
}
}
if r.URL.RawQuery != "" {
attrs = append(attrs, semconv.URLQuery(r.URL.RawQuery))
}
scheme := r.URL.Scheme
if scheme == "" {
if proto := r.Header.Get("X-Forwarded-Proto"); proto != "" {
scheme = proto
} else if r.TLS != nil {
scheme = "https"
} else {
scheme = "http"
}
}
attrs = append(attrs, semconv.URLScheme(scheme))
return attrs
}
// tracingWrapper is a middleware that creates a new OTEL span for each incoming HTTP request.
// It extracts any propagated trace context from the request headers and, for non-filtered
// methods, starts a server span that is attached to the request context.
func tracingWrapper(h http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
ctx := otel.GetTextMapPropagator().Extract(r.Context(), propagation.HeaderCarrier(r.Header))
if interceptors.FilterMethodsFunc(ctx, r.URL.Path) {
var serverSpan oteltrace.Span
ctx, serverSpan = otel.Tracer("coldbrew-http").Start(ctx, r.Method,
oteltrace.WithSpanKind(oteltrace.SpanKindServer),
oteltrace.WithAttributes(httpSpanAttributes(r)...),
)
rec := statusRecorderPool.Get().(*statusRecorder)
rec.ResponseWriter = w
rec.status = http.StatusOK
rec.wroteHeader = false
w = rec
defer func() {
if recovered := recover(); recovered != nil {
if !rec.wroteHeader {
rec.status = http.StatusInternalServerError
}
serverSpan.RecordError(fmt.Errorf("panic: %v", recovered))
serverSpan.SetStatus(codes.Error, "panic")
endSpan(serverSpan, rec)
rec.ResponseWriter = nil
statusRecorderPool.Put(rec)
panic(recovered)
}
endSpan(serverSpan, rec)
rec.ResponseWriter = nil
statusRecorderPool.Put(rec)
}()
}
_, han := interceptors.NRHttpTracer("", h.ServeHTTP)
// No-op with empty key (returns ctx unchanged). Kept for historical
// reasons; the subsequent AddToLogContext call initializes RequestContext.
ctx = options.AddToOptions(ctx, "", "")
ctx = loggers.AddToLogContext(ctx, "httpPath", r.URL.Path)
han(w, r.WithContext(ctx))
})
}
// spanRouteMiddleware is a grpc-gateway middleware that updates the OTEL span
// name and http.route attribute with the matched route pattern after routing.
// It uses runtime.HTTPPattern (the Pattern struct set by handleHandler) rather
// than runtime.HTTPPathPattern (the string set later inside AnnotateContext).
func spanRouteMiddleware(next runtime.HandlerFunc) runtime.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request, pathParams map[string]string) {
if pattern, ok := runtime.HTTPPattern(r.Context()); ok {
route := pattern.String()
span := oteltrace.SpanFromContext(r.Context())
span.SetName(r.Method + " " + route)
span.SetAttributes(semconv.HTTPRoute(route))
}
next(w, r, pathParams)
}
}
// getCustomHeaderMatcher returns a matcher that matches the given exact headers and prefixes.
// Exact-match headers (e.g., trace header, debug log header) are forwarded from HTTP to gRPC metadata.
func getCustomHeaderMatcher(prefixes []string, headers ...string) func(string) (string, bool) {
lowerHeaders := make([]string, 0, len(headers))
for _, h := range headers {
if h != "" {
lowerHeaders = append(lowerHeaders, strings.ToLower(h))
}
}
lowerPrefixes := make([]string, 0, len(prefixes))
for _, p := range prefixes {
if p != "" {
lowerPrefixes = append(lowerPrefixes, strings.ToLower(p))
}
}
return func(key string) (string, bool) {
key = strings.ToLower(key)
for _, h := range lowerHeaders {
if key == h {
return key, true
}
}
for _, prefix := range lowerPrefixes {
if strings.HasPrefix(key, 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, c.config.DebugLogHeaderName),
),
runtime.WithMarshalerOption("application/proto", pMar),
runtime.WithMarshalerOption("application/protobuf", pMar),
runtime.WithMiddlewares(spanRouteMiddleware),
}
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()
}
// Use unix socket for the gateway's internal connection when available.
// Only when TLS is not configured — grpc.Server applies TLS to all listeners,
// so insecure dial would fail the handshake.
dialEndpoint := grpcServerEndpoint
dialCreds := creds
if c.unixSocketPath != "" && c.creds == nil {
dialEndpoint = "unix:" + c.unixSocketPath
dialCreds = insecure.NewCredentials()
}
opts := []grpc.DialOption{
grpc.WithTransportCredentials(dialCreds),
}
// Use native stats/opentelemetry unless legacy mode is forced via config.
if !otelUseLegacy && otelGRPCOptionsSet {
opts = append(opts, grpcotel.DialOption(otelGRPCOptions))
} else {
opts = append(opts, grpc.WithStatsHandler(otelgrpc.NewClientHandler(otelGRPCClientOpts...)))
}
opts = append(opts, grpc.WithUnaryInterceptor(
interceptors.DefaultClientInterceptor(
interceptors.WithoutHystrix(),
),
))
// Mirror configured limits on the client side used by the gateway.
if c.config.GRPCMaxRecvMsgSize > 0 {
opts = append(opts,
grpc.WithDefaultCallOptions(grpc.MaxCallRecvMsgSize(c.config.GRPCMaxRecvMsgSize)),
)
}
if c.config.GRPCMaxSendMsgSize > 0 {
opts = append(opts,
grpc.WithDefaultCallOptions(grpc.MaxCallSendMsgSize(c.config.GRPCMaxSendMsgSize)),
)
}
for _, s := range c.svc {
if err := s.InitHTTP(ctx, mux, dialEndpoint, 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)
promHandler := promhttp.Handler()
gzipHandler := http.Handler(tracingWrapper(mux))
if !c.config.DisableHTTPCompression {
wrapper, err := gzhttp.NewWrapper(gzhttp.MinSize(c.config.HTTPCompressionMinSize))
if err != nil {
return nil, fmt.Errorf("failed to create compression handler: %w", err)
}
gzipHandler = wrapper(gzipHandler)
}
adminMux := http.NewServeMux()
if !c.config.DisableDebug {
adminMux.Handle("/debug/pprof/cmdline", http.HandlerFunc(pprof.Cmdline))
adminMux.Handle("/debug/pprof/profile", http.HandlerFunc(pprof.Profile))
adminMux.Handle("/debug/pprof/symbol", http.HandlerFunc(pprof.Symbol))
adminMux.Handle("/debug/pprof/trace", http.HandlerFunc(pprof.Trace))
adminMux.Handle("/debug/pprof/", http.HandlerFunc(pprof.Index))
}
if !(c.config.DisablePrometheus || c.config.DisablePormetheus) { //nolint:staticcheck // intentional use of deprecated field for backward compatibility
adminMux.Handle("/metrics", promHandler)
adminMux.Handle("/metrics/", promHandler) // preserve HasPrefix semantics
}
if !c.config.DisableSwagger && c.openAPIHandler != nil {
swaggerURL := c.config.SwaggerURL
if !strings.HasPrefix(swaggerURL, "/") {
return nil, fmt.Errorf("invalid SwaggerURL %q: must start with '/'", swaggerURL)
}
if swaggerURL == "/" {
return nil, fmt.Errorf("invalid SwaggerURL %q: must not be '/'", swaggerURL)
}
swaggerPattern := swaggerURL
if !strings.HasSuffix(swaggerPattern, "/") {
swaggerPattern += "/"
adminMux.Handle(swaggerURL, http.RedirectHandler(swaggerPattern, http.StatusPermanentRedirect))
}
adminMux.Handle(swaggerPattern, http.StripPrefix(swaggerPattern, c.openAPIHandler))
}
if c.config.AdminPort > 0 && c.config.AdminPort != c.config.HTTPPort {
// Separate servers: admin endpoints on AdminPort, gateway on HTTPPort.
adminAddr := fmt.Sprintf("%s:%d", c.config.ListenHost, c.config.AdminPort)
c.adminServer = &http.Server{
Addr: adminAddr,
Handler: adminMux,
}
log.Info(ctx, "msg", "Starting admin server", "address", adminAddr)
gwServer := &http.Server{
Addr: gatewayAddr,
Handler: gzipHandler,
}
log.Info(ctx, "msg", "Starting HTTP gateway server", "address", gatewayAddr)
return gwServer, nil
}
// Combined server: admin + gateway on HTTPPort (default behavior).
adminMux.Handle("/", gzipHandler)
gwServer := &http.Server{
Addr: gatewayAddr,
Handler: adminMux,
}
log.Info(ctx, "msg", "Starting HTTP server", "address", gatewayAddr)
return gwServer, nil
}
func (c *cb) runHTTP(ctx context.Context, svr *http.Server) error {
// If the peer server already failed (cancelling gctx), exit cleanly
// so the peer's error is what g.Wait() returns, not context.Canceled.
if ctx.Err() != nil {
return nil
}
return svr.ListenAndServe()
}
// Native stats/opentelemetry options, built during processConfig().
var (
otelGRPCOptionsSet bool // true after processConfig builds or user calls SetOTELOptions
otelGRPCOptions grpcotel.Options // value used by getGRPCServerOptions / initHTTP
otelMeterProvider *sdkmetric.MeterProvider
otelUseLegacy bool // set from config; forces legacy otelgrpc even if SetOTELOptions was called
)
// Legacy otelgrpc options — only used when OTEL_USE_LEGACY_INSTRUMENTATION=true.
var otelGRPCServerOpts = []otelgrpc.Option{
otelgrpc.WithFilter(defaultOTELFilter),
}
var otelGRPCClientOpts = []otelgrpc.Option{
otelgrpc.WithFilter(defaultOTELFilter),
}
func defaultOTELFilter(info *stats.RPCTagInfo) bool {
return interceptors.FilterMethodsFunc(context.Background(), info.FullMethodName)
}
// Deprecated: Use SetOTELOptions instead. Only applies when
// OTEL_USE_LEGACY_INSTRUMENTATION=true.
func SetOTELGRPCServerOptions(opts ...otelgrpc.Option) {
otelGRPCServerOpts = opts
}
// Deprecated: Use SetOTELOptions instead. Only applies when
// OTEL_USE_LEGACY_INSTRUMENTATION=true.
func SetOTELGRPCClientOptions(opts ...otelgrpc.Option) {
otelGRPCClientOpts = opts
}
// SetOTELOptions configures the native gRPC stats/opentelemetry integration.
// Must be called during init, before the gRPC server starts.
// When set, processConfig() will NOT overwrite these with auto-built options.
func SetOTELOptions(opts grpcotel.Options) {
otelGRPCOptions = opts
otelGRPCOptionsSet = true
}
// buildOTELOptions constructs grpcotel.Options from the global TracerProvider
// and TextMapPropagator. If SetupOpenTelemetry was not called, the no-op
// defaults from the OTel SDK are used.
func buildOTELOptions() grpcotel.Options {
opts := grpcotel.Options{
MetricsOptions: grpcotel.MetricsOptions{
MethodAttributeFilter: func(method string) bool {
return interceptors.FilterMethodsFunc(context.Background(), method)
},
},
TraceOptions: experimental.TraceOptions{
TracerProvider: otel.GetTracerProvider(),
TextMapPropagator: otel.GetTextMapPropagator(),
},
}
if otelMeterProvider != nil {
opts.MetricsOptions.MeterProvider = otelMeterProvider
}
return opts
}
func (c *cb) getGRPCServerOptions() []grpc.ServerOption {
so := make([]grpc.ServerOption, 0)
// Use native stats/opentelemetry unless legacy mode is forced via config.
if !otelUseLegacy && otelGRPCOptionsSet {
so = append(so, grpcotel.ServerOption(otelGRPCOptions))
} else {
so = append(so, grpc.StatsHandler(otelgrpc.NewServerHandler(otelGRPCServerOpts...)))
}
so = append(so,
grpc.ChainUnaryInterceptor(interceptors.DefaultInterceptors()...),
grpc.ChainStreamInterceptor(interceptors.DefaultStreamInterceptors()...),
)
// Add message size limits if configured
if c.config.GRPCMaxRecvMsgSize > 0 {
so = append(so, grpc.MaxRecvMsgSize(c.config.GRPCMaxRecvMsgSize))
}
if c.config.GRPCMaxSendMsgSize > 0 {
so = append(so, grpc.MaxSendMsgSize(c.config.GRPCMaxSendMsgSize))
}
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,
) (*fswatcher.Sentinel, credentials.TransportCredentials, error) {
watcher, err := fswatcher.New(certFile, keyFile)
if err != nil {
return nil, nil, err
}
config := &tls.Config{
GetCertificate: watcher.GetCertificate,
ClientAuth: tls.NoClientCert,
InsecureSkipVerify: insecureSkipVerify,
}
return watcher, credentials.NewTLS(config), nil
}
func (c *cb) initGRPC(ctx context.Context) (*grpc.Server, error) {
so := c.getGRPCServerOptions()
if c.config.GRPCTLSCertFile != "" && c.config.GRPCTLSKeyFile != "" {
watcher, creds, err := loadTLSCredentials(
c.config.GRPCTLSCertFile,
c.config.GRPCTLSKeyFile,
c.config.GRPCTLSInsecureSkipVerify,
)
if err != nil {
return nil, err
}
c.creds = creds
c.certWatcher = watcher
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, unixLis net.Listener) error {
// If the peer server already failed (cancelling gctx), exit cleanly
// so the peer's error is what g.Wait() returns, not context.Canceled.
if ctx.Err() != nil {
return nil
}
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)
}
// Start serving on the unix socket in a background goroutine.
if unixLis != nil {
go func() {
if err := svr.Serve(unixLis); err != nil && !errors.Is(err, grpc.ErrServerStopped) {
log.Error(context.Background(), "msg", "unix socket gRPC server error", "err", err)
}
}()
log.Info(ctx, "msg", "gRPC also listening on unix socket", "path", c.unixSocketPath)
}
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
}
// Create unix socket for the gateway before initHTTP so the endpoint is known.
var unixLis net.Listener
if !c.config.DisableUnixGateway {
tmp, tmpErr := os.CreateTemp("", fmt.Sprintf("coldbrew-%d-*.sock", os.Getpid()))
if tmpErr != nil {
log.Warn(ctx, "msg", "failed to allocate unix socket path, falling back to TCP for gateway",
"err", tmpErr)
} else {
socketPath := tmp.Name()
tmp.Close()
os.Remove(socketPath) // remove placeholder so net.Listen can create the socket
unixLis, err = net.Listen("unix", socketPath)
if err != nil {
log.Warn(ctx, "msg", "failed to create unix socket, falling back to TCP for gateway",
"path", socketPath, "err", err)
} else {
c.unixSocketPath = socketPath
c.closers = append(c.closers, closerFunc(func() error {
return os.Remove(socketPath)
}))
log.Info(ctx, "msg", "Unix socket created for gateway", "path", socketPath)
}
}
}
c.httpServer, err = c.initHTTP(ctx)
if err != nil {
// Clean up unix socket listener and file if initHTTP fails.
if unixLis != nil {
unixLis.Close()
}
c.close()
return err
}
g, gctx := errgroup.WithContext(ctx)
g.Go(func() error {
err := c.runGRPC(gctx, c.grpcServer, unixLis)
// Expected shutdown error — don't cancel the group.
if errors.Is(err, grpc.ErrServerStopped) {
return nil
}
return err
})
g.Go(func() error {
err := c.runHTTP(gctx, c.httpServer)
// Expected shutdown error — don't cancel the group.
if errors.Is(err, http.ErrServerClosed) {
return nil
}
return err
})
if c.adminServer != nil {
g.Go(func() error {
err := c.runHTTP(gctx, c.adminServer)
if errors.Is(err, http.ErrServerClosed) {
return nil
}
return err
})
}
if c.certWatcher != nil {
g.Go(func() error {
if err := c.certWatcher.Start(gctx); err != nil {
if errors.Is(err, context.Canceled) {
return nil
}
log.Error(gctx, "msg", "TLS certificate watcher stopped", "err", err)
return err
}
return nil
})
}
// When one server exits with an unexpected error (or parent context is
// cancelled by signal handler), stop the peer so g.Wait() completes.
g.Go(func() error {
<-gctx.Done()
if c.grpcServer != nil {
c.grpcServer.Stop()
}
if c.httpServer != nil {
c.httpServer.Close()
}
if c.adminServer != nil {
c.adminServer.Close()
}
return nil
})
err = g.Wait()
c.gracefulWait.Wait() // if graceful shutdown is in progress wait for it to finish
c.close()
return err
}
// closerFunc adapts a plain function into an io.Closer.
type closerFunc func() error
func (f closerFunc) Close() error { return f() }
func (closerFunc) String() string { return "closerFunc" }
func (c *cb) close() {
for _, closer := range c.closers {
if closer != nil {
log.Info(context.Background(), "closing", closer)
err := closer.Close()
if err != nil {
log.Error(context.Background(), "msg", "Failed to close resource", "err", err, "resource", closer)
}
}
}
}
// 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.adminServer != nil {
if err := c.adminServer.Shutdown(ctx); err != nil {
log.Error(context.Background(), "msg", "admin server shutdown error", "err", err)
}
}
if c.httpServer != nil {
if err := c.httpServer.Shutdown(ctx); err != nil {
log.Error(context.Background(), "msg", "http server shutdown error", "err", err)
}
}
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()
// Log validation warnings after processConfig so the logger is configured
if warnings := impl.config.Validate(); len(warnings) > 0 {
for _, w := range warnings {
log.Warn(context.Background(), "msg", "config validation warning", "warning", w)
}
}
return impl
}