Google Git
Sign in
apache / kafka-site / c1a96e48b0106763f0a358c59bb4b8c23dda9850 / . / 36 / javadoc / org / apache / kafka / common / metrics / Sensor.html
blob: c2a33b1e3690a98cacd9571d96d480dd7b7d1ef8 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Sensor (kafka 3.6.1 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, class: Sensor">
<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><a href="#nested-class-summary">Nested</a>&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="Class Sensor" class="title">Class Sensor</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">org.apache.kafka.common.metrics.Sensor</div>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="type-signature"><span class="modifiers">public final class </span><span class="element-name type-name-label">Sensor</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
<div class="block">A sensor applies a continuous sequence of numerical values to a set of associated metrics. For example a sensor on
message size would record a sequence of message sizes using the <a href="#record(double)"><code>record(double)</code></a> api and would maintain a set
of metrics about request sizes such as the average or max.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="caption"><span>Nested Classes</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static enum&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="Sensor.RecordingLevel.html" class="type-name-link" title="enum class in org.apache.kafka.common.metrics">Sensor.RecordingLevel</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== 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-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete 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-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#add(org.apache.kafka.common.MetricName,org.apache.kafka.common.metrics.MeasurableStat)" class="member-name-link">add</a><wbr>(<a href="../MetricName.html" title="class in org.apache.kafka.common">MetricName</a>&nbsp;metricName,
<a href="MeasurableStat.html" title="interface in org.apache.kafka.common.metrics">MeasurableStat</a>&nbsp;stat)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Register a metric with this sensor</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#add(org.apache.kafka.common.MetricName,org.apache.kafka.common.metrics.MeasurableStat,org.apache.kafka.common.metrics.MetricConfig)" class="member-name-link">add</a><wbr>(<a href="../MetricName.html" title="class in org.apache.kafka.common">MetricName</a>&nbsp;metricName,
<a href="MeasurableStat.html" title="interface in org.apache.kafka.common.metrics">MeasurableStat</a>&nbsp;stat,
<a href="MetricConfig.html" title="class in org.apache.kafka.common.metrics">MetricConfig</a>&nbsp;config)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Register a metric with this sensor</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#add(org.apache.kafka.common.metrics.CompoundStat)" class="member-name-link">add</a><wbr>(<a href="CompoundStat.html" title="interface in org.apache.kafka.common.metrics">CompoundStat</a>&nbsp;stat)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Register a compound statistic with this sensor with no config override</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#add(org.apache.kafka.common.metrics.CompoundStat,org.apache.kafka.common.metrics.MetricConfig)" class="member-name-link">add</a><wbr>(<a href="CompoundStat.html" title="interface in org.apache.kafka.common.metrics">CompoundStat</a>&nbsp;stat,
<a href="MetricConfig.html" title="class in org.apache.kafka.common.metrics">MetricConfig</a>&nbsp;config)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Register a compound statistic with this sensor which yields multiple measurable quantities (like a histogram)</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#checkQuotas()" class="member-name-link">checkQuotas</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Check if we have violated our quota for any metric that has a configured quota</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#checkQuotas(long)" class="member-name-link">checkQuotas</a><wbr>(long&nbsp;timeMs)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hasExpired()" class="member-name-link">hasExpired</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Return true if the Sensor is eligible for removal due to inactivity.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hasMetrics()" class="member-name-link">hasMetrics</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Return if metrics were registered with this sensor.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#name()" class="member-name-link">name</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">The name this sensor is registered with.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#record()" class="member-name-link">record</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Record an occurrence, this is just short-hand for <a href="#record(double)"><code>record(1.0)</code></a></div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#record(double)" class="member-name-link">record</a><wbr>(double&nbsp;value)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Record a value with this sensor</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#record(double,long)" class="member-name-link">record</a><wbr>(double&nbsp;value,
long&nbsp;timeMs)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Record a value at a known time.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#record(double,long,boolean)" class="member-name-link">record</a><wbr>(double&nbsp;value,
long&nbsp;timeMs,
boolean&nbsp;checkQuotas)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Record a value at a known time.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shouldRecord()" class="member-name-link">shouldRecord</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</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="name()">
<h3>name</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><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></span>&nbsp;<span class="element-name">name</span>()</div>
<div class="block">The name this sensor is registered with. This name will be unique among all registered sensors.</div>
</section>
</li>
<li>
<section class="detail" id="shouldRecord()">
<h3>shouldRecord</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">shouldRecord</span>()</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>true if the sensor's record level indicates that the metric will be recorded, false otherwise</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="record()">
<h3>record</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">record</span>()</div>
<div class="block">Record an occurrence, this is just short-hand for <a href="#record(double)"><code>record(1.0)</code></a></div>
</section>
</li>
<li>
<section class="detail" id="record(double)">
<h3>record</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">record</span><wbr><span class="parameters">(double&nbsp;value)</span></div>
<div class="block">Record a value with this sensor</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>value</code> - The value to record</dd>
<dt>Throws:</dt>
<dd><code><a href="QuotaViolationException.html" title="class in org.apache.kafka.common.metrics">QuotaViolationException</a></code> - if recording this value moves a metric beyond its configured maximum or minimum
bound</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="record(double,long)">
<h3>record</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">record</span><wbr><span class="parameters">(double&nbsp;value,
long&nbsp;timeMs)</span></div>
<div class="block">Record a value at a known time. This method is slightly faster than <a href="#record(double)"><code>record(double)</code></a> since it will reuse
the time stamp.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>value</code> - The value we are recording</dd>
<dd><code>timeMs</code> - The current POSIX time in milliseconds</dd>
<dt>Throws:</dt>
<dd><code><a href="QuotaViolationException.html" title="class in org.apache.kafka.common.metrics">QuotaViolationException</a></code> - if recording this value moves a metric beyond its configured maximum or minimum
bound</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="record(double,long,boolean)">
<h3>record</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">record</span><wbr><span class="parameters">(double&nbsp;value,
long&nbsp;timeMs,
boolean&nbsp;checkQuotas)</span></div>
<div class="block">Record a value at a known time. This method is slightly faster than <a href="#record(double)"><code>record(double)</code></a> since it will reuse
the time stamp.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>value</code> - The value we are recording</dd>
<dd><code>timeMs</code> - The current POSIX time in milliseconds</dd>
<dd><code>checkQuotas</code> - Indicate if quota must be enforced or not</dd>
<dt>Throws:</dt>
<dd><code><a href="QuotaViolationException.html" title="class in org.apache.kafka.common.metrics">QuotaViolationException</a></code> - if recording this value moves a metric beyond its configured maximum or minimum
bound</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="checkQuotas()">
<h3>checkQuotas</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">checkQuotas</span>()</div>
<div class="block">Check if we have violated our quota for any metric that has a configured quota</div>
</section>
</li>
<li>
<section class="detail" id="checkQuotas(long)">
<h3>checkQuotas</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">checkQuotas</span><wbr><span class="parameters">(long&nbsp;timeMs)</span></div>
</section>
</li>
<li>
<section class="detail" id="add(org.apache.kafka.common.metrics.CompoundStat)">
<h3>add</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">add</span><wbr><span class="parameters">(<a href="CompoundStat.html" title="interface in org.apache.kafka.common.metrics">CompoundStat</a>&nbsp;stat)</span></div>
<div class="block">Register a compound statistic with this sensor with no config override</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>stat</code> - The stat to register</dd>
<dt>Returns:</dt>
<dd>true if stat is added to sensor, false if sensor is expired</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="add(org.apache.kafka.common.metrics.CompoundStat,org.apache.kafka.common.metrics.MetricConfig)">
<h3>add</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">add</span><wbr><span class="parameters">(<a href="CompoundStat.html" title="interface in org.apache.kafka.common.metrics">CompoundStat</a>&nbsp;stat,
<a href="MetricConfig.html" title="class in org.apache.kafka.common.metrics">MetricConfig</a>&nbsp;config)</span></div>
<div class="block">Register a compound statistic with this sensor which yields multiple measurable quantities (like a histogram)</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>stat</code> - The stat to register</dd>
<dd><code>config</code> - The configuration for this stat. If null then the stat will use the default configuration for this
sensor.</dd>
<dt>Returns:</dt>
<dd>true if stat is added to sensor, false if sensor is expired</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="add(org.apache.kafka.common.MetricName,org.apache.kafka.common.metrics.MeasurableStat)">
<h3>add</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">add</span><wbr><span class="parameters">(<a href="../MetricName.html" title="class in org.apache.kafka.common">MetricName</a>&nbsp;metricName,
<a href="MeasurableStat.html" title="interface in org.apache.kafka.common.metrics">MeasurableStat</a>&nbsp;stat)</span></div>
<div class="block">Register a metric with this sensor</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>metricName</code> - The name of the metric</dd>
<dd><code>stat</code> - The statistic to keep</dd>
<dt>Returns:</dt>
<dd>true if metric is added to sensor, false if sensor is expired</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="add(org.apache.kafka.common.MetricName,org.apache.kafka.common.metrics.MeasurableStat,org.apache.kafka.common.metrics.MetricConfig)">
<h3>add</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">add</span><wbr><span class="parameters">(<a href="../MetricName.html" title="class in org.apache.kafka.common">MetricName</a>&nbsp;metricName,
<a href="MeasurableStat.html" title="interface in org.apache.kafka.common.metrics">MeasurableStat</a>&nbsp;stat,
<a href="MetricConfig.html" title="class in org.apache.kafka.common.metrics">MetricConfig</a>&nbsp;config)</span></div>
<div class="block">Register a metric with this sensor</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>metricName</code> - The name of the metric</dd>
<dd><code>stat</code> - The statistic to keep</dd>
<dd><code>config</code> - A special configuration for this metric. If null use the sensor default configuration.</dd>
<dt>Returns:</dt>
<dd>true if metric is added to sensor, false if sensor is expired</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="hasMetrics()">
<h3>hasMetrics</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">hasMetrics</span>()</div>
<div class="block">Return if metrics were registered with this sensor.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>true if metrics were registered, false otherwise</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="hasExpired()">
<h3>hasExpired</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">hasExpired</span>()</div>
<div class="block">Return true if the Sensor is eligible for removal due to inactivity.
false otherwise</div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>