[common] metricsfx separation of modules with external tally and without

common/metrics/metricsfx/metricsfx.go

@@ -33,21 +33,36 @@ import (
 )
 
 // Module provides metrics client for fx application.
-var Module = fx.Module("metricfx",
+var Module = fx.Module("metricsfx",
 	fx.Provide(buildClient))
 
+// ModuleForExternalScope provides metrics client for fx application when tally.Scope is created outside.
+var ModuleForExternalScope = fx.Module("metricsfx",
+	fx.Provide(func(params serviceIdxParams) metrics.ServiceIdx {
+		return service.GetMetricsServiceIdx(params.ServiceFullName, params.Logger)
+	}),
+	fx.Provide(buildClientFromTally))
+
 type clientParams struct {
 	fx.In
 
 	Logger          log.Logger
 	ServiceFullName string `name:"service-full-name"`
 	SvcCfg          config.Service
-	Scope           tally.Scope `optional:"true"` // maybe filled outside
 }
 
 func buildClient(params clientParams) metrics.Client {
-	if params.Scope == nil {
-		params.Scope = params.SvcCfg.Metrics.NewScope(params.Logger, params.ServiceFullName)
-	}
-	return metrics.NewClient(params.Scope, service.GetMetricsServiceIdx(params.ServiceFullName, params.Logger))
+	scope := params.SvcCfg.Metrics.NewScope(params.Logger, params.ServiceFullName)
+	return buildClientFromTally(scope, service.GetMetricsServiceIdx(params.ServiceFullName, params.Logger))
+}
+
+type serviceIdxParams struct {
+	fx.In
+
+	Logger          log.Logger
+	ServiceFullName string `name:"service-full-name"`
+}
+
+func buildClientFromTally(scope tally.Scope, serviceID metrics.ServiceIdx) metrics.Client {
+	return metrics.NewClient(scope, serviceID)
 }

common/metrics/metricsfx/metricsfx_test.go

@@ -0,0 +1,40 @@
+package metricsfx
+
+import (
+	"testing"
+
+	"github.com/uber-go/tally"
+	"go.uber.org/fx"
+	"go.uber.org/fx/fxtest"
+
+	"github.com/uber/cadence/common/config"
+	"github.com/uber/cadence/common/log/testlogger"
+	"github.com/uber/cadence/common/metrics"
+	"github.com/uber/cadence/common/service"
+)
+
+func TestModule(t *testing.T) {
+	fxApp := fxtest.New(t,
+		testlogger.Module(t),
+		fx.Provide(fx.Annotated{
+			Target: func() string { return service.Frontend },
+			Name:   "service-full-name"},
+			func() config.Service {
+				return config.Service{}
+			}),
+		Module,
+		fx.Invoke(func(mc metrics.Client) {}))
+	fxApp.RequireStart().RequireStop()
+}
+
+func TestModuleWithExternalScope(t *testing.T) {
+	fxApp := fxtest.New(t,
+		testlogger.Module(t),
+		fx.Provide(func() tally.Scope { return tally.NoopScope },
+			fx.Annotated{
+				Target: func() string { return service.Frontend },
+				Name:   "service-full-name"}),
+		ModuleForExternalScope,
+		fx.Invoke(func(mc metrics.Client) {}))
+	fxApp.RequireStart().RequireStop()
+}