README.md
1# Debugging
2
3Currently, grpc provides two major tools to help user debug issues, which are logging and channelz.
4
5## Logs
6gRPC has put substantial logging instruments on critical paths of gRPC to help users debug issues.
7The [Log Levels](https://github.com/grpc/grpc-go/blob/master/Documentation/log_levels.md) doc describes
8what each log level means in the gRPC context.
9
10To turn on the logs for debugging, run the code with the following environment variable:
11`GRPC_GO_LOG_VERBOSITY_LEVEL=99 GRPC_GO_LOG_SEVERITY_LEVEL=info`.
12
13## Channelz
14We also provide a runtime debugging tool, Channelz, to help users with live debugging.
15
16See the channelz blog post here ([link](https://grpc.io/blog/a_short_introduction_to_channelz)) for
17details about how to use channelz service to debug live program.
18
19## Try it
20The example is able to showcase how logging and channelz can help with debugging. See the channelz
21blog post linked above for full explanation.
22
23```
24go run server/main.go
25```
26
27```
28go run client/main.go
29```
30