md_doc_environment_variables.html 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.6"/>
  7. <title>GRPC Core: gRPC environment variables</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/search.js"></script>
  13. <script type="text/javascript">
  14. $(document).ready(function() { searchBox.OnSelectItem(0); });
  15. </script>
  16. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr style="height: 56px;">
  24. <td style="padding-left: 0.5em;">
  25. <div id="projectname">GRPC Core
  26. &#160;<span id="projectnumber">4.0.0</span>
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.6 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li class="current"><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  42. <li><a href="modules.html"><span>Modules</span></a></li>
  43. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  44. <li><a href="files.html"><span>Files</span></a></li>
  45. <li>
  46. <div id="MSearchBox" class="MSearchBoxInactive">
  47. <span class="left">
  48. <img id="MSearchSelect" src="search/mag_sel.png"
  49. onmouseover="return searchBox.OnSearchSelectShow()"
  50. onmouseout="return searchBox.OnSearchSelectHide()"
  51. alt=""/>
  52. <input type="text" id="MSearchField" value="Search" accesskey="S"
  53. onfocus="searchBox.OnSearchFieldFocus(true)"
  54. onblur="searchBox.OnSearchFieldFocus(false)"
  55. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  56. </span><span class="right">
  57. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  58. </span>
  59. </div>
  60. </li>
  61. </ul>
  62. </div>
  63. <!-- window showing the filter options -->
  64. <div id="MSearchSelectWindow"
  65. onmouseover="return searchBox.OnSearchSelectShow()"
  66. onmouseout="return searchBox.OnSearchSelectHide()"
  67. onkeydown="return searchBox.OnSearchSelectKey(event)">
  68. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  69. <!-- iframe showing the search results (closed by default) -->
  70. <div id="MSearchResultsWindow">
  71. <iframe src="javascript:void(0)" frameborder="0"
  72. name="MSearchResults" id="MSearchResults">
  73. </iframe>
  74. </div>
  75. </div><!-- top -->
  76. <div class="header">
  77. <div class="headertitle">
  78. <div class="title">gRPC environment variables </div> </div>
  79. </div><!--header-->
  80. <div class="contents">
  81. <div class="textblock"><p>gRPC C core based implementations (those contained in this repository) expose some configuration as environment variables that can be set.</p>
  82. <ul>
  83. <li>GRPC_ABORT_ON_LEAKS A debugging aid to cause a call to abort() when gRPC objects are leaked past <a class="el" href="grpc_8h.html#a35f55253e80714c17f4f3a0657e06f1b" title="Shut down the grpc library. ">grpc_shutdown()</a>. Set to 1 to cause the abort, if unset or 0 it does not abort the process.</li>
  84. <li>GOOGLE_APPLICATION_CREDENTIALS The path to find the credentials to use when Google credentials are created</li>
  85. <li>GRPC_SSL_CIPHER_SUITES A colon separated list of cipher suites to use with OpenSSL Defaults to: ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES256-GCM-SHA384</li>
  86. <li>GRPC_DEFAULT_SSL_ROOTS_FILE_PATH PEM file to load SSL roots from</li>
  87. <li>GRPC_POLL_STRATEGY [posix-style environments only] Declares which polling engines to try when starting gRPC. This is a comma-separated list of engines, which are tried in priority order first -&gt; last. Available polling engines include:<ul>
  88. <li>epoll (linux-only) - a polling engine based around the epoll family of system calls</li>
  89. <li>poll - a portable polling engine based around poll(), intended to be a fallback engine when nothing better exists</li>
  90. <li>legacy - the (deprecated) original polling engine for gRPC</li>
  91. </ul>
  92. </li>
  93. <li><p class="startli">GRPC_TRACE A comma separated list of tracers that provide additional insight into how gRPC C core is processing requests via debug logs. Available tracers include:</p>
  94. <ul>
  95. <li>api - traces api calls to the C core</li>
  96. <li>bdp_estimator - traces behavior of bdp estimation logic</li>
  97. <li>call_error - traces the possible errors contributing to final call status</li>
  98. <li>channel - traces operations on the C core channel stack</li>
  99. <li>combiner - traces combiner lock state</li>
  100. <li>compression - traces compression operations</li>
  101. <li>connectivity_state - traces connectivity state changes to channels</li>
  102. <li>channel_stack_builder - traces information about channel stacks being built</li>
  103. <li>http - traces state in the http2 transport engine</li>
  104. <li>http1 - traces HTTP/1.x operations performed by gRPC</li>
  105. <li>flowctl - traces http2 flow control</li>
  106. <li>op_failure - traces error information when failure is pushed onto a completion queue</li>
  107. <li>pending_tags - [debug builds only] traces still-in-progress tags on completion queues</li>
  108. <li>round_robin - traces the round_robin load balancing policy</li>
  109. <li>glb - traces the grpclb load balancer</li>
  110. <li>queue_pluck</li>
  111. <li>queue_timeout</li>
  112. <li>server_channel - lightweight trace of significant server channel events</li>
  113. <li>secure_endpoint - traces bytes flowing through encrypted channels</li>
  114. <li>timer - timers (alarms) in the grpc internals</li>
  115. <li>transport_security - traces metadata about secure channel establishment</li>
  116. <li>tcp - traces bytes in and out of a channel</li>
  117. </ul>
  118. <p class="startli">'all' can additionally be used to turn all traces on. Individual traces can be disabled by prefixing them with '-'.</p>
  119. <p class="startli">Example: export GRPC_TRACE=all,-pending_tags</p>
  120. </li>
  121. <li>GRPC_VERBOSITY Default gRPC logging verbosity - one of:<ul>
  122. <li>DEBUG - log all gRPC messages</li>
  123. <li>INFO - log INFO and ERROR message</li>
  124. <li>ERROR - log only errors</li>
  125. </ul>
  126. </li>
  127. <li>GRPC_DNS_RESOLVER Declares which DNS resolver to use. The default is ares if gRPC is built with c-ares support. Otherwise, the value of this environment variable is ignored. Available DNS resolver include:<ul>
  128. <li>native (default)- a DNS resolver based around getaddrinfo(), creates a new thread to perform name resolution</li>
  129. <li>ares - a DNS resolver based around the c-ares library </li>
  130. </ul>
  131. </li>
  132. </ul>
  133. </div></div><!-- contents -->
  134. <!-- start footer part -->
  135. <hr class="footer"/><address class="footer"><small>
  136. Generated on Wed Jun 21 2017 14:13:07 for GRPC Core by &#160;<a href="http://www.doxygen.org/index.html">
  137. <img class="footer" src="doxygen.png" alt="doxygen"/>
  138. </a> 1.8.6
  139. </small></address>
  140. </body>
  141. </html>