167 lines
7.2 KiB
HTML
167 lines
7.2 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 Admin — 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 Channelz" href="grpc_channelz.html" />
|
||
<link rel="prev" title="gRPC AsyncIO API" href="grpc_asyncio.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 current"><a class="current reference internal" href="#">gRPC Admin</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="#what-is-grpc-admin">What is gRPC Admin?</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#module-grpc_admin">Module Contents</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#grpc_admin.add_admin_servicers"><code class="docutils literal notranslate"><span class="pre">add_admin_servicers()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="grpc_channelz.html">gRPC Channelz</a></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_asyncio.html" title="previous chapter">gRPC AsyncIO API</a></li>
|
||
<li>Next: <a href="grpc_channelz.html" title="next chapter">gRPC Channelz</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-admin">
|
||
<h1>gRPC Admin<a class="headerlink" href="#grpc-admin" title="Permalink to this heading">¶</a></h1>
|
||
<section id="what-is-grpc-admin">
|
||
<h2>What is gRPC Admin?<a class="headerlink" href="#what-is-grpc-admin" title="Permalink to this heading">¶</a></h2>
|
||
<p>It’s a convenient API to improve the usability of creating a gRPC server with admin services to expose states in the gRPC library.</p>
|
||
<p>Design Document <a class="reference external" href="https://github.com/grpc/proposal/blob/master/A38-admin-interface-api.md">gRPC Admin Interface</a></p>
|
||
</section>
|
||
<section id="module-grpc_admin">
|
||
<span id="module-contents"></span><h2>Module Contents<a class="headerlink" href="#module-grpc_admin" title="Permalink to this heading">¶</a></h2>
|
||
<p>gRPC Python’s Admin interface.</p>
|
||
<dl class="py function">
|
||
<dt class="sig sig-object py" id="grpc_admin.add_admin_servicers">
|
||
<span class="sig-prename descclassname"><span class="pre">grpc_admin.</span></span><span class="sig-name descname"><span class="pre">add_admin_servicers</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_admin.html#add_admin_servicers"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_admin.add_admin_servicers" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Register admin servicers to a server.</p>
|
||
<p>gRPC provides some predefined admin services to make debugging easier by
|
||
exposing gRPC’s internal states. Each existing admin service is packaged as
|
||
a separate library, and the documentation of the predefined admin services
|
||
is usually scattered. It can be time consuming to get the dependency
|
||
management, module initialization, and library import right for each one of
|
||
them.</p>
|
||
<p>This API provides a convenient way to create a gRPC server to expose admin
|
||
services. With this, any new admin services that you may add in the future
|
||
are automatically available via the admin interface just by upgrading your
|
||
gRPC version.</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 all admin services 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_admin.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> |