Rename metrics.Handler to avoid name stuttering (#3713)

temporalio · Dec 16, 2022 · 0b4df6a · 0b4df6a
1 parent ea698fa
commit 0b4df6a
Show file tree

Hide file tree

Showing 153 changed files with 577 additions and 575 deletions.
diff --git a/client/admin/metric_client.go b/client/admin/metric_client.go
@@ -41,14 +41,14 @@ var _ adminservice.AdminServiceClient = (*metricClient)(nil)
 
 type metricClient struct {
 	client          adminservice.AdminServiceClient
-	metricsHandler  metrics.MetricsHandler
+	metricsHandler  metrics.Handler
 	throttledLogger log.Logger
 }
 
 // NewMetricClient creates a new instance of adminservice.AdminServiceClient that emits metrics
 func NewMetricClient(
 	client adminservice.AdminServiceClient,
-	metricsHandler metrics.MetricsHandler,
+	metricsHandler metrics.Handler,
 	throttledLogger log.Logger,
 ) adminservice.AdminServiceClient {
 	return &metricClient{
@@ -61,15 +61,15 @@ func NewMetricClient(
 func (c *metricClient) startMetricsRecording(
 	ctx context.Context,
 	operation string,
-) (metrics.MetricsHandler, time.Time) {
+) (metrics.Handler, time.Time) {
 	caller := headers.GetCallerInfo(ctx).CallerName
-	handler := c.metricsHandler.WithTags(metrics.OperationTag(operation), metrics.NamespaceTag(caller), metrics.ServiceRoleTag(metrics.AdminRoleTagValue))
-	handler.Counter(metrics.ClientRequests.GetMetricName()).Record(1)
-	return handler, time.Now().UTC()
+	metricsHandler := c.metricsHandler.WithTags(metrics.OperationTag(operation), metrics.NamespaceTag(caller), metrics.ServiceRoleTag(metrics.AdminRoleTagValue))
+	metricsHandler.Counter(metrics.ClientRequests.GetMetricName()).Record(1)
+	return metricsHandler, time.Now().UTC()
 }
 
 func (c *metricClient) finishMetricsRecording(
-	handler metrics.MetricsHandler,
+	metricsHandler metrics.Handler,
 	startTime time.Time,
 	err error,
 ) {
@@ -86,7 +86,7 @@ func (c *metricClient) finishMetricsRecording(
 		default:
 			c.throttledLogger.Info("admin client encountered error", tag.Error(err), tag.ErrorType(err))
 		}
-		handler.Counter(metrics.ClientFailures.GetMetricName()).Record(1, metrics.ServiceErrorTypeTag(err))
+		metricsHandler.Counter(metrics.ClientFailures.GetMetricName()).Record(1, metrics.ServiceErrorTypeTag(err))
 	}
-	handler.Timer(metrics.ClientLatency.GetMetricName()).Record(time.Since(startTime))
+	metricsHandler.Timer(metrics.ClientLatency.GetMetricName()).Record(time.Since(startTime))
 }
diff --git a/client/clientFactory_mock.go b/client/clientFactory_mock.go
diff --git a/client/clientfactory.go b/client/clientfactory.go
@@ -63,7 +63,7 @@ type (
 		NewFactory(
 			rpcFactory common.RPCFactory,
 			monitor membership.Monitor,
-			metricsHandler metrics.MetricsHandler,
+			metricsHandler metrics.Handler,
 			dc *dynamicconfig.Collection,
 			numberOfHistoryShards int32,
 			logger log.Logger,
@@ -77,7 +77,7 @@ type (
 	rpcClientFactory struct {
 		rpcFactory            common.RPCFactory
 		monitor               membership.Monitor
-		metricsHandler        metrics.MetricsHandler
+		metricsHandler        metrics.Handler
 		dynConfig             *dynamicconfig.Collection
 		numberOfHistoryShards int32
 		logger                log.Logger
@@ -101,7 +101,7 @@ func NewFactoryProvider() FactoryProvider {
 func (p *factoryProviderImpl) NewFactory(
 	rpcFactory common.RPCFactory,
 	monitor membership.Monitor,
-	metricsHandler metrics.MetricsHandler,
+	metricsHandler metrics.Handler,
 	dc *dynamicconfig.Collection,
 	numberOfHistoryShards int32,
 	logger log.Logger,

diff --git a/client/frontend/metric_client.go b/client/frontend/metric_client.go
@@ -41,14 +41,14 @@ var _ workflowservice.WorkflowServiceClient = (*metricClient)(nil)
 
 type metricClient struct {
 	client          workflowservice.WorkflowServiceClient
-	metricsHandler  metrics.MetricsHandler
+	metricsHandler  metrics.Handler
 	throttledLogger log.Logger
 }
 
 // NewMetricClient creates a new instance of workflowservice.WorkflowServiceClient that emits metrics
 func NewMetricClient(
 	client workflowservice.WorkflowServiceClient,
-	metricsHandler metrics.MetricsHandler,
+	metricsHandler metrics.Handler,
 	throttledLogger log.Logger,
 ) workflowservice.WorkflowServiceClient {
 	return &metricClient{
@@ -61,15 +61,15 @@ func NewMetricClient(
 func (c *metricClient) startMetricsRecording(
 	ctx context.Context,
 	operation string,
-) (metrics.MetricsHandler, time.Time) {
+) (metrics.Handler, time.Time) {
 	caller := headers.GetCallerInfo(ctx).CallerName
 	handler := c.metricsHandler.WithTags(metrics.OperationTag(operation), metrics.NamespaceTag(caller), metrics.ServiceRoleTag(metrics.FrontendRoleTagValue))
 	handler.Counter(metrics.ClientRequests.GetMetricName()).Record(1)
 	return handler, time.Now().UTC()
 }
 
 func (c *metricClient) finishMetricsRecording(
-	handler metrics.MetricsHandler,
+	handler metrics.Handler,
 	startTime time.Time,
 	err error,
 ) {

diff --git a/client/history/metric_client.go b/client/history/metric_client.go
@@ -41,15 +41,15 @@ var _ historyservice.HistoryServiceClient = (*metricClient)(nil)
 
 type metricClient struct {
 	client          historyservice.HistoryServiceClient
-	metricsHandler  metrics.MetricsHandler
+	metricsHandler  metrics.Handler
 	logger          log.Logger
 	throttledLogger log.Logger
 }
 
 // NewMetricClient creates a new instance of historyservice.HistoryServiceClient that emits metrics
 func NewMetricClient(
 	client historyservice.HistoryServiceClient,
-	metricsHandler metrics.MetricsHandler,
+	metricsHandler metrics.Handler,
 	logger log.Logger,
 	throttledLogger log.Logger,
 ) historyservice.HistoryServiceClient {
@@ -64,15 +64,15 @@ func NewMetricClient(
 func (c *metricClient) startMetricsRecording(
 	ctx context.Context,
 	operation string,
-) (metrics.MetricsHandler, time.Time) {
+) (metrics.Handler, time.Time) {
 	caller := headers.GetCallerInfo(ctx).CallerName
-	handler := c.metricsHandler.WithTags(metrics.OperationTag(operation), metrics.NamespaceTag(caller), metrics.ServiceRoleTag(metrics.HistoryRoleTagValue))
-	handler.Counter(metrics.ClientRequests.GetMetricName()).Record(1)
-	return handler, time.Now().UTC()
+	metricsHandler := c.metricsHandler.WithTags(metrics.OperationTag(operation), metrics.NamespaceTag(caller), metrics.ServiceRoleTag(metrics.HistoryRoleTagValue))
+	metricsHandler.Counter(metrics.ClientRequests.GetMetricName()).Record(1)
+	return metricsHandler, time.Now().UTC()
 }
 
 func (c *metricClient) finishMetricsRecording(
-	handler metrics.MetricsHandler,
+	metricsHandler metrics.Handler,
 	startTime time.Time,
 	err error,
 ) {
@@ -89,7 +89,7 @@ func (c *metricClient) finishMetricsRecording(
 		default:
 			c.throttledLogger.Info("history client encountered error", tag.Error(err), tag.ErrorType(err))
 		}
-		handler.Counter(metrics.ClientFailures.GetMetricName()).Record(1, metrics.ServiceErrorTypeTag(err))
+		metricsHandler.Counter(metrics.ClientFailures.GetMetricName()).Record(1, metrics.ServiceErrorTypeTag(err))
 	}
-	handler.Timer(metrics.ClientLatency.GetMetricName()).Record(time.Since(startTime))
+	metricsHandler.Timer(metrics.ClientLatency.GetMetricName()).Record(time.Since(startTime))
 }
diff --git a/client/matching/metric_client.go b/client/matching/metric_client.go
@@ -46,15 +46,15 @@ var _ matchingservice.MatchingServiceClient = (*metricClient)(nil)
 
 type metricClient struct {
 	client          matchingservice.MatchingServiceClient
-	metricsHandler  metrics.MetricsHandler
+	metricsHandler  metrics.Handler
 	logger          log.Logger
 	throttledLogger log.Logger
 }
 
 // NewMetricClient creates a new instance of matchingservice.MatchingServiceClient that emits metrics
 func NewMetricClient(
 	client matchingservice.MatchingServiceClient,
-	metricsHandler metrics.MetricsHandler,
+	metricsHandler metrics.Handler,
 	logger log.Logger,
 	throttledLogger log.Logger,
 ) matchingservice.MatchingServiceClient {
@@ -171,7 +171,7 @@ func (c *metricClient) QueryWorkflow(
 }
 
 func (c *metricClient) emitForwardedSourceStats(
-	handler metrics.MetricsHandler,
+	metricsHandler metrics.Handler,
 	forwardedFrom string,
 	taskQueue *taskqueuepb.TaskQueue,
 ) {
@@ -182,26 +182,26 @@ func (c *metricClient) emitForwardedSourceStats(
 	isChildPartition := strings.HasPrefix(taskQueue.GetName(), taskQueuePartitionPrefix)
 	switch {
 	case forwardedFrom != "":
-		handler.Counter(metrics.MatchingClientForwardedCounter.GetMetricName()).Record(1)
+		metricsHandler.Counter(metrics.MatchingClientForwardedCounter.GetMetricName()).Record(1)
 	default:
 		if isChildPartition {
-			handler.Counter(metrics.MatchingClientInvalidTaskQueueName.GetMetricName()).Record(1)
+			metricsHandler.Counter(metrics.MatchingClientInvalidTaskQueueName.GetMetricName()).Record(1)
 		}
 	}
 }
 
 func (c *metricClient) startMetricsRecording(
 	ctx context.Context,
 	operation string,
-) (metrics.MetricsHandler, time.Time) {
+) (metrics.Handler, time.Time) {
 	caller := headers.GetCallerInfo(ctx).CallerName
 	handler := c.metricsHandler.WithTags(metrics.OperationTag(operation), metrics.NamespaceTag(caller), metrics.ServiceRoleTag(metrics.MatchingRoleTagValue))
 	handler.Counter(metrics.ClientRequests.GetMetricName()).Record(1)
 	return handler, time.Now().UTC()
 }
 
 func (c *metricClient) finishMetricsRecording(
-	handler metrics.MetricsHandler,
+	metricsHandler metrics.Handler,
 	startTime time.Time,
 	err error,
 ) {
@@ -218,7 +218,7 @@ func (c *metricClient) finishMetricsRecording(
 		default:
 			c.throttledLogger.Info("matching client encountered error", tag.Error(err), tag.ErrorType(err))
 		}
-		handler.Counter(metrics.ClientFailures.GetMetricName()).Record(1, metrics.ServiceErrorTypeTag(err))
+		metricsHandler.Counter(metrics.ClientFailures.GetMetricName()).Record(1, metrics.ServiceErrorTypeTag(err))
 	}
-	handler.Timer(metrics.ClientLatency.GetMetricName()).Record(time.Since(startTime))
+	metricsHandler.Timer(metrics.ClientLatency.GetMetricName()).Record(time.Since(startTime))
 }
diff --git a/common/archiver/interface.go b/common/archiver/interface.go
@@ -74,7 +74,7 @@ type (
 	HistoryBootstrapContainer struct {
 		ExecutionManager persistence.ExecutionManager
 		Logger           log.Logger
-		MetricsHandler   metrics.MetricsHandler
+		MetricsHandler   metrics.Handler
 		ClusterMetadata  cluster.Metadata
 	}
 
@@ -99,7 +99,7 @@ type (
 	// VisibilityBootstrapContainer contains components needed by all visibility Archiver implementations
 	VisibilityBootstrapContainer struct {
 		Logger          log.Logger
-		MetricsHandler  metrics.MetricsHandler
+		MetricsHandler  metrics.Handler
 		ClusterMetadata cluster.Metadata
 	}
 

diff --git a/common/authorization/interceptor.go b/common/authorization/interceptor.go
@@ -157,7 +157,7 @@ func (a *interceptor) authorize(
 	ctx context.Context,
 	claims *Claims,
 	callTarget *CallTarget,
-	metricsHandler metrics.MetricsHandler) (Result, error) {
+	metricsHandler metrics.Handler) (Result, error) {
 	startTime := time.Now().UTC()
 	defer func() {
 		metricsHandler.Timer(metrics.ServiceAuthorizationLatency.GetMetricName()).Record(time.Since(startTime))
@@ -172,7 +172,7 @@ func (a *interceptor) logAuthError(err error) {
 type interceptor struct {
 	authorizer     Authorizer
 	claimMapper    ClaimMapper
-	metricsHandler metrics.MetricsHandler
+	metricsHandler metrics.Handler
 	logger         log.Logger
 	audienceGetter JWTAudienceMapper
 }
@@ -181,7 +181,7 @@ type interceptor struct {
 func NewAuthorizationInterceptor(
 	claimMapper ClaimMapper,
 	authorizer Authorizer,
-	metricsHandler metrics.MetricsHandler,
+	metricsHandler metrics.Handler,
 	logger log.Logger,
 	audienceGetter JWTAudienceMapper,
 ) grpc.UnaryServerInterceptor {
@@ -198,14 +198,14 @@ func NewAuthorizationInterceptor(
 func (a *interceptor) getMetricsHandler(
 	operation string,
 	namespace string,
-) metrics.MetricsHandler {
-	var handler metrics.MetricsHandler
+) metrics.Handler {
+	var metricsHandler metrics.Handler
 	if namespace != "" {
-		handler = a.metricsHandler.WithTags(metrics.OperationTag(operation), metrics.NamespaceTag(namespace))
+		metricsHandler = a.metricsHandler.WithTags(metrics.OperationTag(operation), metrics.NamespaceTag(namespace))
 	} else {
-		handler = a.metricsHandler.WithTags(metrics.OperationTag(operation), metrics.NamespaceUnknownTag())
+		metricsHandler = a.metricsHandler.WithTags(metrics.OperationTag(operation), metrics.NamespaceUnknownTag())
 	}
-	return handler
+	return metricsHandler
 }
 
 func TLSInfoFormContext(ctx context.Context) *credentials.TLSInfo {

diff --git a/common/authorization/interceptor_test.go b/common/authorization/interceptor_test.go
@@ -61,7 +61,7 @@ type (
 		controller          *gomock.Controller
 		mockFrontendHandler *workflowservicemock.MockWorkflowServiceServer
 		mockAuthorizer      *MockAuthorizer
-		mockMetricsHandler  *metrics.MockMetricsHandler
+		mockMetricsHandler  *metrics.MockHandler
 		interceptor         grpc.UnaryServerInterceptor
 		handler             grpc.UnaryHandler
 		mockClaimMapper     *MockClaimMapper
@@ -79,7 +79,7 @@ func (s *authorizerInterceptorSuite) SetupTest() {
 
 	s.mockFrontendHandler = workflowservicemock.NewMockWorkflowServiceServer(s.controller)
 	s.mockAuthorizer = NewMockAuthorizer(s.controller)
-	s.mockMetricsHandler = metrics.NewMockMetricsHandler(s.controller)
+	s.mockMetricsHandler = metrics.NewMockHandler(s.controller)
 	s.mockMetricsHandler.EXPECT().WithTags(metrics.OperationTag(metrics.AuthorizationScope)).Return(s.mockMetricsHandler)
 	s.mockMetricsHandler.EXPECT().Timer(metrics.ServiceAuthorizationLatency.GetMetricName()).Return(metrics.NoopTimerMetricFunc)
 	s.mockClaimMapper = NewMockClaimMapper(s.controller)

diff --git a/common/deadlock/deadlock.go b/common/deadlock/deadlock.go
@@ -49,7 +49,7 @@ type (
 		Logger         log.SnTaggedLogger
 		Collection     *dynamicconfig.Collection
 		HealthServer   *health.Server
-		MetricsHandler metrics.MetricsHandler
+		MetricsHandler metrics.Handler
 
 		Roots []common.Pingable `group:"deadlockDetectorRoots"`
 	}
@@ -65,7 +65,7 @@ type (
 	deadlockDetector struct {
 		logger         log.Logger
 		healthServer   *health.Server
-		metricsHandler metrics.MetricsHandler
+		metricsHandler metrics.Handler
 		config         config
 		roots          []common.Pingable
 		loops          goro.Group

diff --git a/common/metrics/config.go b/common/metrics/config.go
@@ -448,7 +448,7 @@ func newPrometheusScope(
 }
 
 // MetricsHandlerFromConfig is used at startup to construct a MetricsHandler
-func MetricsHandlerFromConfig(logger log.Logger, c *Config) MetricsHandler {
+func MetricsHandlerFromConfig(logger log.Logger, c *Config) Handler {
 	if c == nil {
 		return NoopMetricsHandler
 	}