-
Notifications
You must be signed in to change notification settings - Fork 770
/
fx.go
1055 lines (971 loc) · 36.2 KB
/
fx.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
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
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// The MIT License
//
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
//
// Copyright (c) 2020 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package temporal
import (
"context"
"fmt"
"strings"
"time"
"github.com/pborman/uuid"
"go.opentelemetry.io/otel"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/propagation"
otelresource "go.opentelemetry.io/otel/sdk/resource"
otelsdktrace "go.opentelemetry.io/otel/sdk/trace"
semconv "go.opentelemetry.io/otel/semconv/v1.10.0"
"go.opentelemetry.io/otel/trace"
"go.uber.org/fx"
"go.uber.org/fx/fxevent"
"google.golang.org/grpc"
persistencespb "go.temporal.io/server/api/persistence/v1"
"go.temporal.io/server/client"
"go.temporal.io/server/common/authorization"
"go.temporal.io/server/common/cluster"
"go.temporal.io/server/common/collection"
"go.temporal.io/server/common/config"
"go.temporal.io/server/common/dynamicconfig"
"go.temporal.io/server/common/headers"
"go.temporal.io/server/common/log"
"go.temporal.io/server/common/log/tag"
"go.temporal.io/server/common/metrics"
"go.temporal.io/server/common/persistence"
"go.temporal.io/server/common/persistence/cassandra"
persistenceClient "go.temporal.io/server/common/persistence/client"
"go.temporal.io/server/common/persistence/sql"
esclient "go.temporal.io/server/common/persistence/visibility/store/elasticsearch/client"
"go.temporal.io/server/common/pprof"
"go.temporal.io/server/common/primitives"
"go.temporal.io/server/common/resolver"
"go.temporal.io/server/common/resource"
"go.temporal.io/server/common/ringpop"
"go.temporal.io/server/common/rpc/encryption"
"go.temporal.io/server/common/searchattribute"
"go.temporal.io/server/common/telemetry"
"go.temporal.io/server/service/frontend"
"go.temporal.io/server/service/history"
"go.temporal.io/server/service/history/replication"
"go.temporal.io/server/service/history/workflow"
"go.temporal.io/server/service/matching"
"go.temporal.io/server/service/worker"
)
type (
ServiceStopFn func()
ServicesGroupOut struct {
fx.Out
Services *ServicesMetadata `group:"services"`
}
ServicesGroupIn struct {
fx.In
Services []*ServicesMetadata `group:"services"`
}
ServicesMetadata struct {
App *fx.App // Added for info. ServiceStopFn is enough.
ServiceName string
ServiceStopFn ServiceStopFn
}
ServerFx struct {
app *fx.App
}
serverOptionsProvider struct {
fx.Out
ServerOptions *serverOptions
StopChan chan interface{}
Config *config.Config
PProfConfig *config.PProf
LogConfig log.Config
ServiceNames resource.ServiceNames
NamespaceLogger resource.NamespaceLogger
ServiceResolver resolver.ServiceResolver
CustomDataStoreFactory persistenceClient.AbstractDataStoreFactory
SearchAttributesMapper searchattribute.Mapper
CustomInterceptors []grpc.UnaryServerInterceptor
Authorizer authorization.Authorizer
ClaimMapper authorization.ClaimMapper
AudienceGetter authorization.JWTAudienceMapper
// below are things that could be over write by server options or may have default if not supplied by serverOptions.
Logger log.Logger
ClientFactoryProvider client.FactoryProvider
DynamicConfigClient dynamicconfig.Client
DynamicConfigCollection *dynamicconfig.Collection
TLSConfigProvider encryption.TLSConfigProvider
EsConfig *esclient.Config
EsClient esclient.Client
MetricsHandler metrics.MetricsHandler
}
)
func NewServerFx(opts ...ServerOption) (*ServerFx, error) {
app := fx.New(
pprof.Module,
ServerFxImplModule,
fx.Supply(opts),
fx.Provide(ServerOptionsProvider),
TraceExportModule,
fx.Provide(PersistenceFactoryProvider),
fx.Provide(HistoryServiceProvider),
fx.Provide(MatchingServiceProvider),
fx.Provide(FrontendServiceProvider),
fx.Provide(WorkerServiceProvider),
fx.Provide(ApplyClusterMetadataConfigProvider),
fx.Invoke(ServerLifetimeHooks),
FxLogAdapter,
)
s := &ServerFx{
app,
}
return s, app.Err()
}
func ServerOptionsProvider(opts []ServerOption) (serverOptionsProvider, error) {
so := newServerOptions(opts)
err := so.loadAndValidate()
if err != nil {
return serverOptionsProvider{}, err
}
err = verifyPersistenceCompatibleVersion(so.config.Persistence, so.persistenceServiceResolver)
if err != nil {
return serverOptionsProvider{}, err
}
err = ringpop.ValidateRingpopConfig(&so.config.Global.Membership)
if err != nil {
return serverOptionsProvider{}, fmt.Errorf("ringpop config validation error: %w", err)
}
stopChan := make(chan interface{})
// Logger
logger := so.logger
if logger == nil {
logger = log.NewZapLogger(log.BuildZapLogger(so.config.Log))
}
// ClientFactoryProvider
clientFactoryProvider := so.clientFactoryProvider
if clientFactoryProvider == nil {
clientFactoryProvider = client.NewFactoryProvider()
}
// MetricsHandler
metricHandler := so.metricHandler
if metricHandler == nil {
metricHandler = metrics.MetricsHandlerFromConfig(logger, so.config.Global.Metrics)
}
// DynamicConfigClient
dcClient := so.dynamicConfigClient
if dcClient == nil {
dcConfig := so.config.DynamicConfigClient
if dcConfig != nil {
dcClient, err = dynamicconfig.NewFileBasedClient(dcConfig, logger, stopChan)
if err != nil {
return serverOptionsProvider{}, fmt.Errorf("unable to create dynamic config client: %w", err)
}
} else {
// noop client
logger.Info("Dynamic config client is not configured. Using default values.")
dcClient = dynamicconfig.NewNoopClient()
}
}
// TLSConfigProvider
tlsConfigProvider := so.tlsConfigProvider
if tlsConfigProvider == nil {
tlsConfigProvider, err = encryption.NewTLSConfigProviderFromConfig(so.config.Global.TLS, metricHandler, logger, nil)
if err != nil {
return serverOptionsProvider{}, err
}
}
// EsConfig / EsClient
var esConfig *esclient.Config
var esClient esclient.Client
if so.config.Persistence.AdvancedVisibilityConfigExist() {
advancedVisibilityStore, ok := so.config.Persistence.DataStores[so.config.Persistence.AdvancedVisibilityStore]
if !ok {
return serverOptionsProvider{}, fmt.Errorf("persistence config: advanced visibility datastore %q: missing config", so.config.Persistence.AdvancedVisibilityStore)
}
esHttpClient := so.elasticsearchHttpClient
if esHttpClient == nil {
var err error
esHttpClient, err = esclient.NewAwsHttpClient(advancedVisibilityStore.Elasticsearch.AWSRequestSigning)
if err != nil {
return serverOptionsProvider{}, fmt.Errorf("unable to create AWS HTTP client for Elasticsearch: %w", err)
}
}
esConfig = advancedVisibilityStore.Elasticsearch
esClient, err = esclient.NewClient(esConfig, esHttpClient, logger)
if err != nil {
return serverOptionsProvider{}, fmt.Errorf("unable to create Elasticsearch client: %w", err)
}
}
return serverOptionsProvider{
ServerOptions: so,
StopChan: stopChan,
Config: so.config,
PProfConfig: &so.config.Global.PProf,
LogConfig: so.config.Log,
ServiceNames: so.serviceNames,
NamespaceLogger: so.namespaceLogger,
ServiceResolver: so.persistenceServiceResolver,
CustomDataStoreFactory: so.customDataStoreFactory,
SearchAttributesMapper: so.searchAttributesMapper,
CustomInterceptors: so.customInterceptors,
Authorizer: so.authorizer,
ClaimMapper: so.claimMapper,
AudienceGetter: so.audienceGetter,
Logger: logger,
ClientFactoryProvider: clientFactoryProvider,
DynamicConfigClient: dcClient,
DynamicConfigCollection: dynamicconfig.NewCollection(dcClient, logger),
TLSConfigProvider: tlsConfigProvider,
EsConfig: esConfig,
EsClient: esClient,
MetricsHandler: metricHandler,
}, nil
}
func (s ServerFx) Start() error {
return s.app.Start(context.Background())
}
func (s ServerFx) Stop() {
s.app.Stop(context.Background())
}
func StopService(logger log.Logger, app *fx.App, svcName string, stopChan chan struct{}) {
stopCtx, cancelFunc := context.WithTimeout(context.Background(), serviceStopTimeout)
err := app.Stop(stopCtx)
cancelFunc()
if err != nil {
logger.Error("Failed to stop service", tag.Service(svcName), tag.Error(err))
}
// verify "Start" goroutine returned
select {
case <-stopChan:
case <-time.After(time.Minute):
logger.Error("Timed out (1 minute) waiting for service to stop.", tag.Service(svcName))
}
}
type (
ServiceProviderParamsCommon struct {
fx.In
Cfg *config.Config
ServiceNames resource.ServiceNames
Logger log.Logger
NamespaceLogger resource.NamespaceLogger
DynamicConfigClient dynamicconfig.Client
MetricsHandler metrics.MetricsHandler
EsConfig *esclient.Config
EsClient esclient.Client
TlsConfigProvider encryption.TLSConfigProvider
PersistenceConfig config.Persistence
ClusterMetadata *cluster.Config
ClientFactoryProvider client.FactoryProvider
AudienceGetter authorization.JWTAudienceMapper
PersistenceServiceResolver resolver.ServiceResolver
PersistenceFactoryProvider persistenceClient.FactoryProviderFn
SearchAttributesMapper searchattribute.Mapper
CustomInterceptors []grpc.UnaryServerInterceptor
Authorizer authorization.Authorizer
ClaimMapper authorization.ClaimMapper
DataStoreFactory persistenceClient.AbstractDataStoreFactory
SpanExporters []otelsdktrace.SpanExporter
InstanceID resource.InstanceID `optional:"true"`
}
)
func HistoryServiceProvider(
params ServiceProviderParamsCommon,
) (ServicesGroupOut, error) {
serviceName := primitives.HistoryService
if _, ok := params.ServiceNames[serviceName]; !ok {
params.Logger.Info("Service is not requested, skipping initialization.", tag.Service(serviceName))
return ServicesGroupOut{
Services: &ServicesMetadata{
App: fx.New(fx.NopLogger),
ServiceName: serviceName,
ServiceStopFn: func() {},
},
}, nil
}
stopChan := make(chan struct{})
app := fx.New(
fx.Supply(
stopChan,
params.EsConfig,
params.PersistenceConfig,
params.ClusterMetadata,
params.Cfg,
),
fx.Provide(func() persistenceClient.AbstractDataStoreFactory { return params.DataStoreFactory }),
fx.Provide(func() client.FactoryProvider { return params.ClientFactoryProvider }),
fx.Provide(func() authorization.JWTAudienceMapper { return params.AudienceGetter }),
fx.Provide(func() resolver.ServiceResolver { return params.PersistenceServiceResolver }),
fx.Provide(func() searchattribute.Mapper { return params.SearchAttributesMapper }),
fx.Provide(func() []grpc.UnaryServerInterceptor { return params.CustomInterceptors }),
fx.Provide(func() authorization.Authorizer { return params.Authorizer }),
fx.Provide(func() authorization.ClaimMapper { return params.ClaimMapper }),
fx.Provide(func() encryption.TLSConfigProvider { return params.TlsConfigProvider }),
fx.Provide(func() dynamicconfig.Client { return params.DynamicConfigClient }),
fx.Provide(func() resource.ServiceName { return resource.ServiceName(serviceName) }),
fx.Provide(func() log.Logger { return params.Logger }),
fx.Provide(func() metrics.MetricsHandler {
return params.MetricsHandler.WithTags(metrics.ServiceNameTag(serviceName))
}),
fx.Provide(func() esclient.Client { return params.EsClient }),
fx.Provide(params.PersistenceFactoryProvider),
fx.Provide(workflow.NewTaskGeneratorProvider),
fx.Supply(params.SpanExporters),
ServiceTracingModule,
resource.DefaultOptions,
history.QueueModule,
history.Module,
replication.Module,
FxLogAdapter,
)
stopFn := func() { StopService(params.Logger, app, serviceName, stopChan) }
return ServicesGroupOut{
Services: &ServicesMetadata{
App: app,
ServiceName: serviceName,
ServiceStopFn: stopFn,
},
}, app.Err()
}
func MatchingServiceProvider(
params ServiceProviderParamsCommon,
) (ServicesGroupOut, error) {
serviceName := primitives.MatchingService
if _, ok := params.ServiceNames[serviceName]; !ok {
params.Logger.Info("Service is not requested, skipping initialization.", tag.Service(serviceName))
return ServicesGroupOut{
Services: &ServicesMetadata{
App: fx.New(fx.NopLogger),
ServiceName: serviceName,
ServiceStopFn: func() {},
},
}, nil
}
stopChan := make(chan struct{})
app := fx.New(
fx.Supply(
stopChan,
params.EsConfig,
params.PersistenceConfig,
params.ClusterMetadata,
params.Cfg,
),
fx.Provide(func() persistenceClient.AbstractDataStoreFactory { return params.DataStoreFactory }),
fx.Provide(func() client.FactoryProvider { return params.ClientFactoryProvider }),
fx.Provide(func() authorization.JWTAudienceMapper { return params.AudienceGetter }),
fx.Provide(func() resolver.ServiceResolver { return params.PersistenceServiceResolver }),
fx.Provide(func() searchattribute.Mapper { return params.SearchAttributesMapper }),
fx.Provide(func() []grpc.UnaryServerInterceptor { return params.CustomInterceptors }),
fx.Provide(func() authorization.Authorizer { return params.Authorizer }),
fx.Provide(func() authorization.ClaimMapper { return params.ClaimMapper }),
fx.Provide(func() encryption.TLSConfigProvider { return params.TlsConfigProvider }),
fx.Provide(func() dynamicconfig.Client { return params.DynamicConfigClient }),
fx.Provide(func() resource.ServiceName { return resource.ServiceName(serviceName) }),
fx.Provide(func() log.Logger { return params.Logger }),
fx.Provide(func() metrics.MetricsHandler {
return params.MetricsHandler.WithTags(metrics.ServiceNameTag(serviceName))
}),
fx.Provide(func() esclient.Client { return params.EsClient }),
fx.Provide(params.PersistenceFactoryProvider),
fx.Supply(params.SpanExporters),
ServiceTracingModule,
resource.DefaultOptions,
matching.Module,
FxLogAdapter,
)
stopFn := func() { StopService(params.Logger, app, serviceName, stopChan) }
return ServicesGroupOut{
Services: &ServicesMetadata{
App: app,
ServiceName: serviceName,
ServiceStopFn: stopFn,
},
}, app.Err()
}
func FrontendServiceProvider(
params ServiceProviderParamsCommon,
) (ServicesGroupOut, error) {
serviceName := primitives.FrontendService
if _, ok := params.ServiceNames[serviceName]; !ok {
params.Logger.Info("Service is not requested, skipping initialization.", tag.Service(serviceName))
return ServicesGroupOut{
Services: &ServicesMetadata{
App: fx.New(fx.NopLogger),
ServiceName: serviceName,
ServiceStopFn: func() {},
},
}, nil
}
stopChan := make(chan struct{})
app := fx.New(
fx.Supply(
stopChan,
params.EsConfig,
params.PersistenceConfig,
params.ClusterMetadata,
params.Cfg,
),
fx.Provide(func() persistenceClient.AbstractDataStoreFactory { return params.DataStoreFactory }),
fx.Provide(func() client.FactoryProvider { return params.ClientFactoryProvider }),
fx.Provide(func() authorization.JWTAudienceMapper { return params.AudienceGetter }),
fx.Provide(func() resolver.ServiceResolver { return params.PersistenceServiceResolver }),
fx.Provide(func() searchattribute.Mapper { return params.SearchAttributesMapper }),
fx.Provide(func() []grpc.UnaryServerInterceptor { return params.CustomInterceptors }),
fx.Provide(func() authorization.Authorizer { return params.Authorizer }),
fx.Provide(func() authorization.ClaimMapper { return params.ClaimMapper }),
fx.Provide(func() encryption.TLSConfigProvider { return params.TlsConfigProvider }),
fx.Provide(func() dynamicconfig.Client { return params.DynamicConfigClient }),
fx.Provide(func() resource.ServiceName { return resource.ServiceName(serviceName) }),
fx.Provide(func() log.Logger { return params.Logger }),
fx.Provide(func() metrics.MetricsHandler {
return params.MetricsHandler.WithTags(metrics.ServiceNameTag(serviceName))
}),
fx.Provide(func() resource.NamespaceLogger { return params.NamespaceLogger }),
fx.Provide(func() esclient.Client { return params.EsClient }),
fx.Provide(params.PersistenceFactoryProvider),
fx.Supply(params.SpanExporters),
ServiceTracingModule,
resource.DefaultOptions,
frontend.Module,
FxLogAdapter,
)
stopFn := func() { StopService(params.Logger, app, serviceName, stopChan) }
return ServicesGroupOut{
Services: &ServicesMetadata{
App: app,
ServiceName: serviceName,
ServiceStopFn: stopFn,
},
}, app.Err()
}
func WorkerServiceProvider(
params ServiceProviderParamsCommon,
) (ServicesGroupOut, error) {
serviceName := primitives.WorkerService
if _, ok := params.ServiceNames[serviceName]; !ok {
params.Logger.Info("Service is not requested, skipping initialization.", tag.Service(serviceName))
return ServicesGroupOut{
Services: &ServicesMetadata{
App: fx.New(fx.NopLogger),
ServiceName: serviceName,
ServiceStopFn: func() {},
},
}, nil
}
stopChan := make(chan struct{})
app := fx.New(
fx.Supply(
stopChan,
params.EsConfig,
params.PersistenceConfig,
params.ClusterMetadata,
params.Cfg,
),
fx.Provide(func() persistenceClient.AbstractDataStoreFactory { return params.DataStoreFactory }),
fx.Provide(func() client.FactoryProvider { return params.ClientFactoryProvider }),
fx.Provide(func() authorization.JWTAudienceMapper { return params.AudienceGetter }),
fx.Provide(func() resolver.ServiceResolver { return params.PersistenceServiceResolver }),
fx.Provide(func() searchattribute.Mapper { return params.SearchAttributesMapper }),
fx.Provide(func() []grpc.UnaryServerInterceptor { return params.CustomInterceptors }),
fx.Provide(func() authorization.Authorizer { return params.Authorizer }),
fx.Provide(func() authorization.ClaimMapper { return params.ClaimMapper }),
fx.Provide(func() encryption.TLSConfigProvider { return params.TlsConfigProvider }),
fx.Provide(func() dynamicconfig.Client { return params.DynamicConfigClient }),
fx.Provide(func() resource.ServiceName { return resource.ServiceName(serviceName) }),
fx.Provide(func() log.Logger { return params.Logger }),
fx.Provide(func() metrics.MetricsHandler {
return params.MetricsHandler.WithTags(metrics.ServiceNameTag(serviceName))
}),
fx.Provide(func() esclient.Client { return params.EsClient }),
fx.Provide(params.PersistenceFactoryProvider),
fx.Supply(params.SpanExporters),
ServiceTracingModule,
resource.DefaultOptions,
worker.Module,
FxLogAdapter,
)
stopFn := func() { StopService(params.Logger, app, serviceName, stopChan) }
return ServicesGroupOut{
Services: &ServicesMetadata{
App: app,
ServiceName: serviceName,
ServiceStopFn: stopFn,
},
}, app.Err()
}
// ApplyClusterMetadataConfigProvider performs a config check against the configured persistence store for cluster metadata.
// If there is a mismatch, the persisted values take precedence and will be written over in the config objects.
// This is to keep this check hidden from downstream calls.
// TODO: move this to cluster.fx
func ApplyClusterMetadataConfigProvider(
logger log.Logger,
config *config.Config,
persistenceServiceResolver resolver.ServiceResolver,
persistenceFactoryProvider persistenceClient.FactoryProviderFn,
customDataStoreFactory persistenceClient.AbstractDataStoreFactory,
) (*cluster.Config, config.Persistence, error) {
ctx := context.TODO()
logger = log.With(logger, tag.ComponentMetadataInitializer)
clusterName := persistenceClient.ClusterName(config.ClusterMetadata.CurrentClusterName)
dataStoreFactory, _ := persistenceClient.DataStoreFactoryProvider(
clusterName,
persistenceServiceResolver,
&config.Persistence,
customDataStoreFactory,
logger,
nil,
)
factory := persistenceFactoryProvider(persistenceClient.NewFactoryParams{
DataStoreFactory: dataStoreFactory,
Cfg: &config.Persistence,
PersistenceMaxQPS: nil,
PersistenceNamespaceMaxQPS: nil,
EnablePriorityRateLimiting: nil,
ClusterName: persistenceClient.ClusterName(config.ClusterMetadata.CurrentClusterName),
MetricsHandler: nil,
Logger: logger,
})
defer factory.Close()
clusterMetadataManager, err := factory.NewClusterMetadataManager()
if err != nil {
return config.ClusterMetadata, config.Persistence, fmt.Errorf("error initializing cluster metadata manager: %w", err)
}
defer clusterMetadataManager.Close()
clusterData := config.ClusterMetadata
for clusterName, clusterInfo := range clusterData.ClusterInformation {
if clusterName != clusterData.CurrentClusterName {
logger.Warn(
"ClusterInformation in ClusterMetadata config is deprecated. "+
"Please use TCTL admin tool to configure remote cluster connections",
tag.Key("clusterInformation"),
tag.ClusterName(clusterName),
tag.IgnoredValue(clusterInfo))
continue
}
// Only configure current cluster metadata from static config file
clusterId := uuid.New()
applied, err := clusterMetadataManager.SaveClusterMetadata(
ctx,
&persistence.SaveClusterMetadataRequest{
ClusterMetadata: persistencespb.ClusterMetadata{
HistoryShardCount: config.Persistence.NumHistoryShards,
ClusterName: clusterName,
ClusterId: clusterId,
ClusterAddress: clusterInfo.RPCAddress,
FailoverVersionIncrement: clusterData.FailoverVersionIncrement,
InitialFailoverVersion: clusterInfo.InitialFailoverVersion,
IsGlobalNamespaceEnabled: clusterData.EnableGlobalNamespace,
IsConnectionEnabled: clusterInfo.Enabled,
UseClusterIdMembership: true, // Enable this for new cluster after 1.19. This is to prevent two clusters join into one ring.
},
})
if err != nil {
logger.Warn("Failed to save cluster metadata.", tag.Error(err), tag.ClusterName(clusterName))
}
if applied {
logger.Info("Successfully saved cluster metadata.", tag.ClusterName(clusterName))
continue
}
resp, err := clusterMetadataManager.GetClusterMetadata(ctx, &persistence.GetClusterMetadataRequest{
ClusterName: clusterName,
})
if err != nil {
return config.ClusterMetadata, config.Persistence, fmt.Errorf("error while fetching cluster metadata: %w", err)
}
// Allow updating cluster metadata if global namespace is disabled
if !resp.IsGlobalNamespaceEnabled && clusterData.EnableGlobalNamespace {
currentMetadata := resp.ClusterMetadata
currentMetadata.IsGlobalNamespaceEnabled = clusterData.EnableGlobalNamespace
currentMetadata.InitialFailoverVersion = clusterInfo.InitialFailoverVersion
currentMetadata.FailoverVersionIncrement = clusterData.FailoverVersionIncrement
applied, err = clusterMetadataManager.SaveClusterMetadata(
ctx,
&persistence.SaveClusterMetadataRequest{
ClusterMetadata: currentMetadata,
Version: resp.Version,
})
if !applied || err != nil {
return config.ClusterMetadata, config.Persistence, fmt.Errorf("error while updating cluster metadata: %w", err)
}
} else if resp.IsGlobalNamespaceEnabled != clusterData.EnableGlobalNamespace {
logger.Warn(
mismatchLogMessage,
tag.Key("clusterMetadata.EnableGlobalNamespace"),
tag.IgnoredValue(clusterData.EnableGlobalNamespace),
tag.Value(resp.IsGlobalNamespaceEnabled))
config.ClusterMetadata.EnableGlobalNamespace = resp.IsGlobalNamespaceEnabled
}
// Verify current cluster metadata
persistedShardCount := resp.HistoryShardCount
if config.Persistence.NumHistoryShards != persistedShardCount {
logger.Warn(
mismatchLogMessage,
tag.Key("persistence.numHistoryShards"),
tag.IgnoredValue(config.Persistence.NumHistoryShards),
tag.Value(persistedShardCount))
config.Persistence.NumHistoryShards = persistedShardCount
}
if resp.FailoverVersionIncrement != clusterData.FailoverVersionIncrement {
logger.Warn(
mismatchLogMessage,
tag.Key("clusterMetadata.FailoverVersionIncrement"),
tag.IgnoredValue(clusterData.FailoverVersionIncrement),
tag.Value(resp.FailoverVersionIncrement))
config.ClusterMetadata.FailoverVersionIncrement = resp.FailoverVersionIncrement
}
}
err = loadClusterInformationFromStore(ctx, config, clusterMetadataManager, logger)
if err != nil {
return config.ClusterMetadata, config.Persistence, fmt.Errorf("error while loading metadata from cluster: %w", err)
}
return config.ClusterMetadata, config.Persistence, nil
}
func PersistenceFactoryProvider() persistenceClient.FactoryProviderFn {
return persistenceClient.FactoryProvider
}
// TODO: move this to cluster.fx
func loadClusterInformationFromStore(ctx context.Context, config *config.Config, clusterMsg persistence.ClusterMetadataManager, logger log.Logger) error {
iter := collection.NewPagingIterator(func(paginationToken []byte) ([]interface{}, []byte, error) {
request := &persistence.ListClusterMetadataRequest{
PageSize: 100,
NextPageToken: nil,
}
resp, err := clusterMsg.ListClusterMetadata(ctx, request)
if err != nil {
return nil, nil, err
}
var pageItem []interface{}
for _, metadata := range resp.ClusterMetadata {
pageItem = append(pageItem, metadata)
}
return pageItem, resp.NextPageToken, nil
})
for iter.HasNext() {
item, err := iter.Next()
if err != nil {
return err
}
metadata := item.(*persistence.GetClusterMetadataResponse)
newMetadata := cluster.ClusterInformation{
Enabled: metadata.IsConnectionEnabled,
InitialFailoverVersion: metadata.InitialFailoverVersion,
RPCAddress: metadata.ClusterAddress,
}
if staticClusterMetadata, ok := config.ClusterMetadata.ClusterInformation[metadata.ClusterName]; ok {
if metadata.ClusterName != config.ClusterMetadata.CurrentClusterName {
logger.Warn(
"ClusterInformation in ClusterMetadata config is deprecated. Please use TCTL tool to configure remote cluster connections",
tag.Key("clusterInformation"),
tag.IgnoredValue(staticClusterMetadata),
tag.Value(newMetadata))
} else {
newMetadata.RPCAddress = staticClusterMetadata.RPCAddress
logger.Info(fmt.Sprintf("Use rpc address %v for cluster %v.", newMetadata.RPCAddress, metadata.ClusterName))
}
}
config.ClusterMetadata.ClusterInformation[metadata.ClusterName] = newMetadata
}
return nil
}
func ServerLifetimeHooks(
lc fx.Lifecycle,
svr Server,
) {
lc.Append(
fx.Hook{
OnStart: func(context.Context) error {
return svr.Start()
},
OnStop: func(ctx context.Context) error {
svr.Stop()
return nil
},
},
)
}
func verifyPersistenceCompatibleVersion(config config.Persistence, persistenceServiceResolver resolver.ServiceResolver) error {
// cassandra schema version validation
if err := cassandra.VerifyCompatibleVersion(config, persistenceServiceResolver); err != nil {
return fmt.Errorf("cassandra schema version compatibility check failed: %w", err)
}
// sql schema version validation
if err := sql.VerifyCompatibleVersion(config, persistenceServiceResolver); err != nil {
return fmt.Errorf("sql schema version compatibility check failed: %w", err)
}
return nil
}
// TraceExportModule holds process-global telemetry fx state defining the set of
// OTEL trace/span exporters used by tracing instrumentation. The following
// types can be overriden/augmented with fx.Replace/fx.Decorate:
//
// - []go.opentelemetry.io/otel/sdk/trace.SpanExporter
var TraceExportModule = fx.Options(
fx.Invoke(func(log log.Logger) {
otel.SetErrorHandler(otel.ErrorHandlerFunc(
func(err error) {
log.Warn("OTEL error", tag.Error(err), tag.ErrorType(err))
}),
)
}),
fx.Provide(func(lc fx.Lifecycle, c *config.Config) ([]otelsdktrace.SpanExporter, error) {
exporters, err := c.ExporterConfig.SpanExporters()
if err != nil {
return nil, err
}
lc.Append(fx.Hook{
OnStart: startAll(exporters),
OnStop: shutdownAll(exporters),
})
return exporters, nil
}),
)
// ServiceTracingModule holds per-service (i.e. frontend/history/matching/worker) fx
// state. The following types can be overriden with fx.Replace/fx.Decorate:
//
// - []go.opentelemetry.io/otel/sdk/trace.BatchSpanProcessorOption
// default: empty slice
// - []go.opentelemetry.io/otel/sdk/trace.SpanProcessor
// default: wrap each otelsdktrace.SpanExporter with otelsdktrace.NewBatchSpanProcessor
// - *go.opentelemetry.io/otel/sdk/resource.Resource
// default: resource.Default() augmented with the supplied serviceName
// - []go.opentelemetry.io/otel/sdk/trace.TracerProviderOption
// default: the provided resource.Resource and each of the otelsdktrace.SpanExporter
// - go.opentelemetry.io/otel/trace.TracerProvider
// default: otelsdktrace.NewTracerProvider with each of the otelsdktrace.TracerProviderOption
// - go.opentelemetry.io/otel/ppropagation.TextMapPropagator
// default: propagation.TraceContext{}
// - telemetry.ServerTraceInterceptor
// - telemetry.ClientTraceInterceptor
var ServiceTracingModule = fx.Options(
fx.Supply([]otelsdktrace.BatchSpanProcessorOption{}),
fx.Provide(
fx.Annotate(
func(exps []otelsdktrace.SpanExporter, opts []otelsdktrace.BatchSpanProcessorOption) []otelsdktrace.SpanProcessor {
sps := make([]otelsdktrace.SpanProcessor, 0, len(exps))
for _, exp := range exps {
sps = append(sps, otelsdktrace.NewBatchSpanProcessor(exp, opts...))
}
return sps
},
fx.ParamTags(`optional:"true"`, ``),
),
),
fx.Provide(
fx.Annotate(
func(rsn resource.ServiceName, rsi resource.InstanceID) (*otelresource.Resource, error) {
serviceName := string(rsn)
if !strings.HasPrefix(serviceName, "io.temporal.") {
serviceName = fmt.Sprintf("io.temporal.%s", serviceName)
}
attrs := []attribute.KeyValue{
semconv.ServiceNameKey.String(serviceName),
semconv.ServiceVersionKey.String(headers.ServerVersion),
}
if rsi != "" {
attrs = append(attrs, semconv.ServiceInstanceIDKey.String(string(rsi)))
}
return otelresource.New(context.Background(),
otelresource.WithProcess(),
otelresource.WithOS(),
otelresource.WithHost(),
otelresource.WithContainer(),
otelresource.WithAttributes(attrs...),
)
},
fx.ParamTags(``, `optional:"true"`),
),
),
fx.Provide(
func(r *otelresource.Resource, sps []otelsdktrace.SpanProcessor) []otelsdktrace.TracerProviderOption {
opts := make([]otelsdktrace.TracerProviderOption, 0, len(sps)+1)
opts = append(opts, otelsdktrace.WithResource(r))
for _, sp := range sps {
opts = append(opts, otelsdktrace.WithSpanProcessor(sp))
}
return opts
},
),
fx.Provide(func(lc fx.Lifecycle, opts []otelsdktrace.TracerProviderOption) trace.TracerProvider {
tp := otelsdktrace.NewTracerProvider(opts...)
lc.Append(fx.Hook{OnStop: func(ctx context.Context) error {
tp.Shutdown(ctx)
return nil // do not pass this up to fx
}})
return tp
}),
// Haven't had use for baggage propagation yet
fx.Provide(func() propagation.TextMapPropagator { return propagation.TraceContext{} }),
fx.Provide(telemetry.NewServerTraceInterceptor),
fx.Provide(telemetry.NewClientTraceInterceptor),
)
func startAll(exporters []otelsdktrace.SpanExporter) func(ctx context.Context) error {
type starter interface{ Start(context.Context) error }
return func(ctx context.Context) error {
for _, e := range exporters {
if starter, ok := e.(starter); ok {
err := starter.Start(ctx)
if err != nil {
return err
}
}
}
return nil
}
}
func shutdownAll(exporters []otelsdktrace.SpanExporter) func(ctx context.Context) error {
return func(ctx context.Context) error {
for _, e := range exporters {
err := e.Shutdown(ctx)
if err != nil {
return err
}
}
return nil
}
}
var FxLogAdapter = fx.WithLogger(func(logger log.Logger) fxevent.Logger {
return &fxLogAdapter{logger: logger}
})
type fxLogAdapter struct {
logger log.Logger
}
func (l *fxLogAdapter) LogEvent(e fxevent.Event) {
switch e := e.(type) {
case *fxevent.OnStartExecuting:
l.logger.Debug("OnStart hook executing",
tag.ComponentFX,
tag.NewStringTag("callee", e.FunctionName),
tag.NewStringTag("caller", e.CallerName),
)
case *fxevent.OnStartExecuted:
if e.Err != nil {
l.logger.Error("OnStart hook failed",
tag.ComponentFX,
tag.NewStringTag("callee", e.FunctionName),
tag.NewStringTag("caller", e.CallerName),
tag.Error(e.Err),
)
} else {
l.logger.Debug("OnStart hook executed",
tag.ComponentFX,
tag.NewStringTag("callee", e.FunctionName),
tag.NewStringTag("caller", e.CallerName),
tag.NewStringTag("runtime", e.Runtime.String()),
)
}
case *fxevent.OnStopExecuting:
l.logger.Debug("OnStop hook executing",
tag.ComponentFX,
tag.NewStringTag("callee", e.FunctionName),
tag.NewStringTag("caller", e.CallerName),
)
case *fxevent.OnStopExecuted:
if e.Err != nil {
l.logger.Error("OnStop hook failed",
tag.ComponentFX,
tag.NewStringTag("callee", e.FunctionName),
tag.NewStringTag("caller", e.CallerName),
tag.Error(e.Err),
)
} else {
l.logger.Debug("OnStop hook executed",
tag.ComponentFX,
tag.NewStringTag("callee", e.FunctionName),
tag.NewStringTag("caller", e.CallerName),
tag.NewStringTag("runtime", e.Runtime.String()),
)
}
case *fxevent.Supplied:
if e.Err != nil {
l.logger.Error("supplied",
tag.ComponentFX,
tag.NewStringTag("type", e.TypeName),
tag.NewStringTag("module", e.ModuleName),
tag.Error(e.Err))
}
case *fxevent.Provided:
if e.Err != nil {
l.logger.Error("error encountered while applying options",
tag.ComponentFX,
tag.NewStringTag("module", e.ModuleName),
tag.Error(e.Err))
}
case *fxevent.Replaced:
if e.Err != nil {
l.logger.Error("error encountered while replacing",
tag.ComponentFX,
tag.NewStringTag("module", e.ModuleName),
tag.Error(e.Err))
}
case *fxevent.Decorated:
if e.Err != nil {
l.logger.Error("error encountered while applying options",
tag.ComponentFX,