225 lines
16 KiB
HTML
225 lines
16 KiB
HTML
<!DOCTYPE html>
|
||
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
|
||
<title>gRPC Channelz — gRPC Python 1.64.0 documentation</title>
|
||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=4f649999" />
|
||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=8090fdca" />
|
||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=057799ce"></script>
|
||
<script src="_static/doctools.js?v=888ff710"></script>
|
||
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="gRPC CSDS" href="grpc_csds.html" />
|
||
<link rel="prev" title="gRPC Admin" href="grpc_admin.html" />
|
||
|
||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||
|
||
</head><body>
|
||
<div class="document">
|
||
|
||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||
<div class="sphinxsidebarwrapper">
|
||
<h1 class="logo"><a href="index.html">gRPC Python</a></h1>
|
||
|
||
|
||
|
||
<p class="blurb">1.64.0</p>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<h3>Navigation</h3>
|
||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="grpc.html">gRPC</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="grpc_asyncio.html">gRPC AsyncIO API</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="grpc_admin.html">gRPC Admin</a></li>
|
||
<li class="toctree-l1 current"><a class="current reference internal" href="#">gRPC Channelz</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="#what-is-grpc-channelz">What is gRPC Channelz?</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#module-grpc_channelz.v1.channelz">Module Contents</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#grpc_channelz.v1.channelz.ChannelzServicer"><code class="docutils literal notranslate"><span class="pre">ChannelzServicer</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#grpc_channelz.v1.channelz.ChannelzServicer.GetChannel"><code class="docutils literal notranslate"><span class="pre">ChannelzServicer.GetChannel()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#grpc_channelz.v1.channelz.ChannelzServicer.GetServer"><code class="docutils literal notranslate"><span class="pre">ChannelzServicer.GetServer()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#grpc_channelz.v1.channelz.ChannelzServicer.GetServerSockets"><code class="docutils literal notranslate"><span class="pre">ChannelzServicer.GetServerSockets()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#grpc_channelz.v1.channelz.ChannelzServicer.GetServers"><code class="docutils literal notranslate"><span class="pre">ChannelzServicer.GetServers()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#grpc_channelz.v1.channelz.ChannelzServicer.GetSocket"><code class="docutils literal notranslate"><span class="pre">ChannelzServicer.GetSocket()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#grpc_channelz.v1.channelz.ChannelzServicer.GetSubchannel"><code class="docutils literal notranslate"><span class="pre">ChannelzServicer.GetSubchannel()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#grpc_channelz.v1.channelz.ChannelzServicer.GetTopChannels"><code class="docutils literal notranslate"><span class="pre">ChannelzServicer.GetTopChannels()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#grpc_channelz.v1.channelz.add_channelz_servicer"><code class="docutils literal notranslate"><span class="pre">add_channelz_servicer()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="grpc_csds.html">gRPC CSDS</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="grpc_health_checking.html">gRPC Health Checking</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="grpc_reflection.html">gRPC Reflection</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="grpc_status.html">gRPC Status</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="grpc_testing.html">gRPC Testing</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="grpc_observability.html">gRPC Python Observability</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
|
||
</ul>
|
||
|
||
<div class="relations">
|
||
<h3>Related Topics</h3>
|
||
<ul>
|
||
<li><a href="index.html">Documentation overview</a><ul>
|
||
<li>Previous: <a href="grpc_admin.html" title="previous chapter">gRPC Admin</a></li>
|
||
<li>Next: <a href="grpc_csds.html" title="next chapter">gRPC CSDS</a></li>
|
||
</ul></li>
|
||
</ul>
|
||
</div>
|
||
<div id="searchbox" style="display: none" role="search">
|
||
<h3 id="searchlabel">Quick search</h3>
|
||
<div class="searchformwrapper">
|
||
<form class="search" action="search.html" method="get">
|
||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</div>
|
||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
|
||
|
||
<div class="body" role="main">
|
||
|
||
<section id="grpc-channelz">
|
||
<h1>gRPC Channelz<a class="headerlink" href="#grpc-channelz" title="Permalink to this heading">¶</a></h1>
|
||
<section id="what-is-grpc-channelz">
|
||
<h2>What is gRPC Channelz?<a class="headerlink" href="#what-is-grpc-channelz" title="Permalink to this heading">¶</a></h2>
|
||
<p>Design Document <a class="reference external" href="https://github.com/grpc/proposal/blob/master/A14-channelz.md">gRPC Channelz</a></p>
|
||
</section>
|
||
<section id="module-grpc_channelz.v1.channelz">
|
||
<span id="module-contents"></span><h2>Module Contents<a class="headerlink" href="#module-grpc_channelz.v1.channelz" title="Permalink to this heading">¶</a></h2>
|
||
<p>Channelz debug service implementation in gRPC Python.</p>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="grpc_channelz.v1.channelz.ChannelzServicer">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc_channelz.v1.channelz.</span></span><span class="sig-name descname"><span class="pre">ChannelzServicer</span></span><a class="reference internal" href="_modules/grpc_channelz/v1/_servicer.html#ChannelzServicer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_channelz.v1.channelz.ChannelzServicer" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Servicer handling RPCs for service statuses.</p>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="grpc_channelz.v1.channelz.ChannelzServicer.GetChannel">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">GetChannel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_channelz/v1/_servicer.html#ChannelzServicer.GetChannel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_channelz.v1.channelz.ChannelzServicer.GetChannel" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns a single Channel, or else a NOT_FOUND code.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="grpc_channelz.v1.channelz.ChannelzServicer.GetServer">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">GetServer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_channelz/v1/_servicer.html#ChannelzServicer.GetServer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_channelz.v1.channelz.ChannelzServicer.GetServer" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns a single Server, or else a NOT_FOUND code.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="grpc_channelz.v1.channelz.ChannelzServicer.GetServerSockets">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">GetServerSockets</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_channelz/v1/_servicer.html#ChannelzServicer.GetServerSockets"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_channelz.v1.channelz.ChannelzServicer.GetServerSockets" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Gets all server sockets that exist in the process.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="grpc_channelz.v1.channelz.ChannelzServicer.GetServers">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">GetServers</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_channelz/v1/_servicer.html#ChannelzServicer.GetServers"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_channelz.v1.channelz.ChannelzServicer.GetServers" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Gets all servers that exist in the process.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="grpc_channelz.v1.channelz.ChannelzServicer.GetSocket">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">GetSocket</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_channelz/v1/_servicer.html#ChannelzServicer.GetSocket"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_channelz.v1.channelz.ChannelzServicer.GetSocket" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns a single Socket or else a NOT_FOUND code.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="grpc_channelz.v1.channelz.ChannelzServicer.GetSubchannel">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">GetSubchannel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_channelz/v1/_servicer.html#ChannelzServicer.GetSubchannel"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_channelz.v1.channelz.ChannelzServicer.GetSubchannel" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Returns a single Subchannel, or else a NOT_FOUND code.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="grpc_channelz.v1.channelz.ChannelzServicer.GetTopChannels">
|
||
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">GetTopChannels</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_channelz/v1/_servicer.html#ChannelzServicer.GetTopChannels"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_channelz.v1.channelz.ChannelzServicer.GetTopChannels" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Gets all root channels (i.e. channels the application has directly
|
||
created). This does not include subchannels nor non-top level channels.</p>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="grpc_channelz.v1.channelz.add_channelz_servicer">
|
||
<span class="sig-prename descclassname"><span class="pre">grpc_channelz.v1.channelz.</span></span><span class="sig-name descname"><span class="pre">add_channelz_servicer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">server</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_channelz/v1/channelz.html#add_channelz_servicer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_channelz.v1.channelz.add_channelz_servicer" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Add Channelz servicer to a server.</p>
|
||
<p>Channelz servicer is in charge of
|
||
pulling information from C-Core for entire process. It will allow the
|
||
server to response to Channelz queries.</p>
|
||
<p>The Channelz statistic is enabled by default inside C-Core. Whether the
|
||
statistic is enabled or not is isolated from adding Channelz servicer.
|
||
That means you can query Channelz info with a Channelz-disabled channel,
|
||
and you can add Channelz servicer to a Channelz-disabled server.</p>
|
||
<p>The Channelz statistic can be enabled or disabled by channel option
|
||
‘grpc.enable_channelz’. Set to 1 to enable, set to 0 to disable.</p>
|
||
<p>This is an EXPERIMENTAL API.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>server</strong> – A gRPC server to which Channelz service will be added.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
<div class="footer">
|
||
©2020, The gRPC Authors.
|
||
|
||
|
|
||
<a href="_sources/grpc_channelz.rst.txt"
|
||
rel="nofollow">Page source</a>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript">
|
||
|
||
var _gaq = _gaq || [];
|
||
_gaq.push(['_setAccount', 'UA-60127042-1']);
|
||
_gaq.push(['_setDomainName', 'none']);
|
||
_gaq.push(['_setAllowLinker', true]);
|
||
_gaq.push(['_trackPageview']);
|
||
|
||
(function() {
|
||
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
|
||
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
|
||
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
|
||
})();
|
||
|
||
</script>
|
||
|
||
</body>
|
||
</html> |