grpc-go的stats/HandleRPC如何获取payload信息为RPC指标打标签

*stats.End事件本身不携带任何请求/响应payload内容，gRPC不会把消息体保留到RPC结束阶段，想拿payload里的字段做标签，必须在RPC生命周期的payload收发节点提前提取需要的字段，通过同链路context缓存，到End阶段再取出拼标签上报，这是官方设计下唯一无兼容问题、性能最优的方案，没有其他捷径。

实现逻辑 #

• 自定义私有context key，定义轻量的标签缓存结构，只存你需要的标签字段，绝对不要存整个payload对象，避免内存泄漏。
• 实现StatsHandler的TagRPC方法：每个RPC调用初始化时，给当前链路的context注入空的标签缓存结构，同一条RPC的所有stats事件回调都会共享这个context。
• 在HandleRPC回调里新增对*stats.InPayload、*stats.OutPayload两类事件的处理：这两个事件触发时，事件参数里的Payload字段就是当前正在收发的消息体，在这里直接做类型断言、提取你需要的标签值，写入context里的缓存结构。
• 等到*stats.End事件触发时，直接从context里取出之前缓存好的所有标签值，和计算好的RPC耗时拼接，完成指标上报即可。

完整参考代码 #

import (
	"context"
	"google.golang.org/grpc/stats"
)

// 自定义RPC监控标签结构，仅存需要的字段，不存完整payload
type rpcMonitorTags struct {
	RequestBizKey string // 示例：请求中需要提取的特定业务键
	ResponseIsNil bool   // 示例：响应是否为空
}

// 私有context key，避免和其他中间件的context键冲突
type rpcTagsCtxKey struct{}

type myStatsHandler struct{}

// TagRPC 每个RPC初始化时触发，用来给链路注入自定义存储
func (h *myStatsHandler) TagRPC(ctx context.Context, _ *stats.RPCTagInfo) context.Context {
	return context.WithValue(ctx, rpcTagsCtxKey{}, &rpcMonitorTags{})
}

// TagConn 连接层标签逻辑不需要的话直接返回原ctx即可
func (h *myStatsHandler) TagConn(ctx context.Context, _ *stats.ConnTagInfo) context.Context {
	return ctx
}

func (h *myStatsHandler) HandleRPC(ctx context.Context, rpcStats stats.RPCStats) {
	switch stat := rpcStats.(type) {
	// 处理入站消息：服务端收请求、客户端收响应时触发
	case *stats.InPayload:
		tags, ok := ctx.Value(rpcTagsCtxKey{}).(*rpcMonitorTags)
		if !ok {
			return
		}
		// 服务端场景下此处stat.Payload为客户端发来的请求，替换为你实际的proto生成请求类型
		if req, ok := stat.Payload.(*YourRequestProtoType); ok {
			tags.RequestBizKey = req.GetBizKey() // 提取需要的字段
		}

	// 处理出站消息：服务端发响应、客户端发请求时触发
	case *stats.OutPayload:
		tags, ok := ctx.Value(rpcTagsCtxKey{}).(*rpcMonitorTags)
		if !ok {
			return
		}
		// 服务端场景下此处stat.Payload为返回给客户端的响应
		if stat.Payload == nil {
			tags.ResponseIsNil = true
			return
		}
		// 有需要可以在这里提取响应里的其他字段

	// RPC结束，上报耗时指标
	case *stats.End:
		tags, ok := ctx.Value(rpcTagsCtxKey{}).(*rpcMonitorTags)
		if !ok {
			tags = &rpcMonitorTags{} // 兜底避免空指针
		}
		durationMs := stat.EndTime.Sub(stat.BeginTime).Seconds() * 1000.0
		// 替换成你实际用的监控上报逻辑，标签用提前缓存好的字段即可
		// 示例：rpcDurationMetric.WithLabelValues(tags.RequestBizKey, strconv.FormatBool(tags.ResponseIsNil)).Observe(durationMs)
	}
}

// HandleConn 连接层事件不需要的话留空即可
func (h *myStatsHandler) HandleConn(_ context.Context, _ stats.ConnStats) {}

注意事项 #

• 绝对不要在context里缓存完整的请求/响应对象：大体积payload会长期驻留内存，大幅拉高GC压力，只提取必要的标量类型标签值即可。
• 注意区分客户端和服务端的payload方向：服务端侧入站是请求、出站是响应；客户端侧出站是请求、入站是响应，不要写反类型断言逻辑。
• 所有类型断言必须校验ok状态，同时做好nil判断，避免异常消息导致服务panic。
• 不要尝试通过gRPC内部的stream结构体回查payload：内部结构没有对外兼容性承诺，版本升级很容易失效。

内容的提问来源于stack exchange，提问作者svakili