Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions python/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 5e2d1268bb48648a31ecdb8d5b35d00c
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added python/.doctrees/environment.pickle
Binary file not shown.
Binary file added python/.doctrees/glossary.doctree
Binary file not shown.
Binary file added python/.doctrees/grpc.doctree
Binary file not shown.
Binary file added python/.doctrees/grpc_admin.doctree
Binary file not shown.
Binary file added python/.doctrees/grpc_asyncio.doctree
Binary file not shown.
Binary file added python/.doctrees/grpc_channelz.doctree
Binary file not shown.
Binary file added python/.doctrees/grpc_csds.doctree
Binary file not shown.
Binary file added python/.doctrees/grpc_health_checking.doctree
Binary file not shown.
Binary file added python/.doctrees/grpc_observability.doctree
Binary file not shown.
Binary file added python/.doctrees/grpc_reflection.doctree
Binary file not shown.
Binary file added python/.doctrees/grpc_status.doctree
Binary file not shown.
Binary file added python/.doctrees/grpc_testing.doctree
Binary file not shown.
Binary file added python/.doctrees/index.doctree
Binary file not shown.
3,042 changes: 3,042 additions & 0 deletions python/_modules/grpc.html

Large diffs are not rendered by default.

510 changes: 510 additions & 0 deletions python/_modules/grpc/_runtime_protos.html

Large diffs are not rendered by default.

673 changes: 673 additions & 0 deletions python/_modules/grpc/aio/_base_call.html

Large diffs are not rendered by default.

759 changes: 759 additions & 0 deletions python/_modules/grpc/aio/_base_channel.html

Large diffs are not rendered by default.

815 changes: 815 additions & 0 deletions python/_modules/grpc/aio/_base_server.html

Large diffs are not rendered by default.

1,113 changes: 1,113 additions & 0 deletions python/_modules/grpc/aio/_call.html

Large diffs are not rendered by default.

969 changes: 969 additions & 0 deletions python/_modules/grpc/aio/_channel.html

Large diffs are not rendered by default.

1,557 changes: 1,557 additions & 0 deletions python/_modules/grpc/aio/_interceptor.html

Large diffs are not rendered by default.

497 changes: 497 additions & 0 deletions python/_modules/grpc/aio/_metadata.html

Large diffs are not rendered by default.

582 changes: 582 additions & 0 deletions python/_modules/grpc/aio/_server.html

Large diffs are not rendered by default.

380 changes: 380 additions & 0 deletions python/_modules/grpc_admin.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,380 @@

<!DOCTYPE html>


<html lang="en" data-content_root="../" >

<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>grpc_admin &#8212; gRPC Python Docs v1.79.0</title>



<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!--
this give us a css class that will be invisible only if js is disabled
-->
<noscript>
<style>
.pst-js-only { display: none !important; }

</style>
</noscript>

<!-- Loaded before other Sphinx assets -->
<link href="../_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link href="../_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />

<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" />
<link rel="stylesheet" type="text/css" href="../_static/custom.css?v=91a1c956" />

<!-- So that users can add custom icons -->
<script src="../_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />

<script src="../_static/documentation_options.js?v=63189dc3"></script>
<script src="../_static/doctools.js?v=9a2dae69"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script async="async" src="https://www.googletagmanager.com/gtag/js?id=UA-60127042-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){ dataLayer.push(arguments); }
gtag('js', new Date());
gtag('config', 'UA-60127042-1');
</script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){ dataLayer.push(arguments); }
gtag('js', new Date());
gtag('config', 'UA-60127042-1');
</script>
<script>DOCUMENTATION_OPTIONS.pagename = '_modules/grpc_admin';</script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="1.79.0" />
</head>


<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">



<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>

<div id="pst-scroll-pixel-helper"></div>

<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>


<dialog id="pst-search-dialog">

<form class="bd-search d-flex align-items-center"
action="../search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
placeholder="Search the docs ..."
aria-label="Search the docs ..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form>
</dialog>

<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>


<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
<div class="bd-header__inner bd-page-width">
<button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
<span class="fa-solid fa-bars"></span>
</button>


<div class="col-lg-3 navbar-header-items__start">

<div class="navbar-item">





<a class="navbar-brand logo" href="../index.html">






<p class="title logo__title">gRPC Python Docs v1.79.0</p>

</a></div>

</div>

<div class="col-lg-9 navbar-header-items">


<div class="navbar-header-items__end">

<div class="navbar-item navbar-persistent--container">


<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>


<div class="navbar-item">

<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>

</div>

</div>


<div class="navbar-persistent--mobile">

<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
</div>



</div>

</header>


<div class="bd-container">
<div class="bd-container__inner bd-page-width">





<dialog id="pst-primary-sidebar-modal"></dialog>
<div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar hide-on-wide">



<div class="sidebar-header-items sidebar-primary__section">




<div class="sidebar-header-items__end">

<div class="navbar-item">

<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>

</div>

</div>


<div class="sidebar-primary-items__end sidebar-primary__section">
<div class="sidebar-primary-item">
<div id="ethical-ad-placement"
class="flat"
data-ea-publisher="readthedocs"
data-ea-type="readthedocs-sidebar"
data-ea-manual="true">
</div></div>
</div>


</div>

<main id="main-content" class="bd-main" role="main">


<div class="bd-content">
<div class="bd-article-container">

<div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">

<div class="header-article-items__start">

<div class="header-article-item">

<nav aria-label="Breadcrumb" class="d-print-none">
<ul class="bd-breadcrumbs">

<li class="breadcrumb-item breadcrumb-home">
<a href="../index.html" class="nav-link" aria-label="Home">
<i class="fa-solid fa-home"></i>
</a>
</li>

<li class="breadcrumb-item"><a href="index.html" class="nav-link">Module code</a></li>

<li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">grpc_admin</span></li>
</ul>
</nav>
</div>

</div>


</div>
</div>




<div id="searchbox"></div>
<article class="bd-article">

<h1>Source code for grpc_admin</h1><div class="highlight"><pre>
<span></span><span class="c1"># Copyright 2021 The gRPC Authors</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span>
<span class="c1"># you may not use this file except in compliance with the License.</span>
<span class="c1"># You may obtain a copy of the License at</span>
<span class="c1">#</span>
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c1">#</span>
<span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
<span class="c1"># distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span>
<span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="c1"># See the License for the specific language governing permissions and</span>
<span class="c1"># limitations under the License.</span>
<span class="sd">&quot;&quot;&quot;gRPC Python&#39;s Admin interface.&quot;&quot;&quot;</span>

<span class="kn">from</span><span class="w"> </span><span class="nn">grpc_channelz.v1</span><span class="w"> </span><span class="kn">import</span> <span class="n">channelz</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">grpc_csds</span>


<div class="viewcode-block" id="add_admin_servicers">
<a class="viewcode-back" href="../grpc_admin.html#grpc_admin.add_admin_servicers">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">add_admin_servicers</span><span class="p">(</span><span class="n">server</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Register admin servicers to a server.</span>

<span class="sd"> gRPC provides some predefined admin services to make debugging easier by</span>
<span class="sd"> exposing gRPC&#39;s internal states. Each existing admin service is packaged as</span>
<span class="sd"> a separate library, and the documentation of the predefined admin services</span>
<span class="sd"> is usually scattered. It can be time consuming to get the dependency</span>
<span class="sd"> management, module initialization, and library import right for each one of</span>
<span class="sd"> them.</span>

<span class="sd"> This API provides a convenient way to create a gRPC server to expose admin</span>
<span class="sd"> services. With this, any new admin services that you may add in the future</span>
<span class="sd"> are automatically available via the admin interface just by upgrading your</span>
<span class="sd"> gRPC version.</span>

<span class="sd"> Args:</span>
<span class="sd"> server: A gRPC server to which all admin services will be added.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">channelz</span><span class="o">.</span><span class="n">add_channelz_servicer</span><span class="p">(</span><span class="n">server</span><span class="p">)</span>
<span class="n">grpc_csds</span><span class="o">.</span><span class="n">add_csds_servicer</span><span class="p">(</span><span class="n">server</span><span class="p">)</span></div>



<span class="n">__all__</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;add_admin_servicers&quot;</span><span class="p">]</span>
</pre></div>

</article>





<footer class="prev-next-footer d-print-none">

<div class="prev-next-area">
</div>
</footer>

</div>




</div>
<footer class="bd-footer-content">

</footer>

</main>
</div>
</div>

<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script defer src="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf"></script>
<script defer src="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf"></script>

<footer class="bd-footer">
<div class="bd-footer__inner bd-page-width">

<div class="footer-items__start">

<div class="footer-item">

<p class="copyright">

© Copyright 2025, The gRPC Authors.
<br/>

</p>
</div>

<div class="footer-item">

<p class="sphinx-version">
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.
<br/>
</p>
</div>

</div>



<div class="footer-items__end">

<div class="footer-item">
<p class="theme-version">
<!-- # L10n: Setting the PST URL as an argument as this does not need to be localized -->
Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.16.1.
</p></div>

</div>

</div>

</footer>
</body>
</html>
Loading
Loading