35/javadoc/org/apache/kafka/common/metrics/MetricsReporter.html - kafka-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
 <title>MetricsReporter (kafka 3.5.2 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="description" content="declaration: package: org.apache.kafka.common.metrics, interface: MetricsReporter">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 <script type="text/javascript" src="../../../../../script-dir/jquery-3.5.1.min.js"></script>
 <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
 </head>
 <body class="class-declaration-page">
 <script type="text/javascript">var evenRowColor = "even-row-color";
 var oddRowColor = "odd-row-color";
 var tableTab = "table-tab";
 var activeTableTab = "active-table-tab";
 var pathtoroot = "../../../../../";
 loadScripts(document, 'script');</script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <div class="flex-box">
 <header role="banner" class="flex-header">
 <nav role="navigation">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="top-nav" id="navbar-top">
 <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
 <ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
 <li><a href="../../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="nav-bar-cell1-rev">Class</li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../../index-all.html">Index</a></li>
 <li><a href="../../../../../help-doc.html#class">Help</a></li>
 </ul>
 </div>
 <div class="sub-nav">
 <div>
 <ul class="sub-nav-list">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method-summary">Method</a></li>
 </ul>
 <ul class="sub-nav-list">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li>Constr&nbsp;|&nbsp;</li>
 <li><a href="#method-detail">Method</a></li>
 </ul>
 </div>
 <div class="nav-list-search"><label for="search-input">SEARCH:</label>
 <input type="text" id="search-input" value="search" disabled="disabled">
 <input type="reset" id="reset-button" value="reset" disabled="disabled">
 </div>
 </div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <span class="skip-nav" id="skip-navbar-top"></span></nav>
 </header>
 <div class="flex-content">
 <main role="main">
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.kafka.common.metrics</a></div>
 <h1 title="Interface MetricsReporter" class="title">Interface MetricsReporter</h1>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>All Superinterfaces:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code>, <code><a href="../Configurable.html" title="interface in org.apache.kafka.common">Configurable</a></code>, <code><a href="../Reconfigurable.html" title="interface in org.apache.kafka.common">Reconfigurable</a></code></dd>
 </dl>
 <dl class="notes">
 <dt>All Known Implementing Classes:</dt>
 <dd><code><a href="JmxReporter.html" title="class in org.apache.kafka.common.metrics">JmxReporter</a></code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">MetricsReporter</span><span class="extends-implements">
 extends <a href="../Reconfigurable.html" title="interface in org.apache.kafka.common">Reconfigurable</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></span></div>
 <div class="block">A plugin interface to allow things to listen as new metrics are created so they can be reported.
  <p>
  Implement <a href="../ClusterResourceListener.html" title="interface in org.apache.kafka.common"><code>ClusterResourceListener</code></a> to receive cluster metadata once it's available. Please see the class documentation for ClusterResourceListener for more information.</div>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- ========== METHOD SUMMARY =========== -->
 <li>
 <section class="method-summary" id="method-summary">
 <h2>Method Summary</h2>
 <div id="method-summary-table">
 <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div>
 <div id="method-summary-table.tabpanel" role="tabpanel">
 <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Method</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#close()" class="member-name-link">close</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">Called when the metrics repository is closed.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#contextChange(org.apache.kafka.common.metrics.MetricsContext)" class="member-name-link">contextChange</a><wbr>(<a href="MetricsContext.html" title="interface in org.apache.kafka.common.metrics">MetricsContext</a>&nbsp;metricsContext)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
 <div class="block">Sets the context labels for the service or library exposing metrics.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#init(java.util.List)" class="member-name-link">init</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="KafkaMetric.html" title="class in org.apache.kafka.common.metrics">KafkaMetric</a>&gt;&nbsp;metrics)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">This is called when the reporter is first registered to initially register all existing metrics</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#metricChange(org.apache.kafka.common.metrics.KafkaMetric)" class="member-name-link">metricChange</a><wbr>(<a href="KafkaMetric.html" title="class in org.apache.kafka.common.metrics">KafkaMetric</a>&nbsp;metric)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">This is called whenever a metric is updated or added</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#metricRemoval(org.apache.kafka.common.metrics.KafkaMetric)" class="member-name-link">metricRemoval</a><wbr>(<a href="KafkaMetric.html" title="class in org.apache.kafka.common.metrics">KafkaMetric</a>&nbsp;metric)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
 <div class="block">This is called whenever a metric is removed</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#reconfigurableConfigs()" class="member-name-link">reconfigurableConfigs</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
 <div class="block">Returns the names of configs that may be reconfigured.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#reconfigure(java.util.Map)" class="member-name-link">reconfigure</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>?&gt;&nbsp;configs)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
 <div class="block">Reconfigures this instance with the given key-value pairs.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#validateReconfiguration(java.util.Map)" class="member-name-link">validateReconfiguration</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>?&gt;&nbsp;configs)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
 <div class="block">Validates the provided configuration.</div>
 </div>
 </div>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-org.apache.kafka.common.Configurable">Methods inherited from interface&nbsp;org.apache.kafka.common.<a href="../Configurable.html" title="interface in org.apache.kafka.common">Configurable</a></h3>
 <code><a href="../Configurable.html#configure(java.util.Map)">configure</a></code></div>
 </section>
 </li>
 </ul>
 </section>
 <section class="details">
 <ul class="details-list">
 <!-- ============ METHOD DETAIL ========== -->
 <li>
 <section class="method-details" id="method-detail">
 <h2>Method Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="init(java.util.List)">
 <h3>init</h3>
 <div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">init</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="KafkaMetric.html" title="class in org.apache.kafka.common.metrics">KafkaMetric</a>&gt;&nbsp;metrics)</span></div>
 <div class="block">This is called when the reporter is first registered to initially register all existing metrics</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>metrics</code> - All currently existing metrics</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="metricChange(org.apache.kafka.common.metrics.KafkaMetric)">
 <h3>metricChange</h3>
 <div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">metricChange</span><wbr><span class="parameters">(<a href="KafkaMetric.html" title="class in org.apache.kafka.common.metrics">KafkaMetric</a>&nbsp;metric)</span></div>
 <div class="block">This is called whenever a metric is updated or added</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>metric</code> - </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="metricRemoval(org.apache.kafka.common.metrics.KafkaMetric)">
 <h3>metricRemoval</h3>
 <div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">metricRemoval</span><wbr><span class="parameters">(<a href="KafkaMetric.html" title="class in org.apache.kafka.common.metrics">KafkaMetric</a>&nbsp;metric)</span></div>
 <div class="block">This is called whenever a metric is removed</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>metric</code> - </dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="close()">
 <h3>close</h3>
 <div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">close</span>()</div>
 <div class="block">Called when the metrics repository is closed.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html#close()" title="class or interface in java.lang" class="external-link">close</a></code>&nbsp;in interface&nbsp;<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="reconfigurableConfigs()">
 <h3>reconfigurableConfigs</h3>
 <div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</span>&nbsp;<span class="element-name">reconfigurableConfigs</span>()</div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../Reconfigurable.html#reconfigurableConfigs()">Reconfigurable</a></code></span></div>
 <div class="block">Returns the names of configs that may be reconfigured.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="../Reconfigurable.html#reconfigurableConfigs()">reconfigurableConfigs</a></code>&nbsp;in interface&nbsp;<code><a href="../Reconfigurable.html" title="interface in org.apache.kafka.common">Reconfigurable</a></code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="validateReconfiguration(java.util.Map)">
 <h3>validateReconfiguration</h3>
 <div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">validateReconfiguration</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>?&gt;&nbsp;configs)</span>
                               throws <span class="exceptions"><a href="../config/ConfigException.html" title="class in org.apache.kafka.common.config">ConfigException</a></span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../Reconfigurable.html#validateReconfiguration(java.util.Map)">Reconfigurable</a></code></span></div>
 <div class="block">Validates the provided configuration. The provided map contains
  all configs including any reconfigurable configs that may be different
  from the initial configuration. Reconfiguration will be not performed
  if this method throws any exception.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="../Reconfigurable.html#validateReconfiguration(java.util.Map)">validateReconfiguration</a></code>&nbsp;in interface&nbsp;<code><a href="../Reconfigurable.html" title="interface in org.apache.kafka.common">Reconfigurable</a></code></dd>
 <dt>Throws:</dt>
 <dd><code><a href="../config/ConfigException.html" title="class in org.apache.kafka.common.config">ConfigException</a></code> - if the provided configs are not valid. The exception
          message from ConfigException will be returned to the client in
          the AlterConfigs response.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="reconfigure(java.util.Map)">
 <h3>reconfigure</h3>
 <div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">reconfigure</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr>?&gt;&nbsp;configs)</span></div>
 <div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../Reconfigurable.html#reconfigure(java.util.Map)">Reconfigurable</a></code></span></div>
 <div class="block">Reconfigures this instance with the given key-value pairs. The provided
  map contains all configs including any reconfigurable configs that
  may have changed since the object was initially configured using
  <a href="../Configurable.html#configure(java.util.Map)"><code>Configurable.configure(Map)</code></a>. This method will only be invoked if
  the configs have passed validation using <a href="../Reconfigurable.html#validateReconfiguration(java.util.Map)"><code>Reconfigurable.validateReconfiguration(Map)</code></a>.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="../Reconfigurable.html#reconfigure(java.util.Map)">reconfigure</a></code>&nbsp;in interface&nbsp;<code><a href="../Reconfigurable.html" title="interface in org.apache.kafka.common">Reconfigurable</a></code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="contextChange(org.apache.kafka.common.metrics.MetricsContext)">
 <h3>contextChange</h3>
 <div class="member-signature"><span class="annotations"><a href="../annotation/InterfaceStability.Evolving.html" title="annotation interface in org.apache.kafka.common.annotation">@Evolving</a>
 </span><span class="modifiers">default</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">contextChange</span><wbr><span class="parameters">(<a href="MetricsContext.html" title="interface in org.apache.kafka.common.metrics">MetricsContext</a>&nbsp;metricsContext)</span></div>
 <div class="block">Sets the context labels for the service or library exposing metrics. This will be called before <a href="#init(java.util.List)"><code>init(List)</code></a> and may be called anytime after that.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>metricsContext</code> - the metric context</dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 </div>
 </div>
 </body>
 </html>