python/grpc_admin.html - third_party/grpc - Git at Google


 <!DOCTYPE html>


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

   <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 &#8212; gRPC Python Docs v1.78.1</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=ed1a634b" />

   <!-- 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=ef80e3d6"></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 = 'grpc_admin';</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" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
   <meta name="docsearch:version" content="1.78.1" />
   </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.78.1</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>


     <button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
       <span class="fa-solid fa-outdent"></span>
     </button>

 </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">


   <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__start sidebar-primary__section">
         <div class="sidebar-primary-item">


 <nav class="bd-docs-nav bd-links" aria-label="Section Navigation">
   <p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
   <div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav">
 <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 active"><a class="current reference internal" href="#">gRPC Admin</a></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>
 </nav></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 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">

   <section id="grpc-admin">
 <h1>gRPC Admin<a class="headerlink" href="#grpc-admin" title="Link 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="Link 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="Link 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="Link 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>


                 </article>


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

 <div class="prev-next-area">
     <a class="left-prev"
        href="grpc_asyncio.html"
        title="previous page">
       <i class="fa-solid fa-angle-left"></i>
       <div class="prev-next-info">
         <p class="prev-next-subtitle">previous</p>
         <p class="prev-next-title">gRPC AsyncIO API</p>
       </div>
     </a>
     <a class="right-next"
        href="grpc_channelz.html"
        title="next page">
       <div class="prev-next-info">
         <p class="prev-next-subtitle">next</p>
         <p class="prev-next-title">gRPC Channelz</p>
       </div>
       <i class="fa-solid fa-angle-right"></i>
     </a>
 </div>
                 </footer>

             </div>


                 <dialog id="pst-secondary-sidebar-modal"></dialog>
                 <div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">


   <div class="sidebar-secondary-item">
 <div
     id="pst-page-navigation-heading-2"
     class="page-toc tocsection onthispage">
     <i class="fa-solid fa-list"></i> On this page
   </div>
   <nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2">
     <ul class="visible nav section-nav flex-column">
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#what-is-grpc-admin">What is gRPC Admin?</a></li>
 <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-grpc_admin">Module Contents</a><ul class="visible nav section-nav flex-column">
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#grpc_admin.add_admin_servicers"><code class="docutils literal notranslate"><span class="pre">add_admin_servicers()</span></code></a></li>
 </ul>
 </li>
 </ul>
   </nav></div>

 </div></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>

	<!DOCTYPE html>


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

	<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 Docs v1.78.1</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=ed1a634b" />

	<!-- 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=ef80e3d6"></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 = 'grpc_admin';</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" />
	<meta name="viewport" content="width=device-width, initial-scale=1"/>
	<meta name="docsearch:language" content="en"/>
	<meta name="docsearch:version" content="1.78.1" />
	</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.78.1</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>



	<button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
	<span class="fa-solid fa-outdent"></span>
	</button>

	</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">



	<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__start sidebar-primary__section">
	<div class="sidebar-primary-item">




	<nav class="bd-docs-nav bd-links" aria-label="Section Navigation">
	<p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
	<div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav">
	<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 active"><a class="current reference internal" href="#">gRPC Admin</a></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>
	</nav></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 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">

	<section id="grpc-admin">
	<h1>gRPC Admin<a class="headerlink" href="#grpc-admin" title="Link 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="Link 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="Link 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="Link 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>


	</article>





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

	<div class="prev-next-area">
	<a class="left-prev"
	href="grpc_asyncio.html"
	title="previous page">
	<i class="fa-solid fa-angle-left"></i>
	<div class="prev-next-info">
	<p class="prev-next-subtitle">previous</p>
	<p class="prev-next-title">gRPC AsyncIO API</p>
	</div>
	</a>
	<a class="right-next"
	href="grpc_channelz.html"
	title="next page">
	<div class="prev-next-info">
	<p class="prev-next-subtitle">next</p>
	<p class="prev-next-title">gRPC Channelz</p>
	</div>
	<i class="fa-solid fa-angle-right"></i>
	</a>
	</div>
	</footer>

	</div>



	<dialog id="pst-secondary-sidebar-modal"></dialog>
	<div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">


	<div class="sidebar-secondary-item">
	<div
	id="pst-page-navigation-heading-2"
	class="page-toc tocsection onthispage">
	<i class="fa-solid fa-list"></i> On this page
	</div>
	<nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2">
	<ul class="visible nav section-nav flex-column">
	<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#what-is-grpc-admin">What is gRPC Admin?</a></li>
	<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#module-grpc_admin">Module Contents</a><ul class="visible nav section-nav flex-column">
	<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#grpc_admin.add_admin_servicers"><code class="docutils literal notranslate"><span class="pre">add_admin_servicers()</span></code></a></li>
	</ul>
	</li>
	</ul>
	</nav></div>

	</div></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>