Skip to content

Commit 4eb44f3

Browse files
authored
Address review comments.
1 parent 1901045 commit 4eb44f3

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

TROUBLESHOOTING.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ that gets printed to stderr.
1010

1111
## GRPC_VERBOSITY
1212

13-
`GRPC_VERBOSITY` is used to set the minimum level of log messages printed by gRPC (supported values are `DEBUG`, `INFO` and `ERROR`).
13+
`GRPC_VERBOSITY` is used to set the minimum level of log messages printed by gRPC (supported values are `DEBUG`, `INFO` and `ERROR`). If this environment variable is unset, only `ERROR` logs will be printed.
1414

1515
## GRPC_TRACE
1616

1717
`GRPC_TRACE` can be used to enable extra logging for some internal gRPC components. Enabling the right traces can be invaluable
18-
for diagnosing for what is going wrong when things aren't working as intended. Possible values for GRPC_TRACE are listed in [Environment Variables Overview](doc/environment_variables.md).
18+
for diagnosing for what is going wrong when things aren't working as intended. Possible values for `GRPC_TRACE` are listed in [Environment Variables Overview](doc/environment_variables.md).
1919
Multiple traces can be enable at once (use comma as separator).
2020

2121
```
@@ -24,10 +24,11 @@ GRPC_VERBOSITY=debug ./helloworld_application_using_grpc
2424
```
2525

2626
```
27-
# Print info about invocations of low-level C core API.
28-
# Note that trace logs of log level DEBUG won't be displayed
29-
# as GRPC_VERBOSITY and GRPC_TRACE are 2 independent settings.
30-
GRPC_TRACE=api ./helloworld_application_using_grpc
27+
# Print information about invocations of low-level C core API.
28+
# Note that trace logs of log level DEBUG won't be displayed.
29+
# Also note that most tracers user log level INFO, so without setting
30+
# GPRC_VERBOSITY accordingly, no traces will be printed.
31+
GRPC_VERBOSITY=info GRPC_TRACE=api ./helloworld_application_using_grpc
3132
```
3233

3334
```
@@ -37,6 +38,6 @@ GRPC_VERBOSITY=debug GRPC_TRACE=tcp,http,api ./helloworld_application_using_grpc
3738

3839
Known limitations: `GPRC_TRACE=tcp` is currently not implemented for Windows (you won't see any tcp traces).
3940

40-
Please note that the GRPC_TRACE environment variable has nothing to do with gRPC's "tracing" feature (= tracing RPCs in
41+
Please note that the `GRPC_TRACE` environment variable has nothing to do with gRPC's "tracing" feature (= tracing RPCs in
4142
microservice environment to gain insight about how requests are processed by deployment), it is merely used to enable printing
4243
of extra logs.

0 commit comments

Comments
 (0)