• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!---
2Automatically generated by tools/codegen/core/gen_trace_flags.py
3--->
4
5gRPC Trace Flags
6----------------
7
8The `GRPC_TRACE` environment variable supports a comma-separated list of tracer
9names or glob patterns that provide additional insight into how gRPC C core is
10processing requests via debug logs. Available tracers include:
11
12% for flag, settings in trace_flags.items():
13% if "internal" in settings and settings["internal"]:
14<% continue %>
15% endif
16% if "debug_only" not in settings or not settings["debug_only"]:
17% if settings["description"]:
18  - ${flag} - ${settings["description"]}
19% else:
20  - ${flag}
21% endif
22% endif
23% endfor
24
25The following tracers will only run in binaries built in DEBUG mode. This is
26accomplished by invoking `bazel build --config=dbg <target>`
27% for flag, settings in trace_flags.items():
28% if "internal" in settings and settings["internal"]:
29<% continue %>
30% endif
31% if "debug_only" in settings and settings["debug_only"]:
32% if settings["description"]:
33  - ${flag} - ${settings["description"]}
34% else:
35  - ${flag}
36% endif
37% endif
38% endfor
39
40Glob patterns and special cases:
41  - `*` can be used to turn all traces on.
42  - Individual traces can be disabled by prefixing them with `-`.
43  - `*refcount*` will turn on all of the tracers for refcount debugging.
44  - if `list_tracers` is present, then all of the available tracers will be
45    printed when the program starts up.
46
47Example:
48export GRPC_TRACE=*,-pending_tags
49