Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add metrics propagation across services and no user-induced latency
metric
- Loading branch information
Showing
25 changed files
with
1,259 additions
and
47 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,156 @@ | ||
| // 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 metrics | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| metricspb "go.temporal.io/server/api/metrics/v1" | ||
| "go.temporal.io/server/common/log" | ||
| "go.temporal.io/server/common/log/tag" | ||
|
|
||
| "google.golang.org/grpc" | ||
| "google.golang.org/grpc/metadata" | ||
| ) | ||
|
|
||
| type baggageContextKey struct{} | ||
|
|
||
| var ( | ||
| // "-bin" suffix is a reserved in gRPC that signals that metadata string value is actually a byte data | ||
| // If trailer key has such a suffix, value will be base64 encoded. | ||
| baggageTrailerKey = "metrics-baggage-bin" | ||
| baggageCtxKey = baggageContextKey{} | ||
| ) | ||
|
|
||
| // NewServerMetricsContextInjectorInterceptor returns grpc server interceptor that adds metrics context to golang | ||
| // context. | ||
| func NewServerMetricsContextInjectorInterceptor() grpc.UnaryServerInterceptor { | ||
| return func( | ||
| ctx context.Context, | ||
| req interface{}, | ||
| info *grpc.UnaryServerInfo, | ||
| handler grpc.UnaryHandler, | ||
| ) (interface{}, error) { | ||
| ctxWithMetricsBaggage := AddMetricsBaggageToContext(ctx) | ||
| return handler(ctxWithMetricsBaggage, req) | ||
| } | ||
| } | ||
|
|
||
| // NewClientMetricsTrailerPropagatorInterceptor returns grpc client interceptor that injects metrics received in trailer | ||
| // into metrics context. | ||
| func NewClientMetricsTrailerPropagatorInterceptor(logger log.Logger) grpc.UnaryClientInterceptor { | ||
| return func( | ||
| ctx context.Context, method string, req, reply interface{}, cc *grpc.ClientConn, invoker grpc.UnaryInvoker, | ||
| opts ...grpc.CallOption, | ||
| ) error { | ||
| var trailer metadata.MD | ||
| optsWithTrailer := append(opts, grpc.Trailer(&trailer)) | ||
| err := invoker(ctx, method, req, reply, cc, optsWithTrailer...) | ||
|
|
||
| baggageStrings := trailer.Get(baggageTrailerKey) | ||
| if len(baggageStrings) == 0 { | ||
| return err | ||
| } | ||
|
|
||
| for _, baggageString := range baggageStrings { | ||
| baggageBytes := []byte(baggageString) | ||
| metricsBaggage := &metricspb.Baggage{} | ||
| unmarshalErr := metricsBaggage.Unmarshal(baggageBytes) | ||
| if unmarshalErr != nil { | ||
| logger.Error("unable to unmarshal metrics baggage from trailer", tag.Error(unmarshalErr)) | ||
| continue | ||
| } | ||
| for counterName, counterValue := range metricsBaggage.CountersInt { | ||
| ContextCounterAdd(ctx, counterName, counterValue) | ||
| } | ||
| } | ||
|
|
||
| return err | ||
| } | ||
| } | ||
|
|
||
| // NewServerMetricsTrailerPropagatorInterceptor returns grpc server interceptor that injects metrics from context into | ||
| // gRPC trailer. | ||
| func NewServerMetricsTrailerPropagatorInterceptor(logger log.Logger) grpc.UnaryServerInterceptor { | ||
| return func( | ||
| ctx context.Context, | ||
| req interface{}, | ||
| info *grpc.UnaryServerInfo, | ||
| handler grpc.UnaryHandler, | ||
| ) (interface{}, error) { | ||
| // we want to return original handler response, so don't override err | ||
| resp, err := handler(ctx, req) | ||
|
|
||
| baggage := GetMetricsBaggageFromContext(ctx) | ||
| if baggage == nil { | ||
| return resp, err | ||
| } | ||
|
|
||
| bytes, marshalErr := baggage.Marshal() | ||
| if marshalErr != nil { | ||
| logger.Error("unable to marshal metric baggage", tag.Error(marshalErr)) | ||
| } | ||
|
|
||
| md := metadata.Pairs(baggageTrailerKey, string(bytes)) | ||
| marshalErr = grpc.SetTrailer(ctx, md) | ||
| if marshalErr != nil { | ||
| logger.Error("unable to add metrics baggage to gRPC trailer", tag.Error(marshalErr)) | ||
| } | ||
|
|
||
| return resp, err | ||
| } | ||
| } | ||
|
|
||
| // GetMetricsBaggageFromContext extracts metrics context from golang context. | ||
| func GetMetricsBaggageFromContext(ctx context.Context) *metricspb.Baggage { | ||
| metricsBaggage := ctx.Value(baggageCtxKey) | ||
| if metricsBaggage == nil { | ||
| return nil | ||
| } | ||
|
|
||
| return metricsBaggage.(*metricspb.Baggage) | ||
| } | ||
|
|
||
| func AddMetricsBaggageToContext(ctx context.Context) context.Context { | ||
| metricsBaggage := &metricspb.Baggage{} | ||
| return context.WithValue(ctx, baggageCtxKey, metricsBaggage) | ||
| } | ||
|
|
||
| // ContextCounterAdd adds value to counter within metrics context. | ||
| func ContextCounterAdd(ctx context.Context, name string, value int64) { | ||
| metricsBaggage := GetMetricsBaggageFromContext(ctx) | ||
|
|
||
| if metricsBaggage == nil { | ||
| return | ||
| } | ||
|
|
||
| if metricsBaggage.CountersInt == nil { | ||
| metricsBaggage.CountersInt = make(map[string]int64) | ||
| } | ||
|
|
||
| metricValue, _ := metricsBaggage.CountersInt[name] | ||
| metricValue += value | ||
| metricsBaggage.CountersInt[name] = metricValue | ||
| } |
Oops, something went wrong.