This tool is a proof of concept, but feedback is welcome.
gRPC provides debug stats in the form of an RPC service. For example,
is a service that provides channel level debug information. This repo
contains a tool that connects to a remote gRPC
channelz service and
displays the data as a web page using a local
golang web server.
The goal is to provide a single CLI tool that can display all gRPC
The tool has three components:
- Your web browser.
- An Envoy proxy to translate gRPC web requests and fetch static assets.
When your web browser first hits the Envoy port, the proxy looks at the content type and determines that it is not a gRPC-web request. As a result, it routes the request to the static assets web server and your web browser loads the Angular webapp.
When the web app needs channelz data, it will make gRPC-web requests to the Envoy port. Envoy uses the content type to detect these requests to translate and route them to the gRPC host.
For more info look at:
Running the tool
This example shows how to connect the tool to a gRPC service runnning
127.0.0.1:50051. The envoy proxy listens on port
# Make sure 'docker-compose' and 'docker' are both available $ cd docker $ ./start_docker.sh 9900 127.0.0.1 50051
Compile instructions for the web app
npm is required to be on your
PATH. This code has been verified to
work with version
If this is your first time building the app:
cd web/channelzui/ npm install
To rebuild and copy the distributable files:
# Pull the latest proto definitions from # https://github.com/grpc/grpc-proto $ buildscripts/channelz_codegen.sh # Rebuild the angular app $ buildscripts/update_angular.sh