Skip to content

Commit 0b4df6a

Browse files
mindaugasrukasmindaugasrukas
authored
Rename metrics.Handler to avoid name stuttering (#3713)
1 parent ea698fa commit 0b4df6a

File tree

153 files changed

+577
-575
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

153 files changed

+577
-575
lines changed

‎client/admin/metric_client.go

+9-9
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,14 @@ var _ adminservice.AdminServiceClient = (*metricClient)(nil)
4141

4242
type metricClient struct {
4343
client adminservice.AdminServiceClient
44-
metricsHandler metrics.MetricsHandler
44+
metricsHandler metrics.Handler
4545
throttledLogger log.Logger
4646
}
4747

4848
// NewMetricClient creates a new instance of adminservice.AdminServiceClient that emits metrics
4949
func NewMetricClient(
5050
client adminservice.AdminServiceClient,
51-
metricsHandler metrics.MetricsHandler,
51+
metricsHandler metrics.Handler,
5252
throttledLogger log.Logger,
5353
) adminservice.AdminServiceClient {
5454
return &metricClient{
@@ -61,15 +61,15 @@ func NewMetricClient(
6161
func (c *metricClient) startMetricsRecording(
6262
ctx context.Context,
6363
operation string,
64-
) (metrics.MetricsHandler, time.Time) {
64+
) (metrics.Handler, time.Time) {
6565
caller := headers.GetCallerInfo(ctx).CallerName
66-
handler := c.metricsHandler.WithTags(metrics.OperationTag(operation), metrics.NamespaceTag(caller), metrics.ServiceRoleTag(metrics.AdminRoleTagValue))
67-
handler.Counter(metrics.ClientRequests.GetMetricName()).Record(1)
68-
return handler, time.Now().UTC()
66+
metricsHandler := c.metricsHandler.WithTags(metrics.OperationTag(operation), metrics.NamespaceTag(caller), metrics.ServiceRoleTag(metrics.AdminRoleTagValue))
67+
metricsHandler.Counter(metrics.ClientRequests.GetMetricName()).Record(1)
68+
return metricsHandler, time.Now().UTC()
6969
}
7070

7171
func (c *metricClient) finishMetricsRecording(
72-
handler metrics.MetricsHandler,
72+
metricsHandler metrics.Handler,
7373
startTime time.Time,
7474
err error,
7575
) {
@@ -86,7 +86,7 @@ func (c *metricClient) finishMetricsRecording(
8686
default:
8787
c.throttledLogger.Info("admin client encountered error", tag.Error(err), tag.ErrorType(err))
8888
}
89-
handler.Counter(metrics.ClientFailures.GetMetricName()).Record(1, metrics.ServiceErrorTypeTag(err))
89+
metricsHandler.Counter(metrics.ClientFailures.GetMetricName()).Record(1, metrics.ServiceErrorTypeTag(err))
9090
}
91-
handler.Timer(metrics.ClientLatency.GetMetricName()).Record(time.Since(startTime))
91+
metricsHandler.Timer(metrics.ClientLatency.GetMetricName()).Record(time.Since(startTime))
9292
}

‎client/clientFactory_mock.go

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎client/clientfactory.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ type (
6363
NewFactory(
6464
rpcFactory common.RPCFactory,
6565
monitor membership.Monitor,
66-
metricsHandler metrics.MetricsHandler,
66+
metricsHandler metrics.Handler,
6767
dc *dynamicconfig.Collection,
6868
numberOfHistoryShards int32,
6969
logger log.Logger,
@@ -77,7 +77,7 @@ type (
7777
rpcClientFactory struct {
7878
rpcFactory common.RPCFactory
7979
monitor membership.Monitor
80-
metricsHandler metrics.MetricsHandler
80+
metricsHandler metrics.Handler
8181
dynConfig *dynamicconfig.Collection
8282
numberOfHistoryShards int32
8383
logger log.Logger
@@ -101,7 +101,7 @@ func NewFactoryProvider() FactoryProvider {
101101
func (p *factoryProviderImpl) NewFactory(
102102
rpcFactory common.RPCFactory,
103103
monitor membership.Monitor,
104-
metricsHandler metrics.MetricsHandler,
104+
metricsHandler metrics.Handler,
105105
dc *dynamicconfig.Collection,
106106
numberOfHistoryShards int32,
107107
logger log.Logger,

‎client/frontend/metric_client.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,14 @@ var _ workflowservice.WorkflowServiceClient = (*metricClient)(nil)
4141

4242
type metricClient struct {
4343
client workflowservice.WorkflowServiceClient
44-
metricsHandler metrics.MetricsHandler
44+
metricsHandler metrics.Handler
4545
throttledLogger log.Logger
4646
}
4747

4848
// NewMetricClient creates a new instance of workflowservice.WorkflowServiceClient that emits metrics
4949
func NewMetricClient(
5050
client workflowservice.WorkflowServiceClient,
51-
metricsHandler metrics.MetricsHandler,
51+
metricsHandler metrics.Handler,
5252
throttledLogger log.Logger,
5353
) workflowservice.WorkflowServiceClient {
5454
return &metricClient{
@@ -61,15 +61,15 @@ func NewMetricClient(
6161
func (c *metricClient) startMetricsRecording(
6262
ctx context.Context,
6363
operation string,
64-
) (metrics.MetricsHandler, time.Time) {
64+
) (metrics.Handler, time.Time) {
6565
caller := headers.GetCallerInfo(ctx).CallerName
6666
handler := c.metricsHandler.WithTags(metrics.OperationTag(operation), metrics.NamespaceTag(caller), metrics.ServiceRoleTag(metrics.FrontendRoleTagValue))
6767
handler.Counter(metrics.ClientRequests.GetMetricName()).Record(1)
6868
return handler, time.Now().UTC()
6969
}
7070

7171
func (c *metricClient) finishMetricsRecording(
72-
handler metrics.MetricsHandler,
72+
handler metrics.Handler,
7373
startTime time.Time,
7474
err error,
7575
) {

‎client/history/metric_client.go

+9-9
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,15 @@ var _ historyservice.HistoryServiceClient = (*metricClient)(nil)
4141

4242
type metricClient struct {
4343
client historyservice.HistoryServiceClient
44-
metricsHandler metrics.MetricsHandler
44+
metricsHandler metrics.Handler
4545
logger log.Logger
4646
throttledLogger log.Logger
4747
}
4848

4949
// NewMetricClient creates a new instance of historyservice.HistoryServiceClient that emits metrics
5050
func NewMetricClient(
5151
client historyservice.HistoryServiceClient,
52-
metricsHandler metrics.MetricsHandler,
52+
metricsHandler metrics.Handler,
5353
logger log.Logger,
5454
throttledLogger log.Logger,
5555
) historyservice.HistoryServiceClient {
@@ -64,15 +64,15 @@ func NewMetricClient(
6464
func (c *metricClient) startMetricsRecording(
6565
ctx context.Context,
6666
operation string,
67-
) (metrics.MetricsHandler, time.Time) {
67+
) (metrics.Handler, time.Time) {
6868
caller := headers.GetCallerInfo(ctx).CallerName
69-
handler := c.metricsHandler.WithTags(metrics.OperationTag(operation), metrics.NamespaceTag(caller), metrics.ServiceRoleTag(metrics.HistoryRoleTagValue))
70-
handler.Counter(metrics.ClientRequests.GetMetricName()).Record(1)
71-
return handler, time.Now().UTC()
69+
metricsHandler := c.metricsHandler.WithTags(metrics.OperationTag(operation), metrics.NamespaceTag(caller), metrics.ServiceRoleTag(metrics.HistoryRoleTagValue))
70+
metricsHandler.Counter(metrics.ClientRequests.GetMetricName()).Record(1)
71+
return metricsHandler, time.Now().UTC()
7272
}
7373

7474
func (c *metricClient) finishMetricsRecording(
75-
handler metrics.MetricsHandler,
75+
metricsHandler metrics.Handler,
7676
startTime time.Time,
7777
err error,
7878
) {
@@ -89,7 +89,7 @@ func (c *metricClient) finishMetricsRecording(
8989
default:
9090
c.throttledLogger.Info("history client encountered error", tag.Error(err), tag.ErrorType(err))
9191
}
92-
handler.Counter(metrics.ClientFailures.GetMetricName()).Record(1, metrics.ServiceErrorTypeTag(err))
92+
metricsHandler.Counter(metrics.ClientFailures.GetMetricName()).Record(1, metrics.ServiceErrorTypeTag(err))
9393
}
94-
handler.Timer(metrics.ClientLatency.GetMetricName()).Record(time.Since(startTime))
94+
metricsHandler.Timer(metrics.ClientLatency.GetMetricName()).Record(time.Since(startTime))
9595
}

‎client/matching/metric_client.go

+9-9
Original file line numberDiff line numberDiff line change
@@ -46,15 +46,15 @@ var _ matchingservice.MatchingServiceClient = (*metricClient)(nil)
4646

4747
type metricClient struct {
4848
client matchingservice.MatchingServiceClient
49-
metricsHandler metrics.MetricsHandler
49+
metricsHandler metrics.Handler
5050
logger log.Logger
5151
throttledLogger log.Logger
5252
}
5353

5454
// NewMetricClient creates a new instance of matchingservice.MatchingServiceClient that emits metrics
5555
func NewMetricClient(
5656
client matchingservice.MatchingServiceClient,
57-
metricsHandler metrics.MetricsHandler,
57+
metricsHandler metrics.Handler,
5858
logger log.Logger,
5959
throttledLogger log.Logger,
6060
) matchingservice.MatchingServiceClient {
@@ -171,7 +171,7 @@ func (c *metricClient) QueryWorkflow(
171171
}
172172

173173
func (c *metricClient) emitForwardedSourceStats(
174-
handler metrics.MetricsHandler,
174+
metricsHandler metrics.Handler,
175175
forwardedFrom string,
176176
taskQueue *taskqueuepb.TaskQueue,
177177
) {
@@ -182,26 +182,26 @@ func (c *metricClient) emitForwardedSourceStats(
182182
isChildPartition := strings.HasPrefix(taskQueue.GetName(), taskQueuePartitionPrefix)
183183
switch {
184184
case forwardedFrom != "":
185-
handler.Counter(metrics.MatchingClientForwardedCounter.GetMetricName()).Record(1)
185+
metricsHandler.Counter(metrics.MatchingClientForwardedCounter.GetMetricName()).Record(1)
186186
default:
187187
if isChildPartition {
188-
handler.Counter(metrics.MatchingClientInvalidTaskQueueName.GetMetricName()).Record(1)
188+
metricsHandler.Counter(metrics.MatchingClientInvalidTaskQueueName.GetMetricName()).Record(1)
189189
}
190190
}
191191
}
192192

193193
func (c *metricClient) startMetricsRecording(
194194
ctx context.Context,
195195
operation string,
196-
) (metrics.MetricsHandler, time.Time) {
196+
) (metrics.Handler, time.Time) {
197197
caller := headers.GetCallerInfo(ctx).CallerName
198198
handler := c.metricsHandler.WithTags(metrics.OperationTag(operation), metrics.NamespaceTag(caller), metrics.ServiceRoleTag(metrics.MatchingRoleTagValue))
199199
handler.Counter(metrics.ClientRequests.GetMetricName()).Record(1)
200200
return handler, time.Now().UTC()
201201
}
202202

203203
func (c *metricClient) finishMetricsRecording(
204-
handler metrics.MetricsHandler,
204+
metricsHandler metrics.Handler,
205205
startTime time.Time,
206206
err error,
207207
) {
@@ -218,7 +218,7 @@ func (c *metricClient) finishMetricsRecording(
218218
default:
219219
c.throttledLogger.Info("matching client encountered error", tag.Error(err), tag.ErrorType(err))
220220
}
221-
handler.Counter(metrics.ClientFailures.GetMetricName()).Record(1, metrics.ServiceErrorTypeTag(err))
221+
metricsHandler.Counter(metrics.ClientFailures.GetMetricName()).Record(1, metrics.ServiceErrorTypeTag(err))
222222
}
223-
handler.Timer(metrics.ClientLatency.GetMetricName()).Record(time.Since(startTime))
223+
metricsHandler.Timer(metrics.ClientLatency.GetMetricName()).Record(time.Since(startTime))
224224
}

‎common/archiver/interface.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ type (
7474
HistoryBootstrapContainer struct {
7575
ExecutionManager persistence.ExecutionManager
7676
Logger log.Logger
77-
MetricsHandler metrics.MetricsHandler
77+
MetricsHandler metrics.Handler
7878
ClusterMetadata cluster.Metadata
7979
}
8080

@@ -99,7 +99,7 @@ type (
9999
// VisibilityBootstrapContainer contains components needed by all visibility Archiver implementations
100100
VisibilityBootstrapContainer struct {
101101
Logger log.Logger
102-
MetricsHandler metrics.MetricsHandler
102+
MetricsHandler metrics.Handler
103103
ClusterMetadata cluster.Metadata
104104
}
105105

‎common/authorization/interceptor.go

+8-8
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ func (a *interceptor) authorize(
157157
ctx context.Context,
158158
claims *Claims,
159159
callTarget *CallTarget,
160-
metricsHandler metrics.MetricsHandler) (Result, error) {
160+
metricsHandler metrics.Handler) (Result, error) {
161161
startTime := time.Now().UTC()
162162
defer func() {
163163
metricsHandler.Timer(metrics.ServiceAuthorizationLatency.GetMetricName()).Record(time.Since(startTime))
@@ -172,7 +172,7 @@ func (a *interceptor) logAuthError(err error) {
172172
type interceptor struct {
173173
authorizer Authorizer
174174
claimMapper ClaimMapper
175-
metricsHandler metrics.MetricsHandler
175+
metricsHandler metrics.Handler
176176
logger log.Logger
177177
audienceGetter JWTAudienceMapper
178178
}
@@ -181,7 +181,7 @@ type interceptor struct {
181181
func NewAuthorizationInterceptor(
182182
claimMapper ClaimMapper,
183183
authorizer Authorizer,
184-
metricsHandler metrics.MetricsHandler,
184+
metricsHandler metrics.Handler,
185185
logger log.Logger,
186186
audienceGetter JWTAudienceMapper,
187187
) grpc.UnaryServerInterceptor {
@@ -198,14 +198,14 @@ func NewAuthorizationInterceptor(
198198
func (a *interceptor) getMetricsHandler(
199199
operation string,
200200
namespace string,
201-
) metrics.MetricsHandler {
202-
var handler metrics.MetricsHandler
201+
) metrics.Handler {
202+
var metricsHandler metrics.Handler
203203
if namespace != "" {
204-
handler = a.metricsHandler.WithTags(metrics.OperationTag(operation), metrics.NamespaceTag(namespace))
204+
metricsHandler = a.metricsHandler.WithTags(metrics.OperationTag(operation), metrics.NamespaceTag(namespace))
205205
} else {
206-
handler = a.metricsHandler.WithTags(metrics.OperationTag(operation), metrics.NamespaceUnknownTag())
206+
metricsHandler = a.metricsHandler.WithTags(metrics.OperationTag(operation), metrics.NamespaceUnknownTag())
207207
}
208-
return handler
208+
return metricsHandler
209209
}
210210

211211
func TLSInfoFormContext(ctx context.Context) *credentials.TLSInfo {

‎common/authorization/interceptor_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ type (
6161
controller *gomock.Controller
6262
mockFrontendHandler *workflowservicemock.MockWorkflowServiceServer
6363
mockAuthorizer *MockAuthorizer
64-
mockMetricsHandler *metrics.MockMetricsHandler
64+
mockMetricsHandler *metrics.MockHandler
6565
interceptor grpc.UnaryServerInterceptor
6666
handler grpc.UnaryHandler
6767
mockClaimMapper *MockClaimMapper
@@ -79,7 +79,7 @@ func (s *authorizerInterceptorSuite) SetupTest() {
7979

8080
s.mockFrontendHandler = workflowservicemock.NewMockWorkflowServiceServer(s.controller)
8181
s.mockAuthorizer = NewMockAuthorizer(s.controller)
82-
s.mockMetricsHandler = metrics.NewMockMetricsHandler(s.controller)
82+
s.mockMetricsHandler = metrics.NewMockHandler(s.controller)
8383
s.mockMetricsHandler.EXPECT().WithTags(metrics.OperationTag(metrics.AuthorizationScope)).Return(s.mockMetricsHandler)
8484
s.mockMetricsHandler.EXPECT().Timer(metrics.ServiceAuthorizationLatency.GetMetricName()).Return(metrics.NoopTimerMetricFunc)
8585
s.mockClaimMapper = NewMockClaimMapper(s.controller)

‎common/deadlock/deadlock.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ type (
4949
Logger log.SnTaggedLogger
5050
Collection *dynamicconfig.Collection
5151
HealthServer *health.Server
52-
MetricsHandler metrics.MetricsHandler
52+
MetricsHandler metrics.Handler
5353

5454
Roots []common.Pingable `group:"deadlockDetectorRoots"`
5555
}
@@ -65,7 +65,7 @@ type (
6565
deadlockDetector struct {
6666
logger log.Logger
6767
healthServer *health.Server
68-
metricsHandler metrics.MetricsHandler
68+
metricsHandler metrics.Handler
6969
config config
7070
roots []common.Pingable
7171
loops goro.Group

‎common/metrics/config.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -448,7 +448,7 @@ func newPrometheusScope(
448448
}
449449

450450
// MetricsHandlerFromConfig is used at startup to construct a MetricsHandler
451-
func MetricsHandlerFromConfig(logger log.Logger, c *Config) MetricsHandler {
451+
func MetricsHandlerFromConfig(logger log.Logger, c *Config) Handler {
452452
if c == nil {
453453
return NoopMetricsHandler
454454
}

0 commit comments

Comments
 (0)