forked from milvus-io/milvus
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
enhance: Use stats Handler to record request/response size metrics
Related to milvus-io#36102 This PR use newly added `grpcSizeStatsHandler` to reduce calling `proto.Size` since the request & response size info is recorded by grpc framework. Signed-off-by: Congqi Xia <[email protected]>
- Loading branch information
Showing
3 changed files
with
190 additions
and
35 deletions.
There are no files selected for viewing
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,153 @@ | ||
| // Licensed to the LF AI & Data foundation under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you under the Apache License, Version 2.0 (the | ||
| // "License"); you may not use this file except in compliance | ||
| // with the License. You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package metrics | ||
|
|
||
| import ( | ||
| "context" | ||
| "strconv" | ||
|
|
||
| "google.golang.org/grpc/stats" | ||
|
|
||
| "github.com/milvus-io/milvus/pkg/util/typeutil" | ||
| ) | ||
|
|
||
| // milvusGrpcKey is context key type. | ||
| type milvusGrpcKey struct{} | ||
|
|
||
| // GrpcStats stores the meta and payload size info | ||
| // it should be attached to context so that request sizing could be avoided | ||
| type GrpcStats struct { | ||
| fullMethodName string | ||
| collectionName string | ||
| inboundPayloadSize int | ||
| inboundLabel string | ||
| nodeID int64 | ||
| } | ||
|
|
||
| func (s *GrpcStats) SetCollectionName(collName string) *GrpcStats { | ||
| if s == nil { | ||
| return s | ||
| } | ||
| s.collectionName = collName | ||
| return s | ||
| } | ||
|
|
||
| func (s *GrpcStats) SetInboundLabel(label string) *GrpcStats { | ||
| if s == nil { | ||
| return s | ||
| } | ||
| s.inboundLabel = label | ||
| return s | ||
| } | ||
|
|
||
| func (s *GrpcStats) SetNodeID(nodeID int64) *GrpcStats { | ||
| if s == nil { | ||
| return s | ||
| } | ||
| s.nodeID = nodeID | ||
| return s | ||
| } | ||
|
|
||
| func attachStats(ctx context.Context, stats *GrpcStats) context.Context { | ||
| return context.WithValue(ctx, milvusGrpcKey{}, stats) | ||
| } | ||
|
|
||
| func GetStats(ctx context.Context) *GrpcStats { | ||
| stats, ok := ctx.Value(milvusGrpcKey{}).(*GrpcStats) | ||
| if !ok { | ||
| return nil | ||
| } | ||
|
|
||
| return stats | ||
| } | ||
|
|
||
| // grpcSizeStatsHandler implementing stats.Handler | ||
| // this handler process grpc request & response related metrics logic | ||
| type grpcSizeStatsHandler struct { | ||
| outboundMethods typeutil.Set[string] | ||
| targetMethods typeutil.Set[string] | ||
| } | ||
|
|
||
| func NewGRPCSizeStatsHandler() *grpcSizeStatsHandler { | ||
| return &grpcSizeStatsHandler{ | ||
| targetMethods: make(typeutil.Set[string]), | ||
| outboundMethods: make(typeutil.Set[string]), | ||
| } | ||
| } | ||
|
|
||
| func (h *grpcSizeStatsHandler) isTarget(method string) bool { | ||
| return h.targetMethods.Contain(method) | ||
| } | ||
|
|
||
| func (h *grpcSizeStatsHandler) shouldRecordOutbound(method string) bool { | ||
| return h.outboundMethods.Contain(method) | ||
| } | ||
|
|
||
| func (h *grpcSizeStatsHandler) WithTargetMethods(methods ...string) *grpcSizeStatsHandler { | ||
| h.targetMethods.Insert(methods...) | ||
| h.outboundMethods.Insert(methods...) | ||
| return h | ||
| } | ||
|
|
||
| func (h *grpcSizeStatsHandler) WithInboundRecord(methods ...string) *grpcSizeStatsHandler { | ||
| h.targetMethods.Insert(methods...) | ||
| return h | ||
| } | ||
|
|
||
| // TagConn exists to satisfy gRPC stats.Handler interface. | ||
| func (h *grpcSizeStatsHandler) TagConn(ctx context.Context, _ *stats.ConnTagInfo) context.Context { | ||
| return ctx | ||
| } | ||
|
|
||
| // HandleConn exists to satisfy gRPC stats.Handler interface. | ||
| func (h *grpcSizeStatsHandler) HandleConn(_ context.Context, _ stats.ConnStats) {} | ||
|
|
||
| func (h *grpcSizeStatsHandler) TagRPC(ctx context.Context, info *stats.RPCTagInfo) context.Context { | ||
| // if method is not target, just return origin ctx | ||
| if !h.isTarget(info.FullMethodName) { | ||
| return ctx | ||
| } | ||
| // attach stats | ||
| return attachStats(ctx, &GrpcStats{fullMethodName: info.FullMethodName}) | ||
| } | ||
|
|
||
| // HandleRPC implements per-RPC stats instrumentation. | ||
| func (h *grpcSizeStatsHandler) HandleRPC(ctx context.Context, rs stats.RPCStats) { | ||
| mstats := GetStats(ctx) | ||
| // if no stats found, do nothing | ||
| if mstats == nil { | ||
| return | ||
| } | ||
|
|
||
| switch rs := rs.(type) { | ||
| case *stats.InPayload: | ||
| // store inbound payload size in stats, collection name could be fetch in service after | ||
| mstats.inboundPayloadSize = rs.Length | ||
| case *stats.OutPayload: | ||
| // all info set | ||
| // set metrics with inbound size and related meta | ||
| nodeIDValue := strconv.FormatInt(mstats.nodeID, 10) | ||
| ProxyReceiveBytes.WithLabelValues( | ||
| nodeIDValue, | ||
| mstats.inboundLabel, mstats.collectionName).Add(float64(mstats.inboundPayloadSize)) | ||
| // set outbound payload size metrics for marked methods | ||
| if h.shouldRecordOutbound(mstats.fullMethodName) { | ||
| ProxyReadReqSendBytes.WithLabelValues(nodeIDValue).Add(float64(rs.Length)) | ||
| } | ||
| default: | ||
| } | ||
| } |