go-grpc-channelz: a Go based UI for gRPC's channelz

Project here: https://github.com/rantav/go-grpc-channelz

go-grpc-channelz is an open source project in Go providing observability into gRPC’s current state of connections (channels).

gRPC is a robust and highly scalable RPC system. It abstracts actual socket connections through the channel abstraction. Channels represent load-balanced, possibly auto-discovered remote servers. Gaining visibility into the current state of gRPC channels is priceless. Think netstat for your gRPC server/clien. Channelz is a gRPC spec exposing the inner state of gRPC channels. go-grpc-channelz, written in go, is a pluggable UI which uses the channelz gRPC API to query and display the current state of gRPC connections.

Transcript

1. go-grpc-channelz @rantav Go Community meeting Appsflyer Sept 2019
2. Quick recap • Efficient and robust • Polyglot (12+ languages) • Feature rich • Protobuf extension
3. Connecting to a gRPC server grpc.Dial(“localhost:9999”) grpc.Dial(“x.dns.af.com:9999”) grpc.Dial(“consul://127.0.0.1:8500/my-service”) grpc.Dial(“consul://127.0.0.1:8500/my-service?tag=t&dc=us1”)
4. gRPC Channels Quick intro
5. Source: https://grpc.io/blog/grpc_on_http2/
6. Source: https://grpc.io/blog/grpc_on_http2/
7. Source: https://www.slideshare.net/datawire/bringing-learnings-from-googley-microservices-with-grpc-varun-talwar-google
8. Source: https://www.slideshare.net/datawire/bringing-learnings-from-googley-microservices-with-grpc-varun-talwar-google
9. Source: https://www.slideshare.net/datawire/bringing-learnings-from-googley-microservices-with-grpc-varun-talwar-google
10. Gosh, that’s complicated!
13. But how do you view connectinos?
14. Channelz service // Channelz is a service exposed by gRPC servers that provides detailed debug // information. service Channelz { // Gets all root channels (i.e. channels the application has directly // created). This does not include subchannels nor non-top level channels. rpc GetTopChannels(GetTopChannelsRequest) returns (GetTopChannelsResponse); // Gets all servers that exist in the process. rpc GetServers(GetServersRequest) returns (GetServersResponse); // Returns a single Server, or else a NOT_FOUND code. rpc GetServer(GetServerRequest) returns (GetServerResponse); // Gets all server sockets that exist in the process. rpc GetServerSockets(GetServerSocketsRequest) returns (GetServerSocketsResponse); // Returns a single Channel, or else a NOT_FOUND code. rpc GetChannel(GetChannelRequest) returns (GetChannelResponse); // Returns a single Subchannel, or else a NOT_FOUND code. rpc GetSubchannel(GetSubchannelRequest) returns (GetSubchannelResponse); // Returns a single Socket or else a NOT_FOUND code. rpc GetSocket(GetSocketRequest) returns (GetSocketResponse); }
15. But we want a UI Pretty Please
16. Introducing: go-grpc-channelz
20. github.com/rantav/go-grpc-channelz Open source library
21. Simple integration // Register web handler http.Handle("/", channelz.CreateHandler("/_", grpcBindAddress)) // Activate. channelzservice.RegisterChannelzServiceToServer(grpcServer)
22. DEMO!
23. Code Walkthrough
24. Code walkthrough And (some)design choices HTML Templates Router (chi) Connect to channelz gRPC