如何在Java中使用gRPC Channelz排查通道、套接字及服务端问题

旧版io.grpc.services.ChannelzService标记废弃后，grpc-java已将Channelz能力迁移到独立的grpc-channelz组件中，最新使用方式如下：

1. 引入依赖 #

确保依赖版本与项目中其他gRPC组件版本完全一致，避免兼容性问题：

• Maven依赖配置：

<dependency>
    <groupId>io.grpc</groupId>
    <artifactId>grpc-channelz</artifactId>
    <version>你的项目gRPC统一版本号</version>
</dependency>

• Gradle依赖配置：

implementation 'io.grpc:grpc-channelz:你的项目gRPC统一版本号'

2. 注册Channelz服务 #

将Channelz服务实例注册到gRPC服务端中即可开启能力：

import io.grpc.Server;
import io.grpc.ServerBuilder;
import io.grpc.channelz.v1.ChannelzService;

// 构建服务端时注册Channelz服务
Server server = ServerBuilder.forPort(9090)
    // 注册业务服务
    .addService(new YourBusinessServiceImpl())
    // 注册Channelz服务，参数为单次查询返回的最大资源条目数，可自定义
    .addService(ChannelzService.newInstance(100))
    .build()
    .start();

如果需要排查客户端侧的Channel、Subchannel、Socket信息，可以在客户端进程内启动一个仅用于管理查询的轻量化gRPC服务端，注册ChannelzService后通过管理端口查询即可。

3. 查询数据排查问题 #

可以通过grpcurl等gRPC命令行工具直接调用Channelz接口获取排查数据：

• 查询所有顶层Channel信息：grpcurl -plaintext 127.0.0.1:9090 grpc.channelz.v1.Channelz/GetTopChannels
• 查询所有服务端信息：grpcurl -plaintext 127.0.0.1:9090 grpc.channelz.v1.Channelz/GetServers
• 查询指定Socket详情：grpcurl -plaintext -d '{"socket_id": 目标SocketID}' 127.0.0.1:9090 grpc.channelz.v1.Channelz/GetSocket

返回结果中包含连接状态、请求成功/失败计数、延迟分布、上下行流量、socket地址、TLS状态等核心信息，可覆盖Channel连接异常、连接泄漏、服务端监听异常、网络请求报错等常见场景的排查需求。也可以在代码中集成Channelz客户端，拿到结构化数据后自行实现可视化、监控告警等拓展能力。

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