• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Copyright 2024 gRPC authors.
2#
3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6#
7#     http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14#
15# File format:
16# Each config var must have a name, a default, and a description.
17# Optionally:
18#  *  a `debug_only: true` flag can be added to ensure that this flag is only
19#     enabled in debug builds.
20#  *  an `internal: true` flag can be added to ensure that this flag does not
21#     show up in the environment_variables.md documentations.
22
23api:
24  default: false
25  description: API calls to the C core.
26apple_polling:
27  default: false
28  description: (legacy) Apple polling trace.
29  internal: true
30auth_context_refcount:
31  debug_only: true
32  default: false
33  description: Auth context refcounting.
34backend_metric:
35  default: false
36  description: C++ backend metric recorder APIs.
37backend_metric_filter:
38  default: false
39  description: Filter that populates backend metric data in server trailing metadata.
40bdp_estimator:
41  default: false
42  description: Behavior of bdp estimation logic.
43call:
44  default: false
45  description: Traces operations on a call through the gRPC stack.
46call_combiner:
47  debug_only: true
48  default: false
49  description: Call combiner state.
50call_error:
51  default: false
52  description: Possible errors contributing to final call statuses.
53call_refcount:
54  debug_only: true
55  default: false
56  description: Refcount on call.
57call_state:
58  debug_only: true
59  default: false
60  description: Traces transitions through the call spine state machine.
61cares_address_sorting:
62  default: false
63  description: Operations of the c-ares based DNS resolver's address sorter.
64cares_resolver:
65  default: false
66  description: Operations of the c-ares based DNS resolver.
67cds_lb:
68  default: false
69  description: CDS LB policy.
70channel:
71  default: false
72  description: Operations on the C core channel stack.
73channel_stack:
74  default: false
75  description: Construction of the set of filters in a channel stack.
76chaotic_good:
77  default: false
78  description: Chaotic good transport.
79chttp2_hpack_parser:
80  default: false
81  description: HTTP/2 HPACK parser.
82chttp2_new_stream:
83  default: false
84  description: HTTP/2 incoming stream creation.
85client_channel:
86  default: false
87  description: Client channel control plane activity, including resolver and load balancing policy interaction.
88client_channel_call:
89  default: false
90  description: Client channel call activity related to name resolution.
91client_channel_lb_call:
92  default: false
93  description: Client channel call activity related to load balancing picking.
94client_idle_filter:
95  default: false
96  description: Client idleness filter.
97closure:
98  debug_only: true
99  default: false
100  description: Legacy closure creation, scheduling, and completion.
101combiner:
102  debug_only: true
103  default: false
104  description: Combiner lock state.
105compression:
106  default: false
107  description: Compression operations.
108connectivity_state:
109  default: false
110  description: Connectivity state changes to channels.
111cq_refcount:
112  debug_only: true
113  default: false
114  description: Completion queue refcounting.
115cronet:
116  default: false
117  description: Cronet transport engine.
118dns_resolver:
119  default: false
120  description: The active DNS resolver.
121environment_autodetect:
122  default: false
123  description: GCP environment auto-detection.
124error_refcount:
125  debug_only: true
126  default: false
127  description: Error refcounting.
128event_engine:
129  default: false
130  description: High-level EventEngine operations.
131event_engine_client_channel_resolver:
132  default: false
133  description: EventEngine-based client channel resolver state and events.
134event_engine_dns:
135  default: false
136  description: EventEngine DNS resolver.
137event_engine_endpoint:
138  default: false
139  description: EventEngine Endpoint operations.
140event_engine_endpoint_data:
141  default: false
142  description: Detailed dump of EventEngine endpoint TCP data.
143event_engine_poller:
144  default: false
145  description: EventEngine Poller events.
146executor:
147  default: false
148  description: gRPC's legacy thread pool ('the executor').
149fault_injection_filter:
150  default: false
151  description: Fault injection.
152fd_refcount:
153  debug_only: true
154  default: false
155  description: File descriptor refcounting.
156fd_trace:
157  debug_only: true
158  default: false
159  description: Legacy file descriptor create(), shutdown() and close() calls for channel fds.
160flowctl:
161  default: false
162  description: Http2 flow control.
163fork:
164  default: false
165  description: Fork support.
166fuzzing_ee_timers:
167  default: false
168  description: Fuzzing EventEngine timers.
169  internal: true
170fuzzing_ee_writes:
171  default: false
172  description: Fuzzing EventEngine writes.
173  internal: true
174glb:
175  default: false
176  description: gRPClb load balancer.
177grpc_authz_api:
178  default: false
179  description: gRPC authorization.
180handshaker:
181  default: false
182  description: Handshaking state.
183health_check_client:
184  default: false
185  description: Health checking client code.
186http:
187  default: false
188  description: Http2 transport engine.
189http1:
190  default: false
191  description: HTTP/1.x operations performed by gRPC.
192http2_ping:
193  default: false
194  description: Pings/ping acks/antagonist writes in http2 stack.
195http2_stream_state:
196  default: false
197  description: Http2 stream state mutations.
198http_keepalive:
199  default: false
200  description: gRPC keepalive pings.
201inproc:
202  default: false
203  description: In-process transport.
204lb_policy_refcount:
205  debug_only: true
206  default: false
207  description: LB policy refcounting.
208metadata_query:
209  default: false
210  description: GCP metadata queries.
211op_failure:
212  default: false
213  description: Error information when failure is pushed onto a completion queue. The `api` tracer must be enabled for this flag to have any effect.
214orca_client:
215  default: false
216  description: Out-of-band backend metric reporting client.
217outlier_detection_lb:
218  default: false
219  description: Outlier detection.
220party_state:
221  debug_only: true
222  default: false
223  description: Coordination of activities related to a call.
224pending_tags:
225  debug_only: true
226  default: false
227  description: Still-in-progress tags on completion queues. The `api` tracer must be enabled for this flag to have any effect.
228ph2:
229  debug_only: true
230  default: false
231  description: Promise Based HTTP2 transport.
232pick_first:
233  default: false
234  description: Pick first load balancing policy.
235plugin_credentials:
236  default: false
237  description: Plugin credentials.
238polling:
239  debug_only: true
240  default: false
241  description: The active polling engine.
242polling_api:
243  debug_only: true
244  default: false
245  description: API calls to polling engine.
246priority_lb:
247  default: false
248  description: Priority LB policy.
249promise_primitives:
250  debug_only: true
251  default: false
252  description: Low-level primitives in the promise library.
253queue_pluck:
254  default: false
255  description: Completion queue plucking. The `api` tracer must be enabled for this flag to have any effect.
256resolver_refcount:
257  debug_only: true
258  default: false
259  description: Resolver refcouting.
260resource_quota:
261  default: false
262  description: Resource quota objects internals.
263retry:
264  default: false
265  description: Call retries.
266ring_hash_lb:
267  default: false
268  description: Ring hash load balancing policy.
269rls_lb:
270  default: false
271  description: RLS load balancing policy.
272round_robin:
273  default: false
274  description: Round robin load balancing policy.
275secure_endpoint:
276  default: false
277  description: Bytes flowing through encrypted channels.
278security_connector_refcount:
279  debug_only: true
280  default: false
281  description: Refcounting for security connectors (part of channel credentials).
282server_channel:
283  default: false
284  description: Lightweight trace of significant server channel events.
285slice_refcount:
286  debug_only: true
287  default: false
288  description: Slice refcounting.
289stateful_session_filter:
290  default: false
291  description: Stateful session affinity.
292stream_refcount:
293  debug_only: true
294  default: false
295  description: Stream refcounting.
296subchannel:
297  default: false
298  description: Connectivity state of subchannels.
299subchannel_pool:
300  default: false
301  description: Subchannel pool.
302subchannel_refcount:
303  debug_only: true
304  default: false
305  description: Subchannel refcounting.
306tcp:
307  default: false
308  description: Bytes in and out of a channel.
309timer:
310  default: false
311  description: Timers (alarms) in the grpc internals.
312timer_check:
313  default: false
314  description: more detailed trace of timer logic in grpc internals.
315token_fetcher_credentials:
316  default: false
317  description: Token fetcher call credentials framework, used for (e.g.) oauth2 token fetcher credentials.
318tsi:
319  default: false
320  description: TSI transport security.
321weighted_round_robin_lb:
322  default: false
323  description: Weighted round robin load balancing policy.
324weighted_target_lb:
325  default: false
326  description: Weighted target LB policy.
327work_serializer:
328  debug_only: true
329  default: false
330  description: A synchronization mechanism used to ensure that only one thread is executing at a given time.
331xds_client:
332  default: false
333  description: XDS client.
334xds_client_refcount:
335  default: false
336  description: Refcount of XDS client.
337xds_cluster_impl_lb:
338  default: false
339  description: XDS Cluster impl LB policy.
340xds_cluster_manager_lb:
341  default: false
342  description: XDS Cluster manager LB policy.
343xds_override_host_lb:
344  default: false
345  description: XDS Override host LB.
346xds_resolver:
347  default: false
348  description: XDS Resolver.
349xds_server_config_fetcher:
350  default: false
351  description: XDS Server config fetcher.
352xds_unittest:
353  default: true
354  description: xDS unit tests.
355  internal: true
356xds_wrr_locality_lb:
357  default: false
358  description: XDS WRR locality LB policy.
359