channelz: recommend using admin.Register instead (#4797)

grpc · Sep 23, 2021 · 6ff68b4 · 6ff68b4
1 parent 78d3aa8
commit 6ff68b4
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/admin/admin.go b/admin/admin.go
@@ -20,6 +20,7 @@
 // administration services to a gRPC server. The services registered are:
 //
 // - Channelz: https://github.com/grpc/proposal/blob/master/A14-channelz.md
+//
 // - CSDS: https://github.com/grpc/proposal/blob/master/A40-csds-support.md
 //
 // Experimental

diff --git a/channelz/service/service.go b/channelz/service/service.go
@@ -43,6 +43,10 @@ func init() {
 var logger = grpclog.Component("channelz")
 
 // RegisterChannelzServiceToServer registers the channelz service to the given server.
+//
+// Note: it is preferred to use the admin API
+// (https://pkg.go.dev/google.golang.org/grpc/admin#Register) instead to
+// register Channelz and other administrative services.
 func RegisterChannelzServiceToServer(s grpc.ServiceRegistrar) {
 	channelzgrpc.RegisterChannelzServer(s, newCZServer())
 }