diff options
author | dvshkurko <dvshkurko@yandex-team.ru> | 2022-02-10 16:45:52 +0300 |
---|---|---|
committer | Daniil Cherednik <dcherednik@yandex-team.ru> | 2022-02-10 16:45:52 +0300 |
commit | c768a99151e47c3a4bb7b92c514d256abd301c4d (patch) | |
tree | 1a2c5ffcf89eb53ecd79dbc9bc0a195c27404d0c /contrib/libs/grpc/TROUBLESHOOTING.md | |
parent | 321ee9bce31ec6e238be26dbcbe539cffa2c3309 (diff) | |
download | ydb-c768a99151e47c3a4bb7b92c514d256abd301c4d.tar.gz |
Restoring authorship annotation for <dvshkurko@yandex-team.ru>. Commit 2 of 2.
Diffstat (limited to 'contrib/libs/grpc/TROUBLESHOOTING.md')
-rw-r--r-- | contrib/libs/grpc/TROUBLESHOOTING.md | 84 |
1 files changed, 42 insertions, 42 deletions
diff --git a/contrib/libs/grpc/TROUBLESHOOTING.md b/contrib/libs/grpc/TROUBLESHOOTING.md index 68aed92175..035213b9e1 100644 --- a/contrib/libs/grpc/TROUBLESHOOTING.md +++ b/contrib/libs/grpc/TROUBLESHOOTING.md @@ -1,43 +1,43 @@ -# Troubleshooting gRPC - -This guide is for troubleshooting gRPC implementations based on C core library (sources for most of them are living in the `grpc/grpc` repository). - -## Enabling extra logging and tracing - -Extra logging can be very useful for diagnosing problems. All gRPC implementations based on C core library support -the `GRPC_VERBOSITY` and `GRPC_TRACE` environment variables that can be used to increase the amount of information -that gets printed to stderr. - -## GRPC_VERBOSITY - -`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. - -## GRPC_TRACE - -`GRPC_TRACE` can be used to enable extra logging for some internal gRPC components. Enabling the right traces can be invaluable -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). +# Troubleshooting gRPC + +This guide is for troubleshooting gRPC implementations based on C core library (sources for most of them are living in the `grpc/grpc` repository). + +## Enabling extra logging and tracing + +Extra logging can be very useful for diagnosing problems. All gRPC implementations based on C core library support +the `GRPC_VERBOSITY` and `GRPC_TRACE` environment variables that can be used to increase the amount of information +that gets printed to stderr. + +## GRPC_VERBOSITY + +`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. + +## GRPC_TRACE + +`GRPC_TRACE` can be used to enable extra logging for some internal gRPC components. Enabling the right traces can be invaluable +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). Multiple traces can be enabled at once (use comma as separator). - -``` -# Enable debug logs for an application -GRPC_VERBOSITY=debug ./helloworld_application_using_grpc -``` - -``` -# Print information about invocations of low-level C core API. -# Note that trace logs of log level DEBUG won't be displayed. -# Also note that most tracers user log level INFO, so without setting -# GPRC_VERBOSITY accordingly, no traces will be printed. -GRPC_VERBOSITY=info GRPC_TRACE=api ./helloworld_application_using_grpc -``` - -``` -# Print info from 3 different tracers, including tracing logs with log level DEBUG -GRPC_VERBOSITY=debug GRPC_TRACE=tcp,http,api ./helloworld_application_using_grpc -``` - -Known limitations: `GPRC_TRACE=tcp` is currently not implemented for Windows (you won't see any tcp traces). - -Please note that the `GRPC_TRACE` environment variable has nothing to do with gRPC's "tracing" feature (= tracing RPCs in -microservice environment to gain insight about how requests are processed by deployment), it is merely used to enable printing -of extra logs. + +``` +# Enable debug logs for an application +GRPC_VERBOSITY=debug ./helloworld_application_using_grpc +``` + +``` +# Print information about invocations of low-level C core API. +# Note that trace logs of log level DEBUG won't be displayed. +# Also note that most tracers user log level INFO, so without setting +# GPRC_VERBOSITY accordingly, no traces will be printed. +GRPC_VERBOSITY=info GRPC_TRACE=api ./helloworld_application_using_grpc +``` + +``` +# Print info from 3 different tracers, including tracing logs with log level DEBUG +GRPC_VERBOSITY=debug GRPC_TRACE=tcp,http,api ./helloworld_application_using_grpc +``` + +Known limitations: `GPRC_TRACE=tcp` is currently not implemented for Windows (you won't see any tcp traces). + +Please note that the `GRPC_TRACE` environment variable has nothing to do with gRPC's "tracing" feature (= tracing RPCs in +microservice environment to gain insight about how requests are processed by deployment), it is merely used to enable printing +of extra logs. |