Google Git
Sign in
apache / kafka-site / asf-site / . / 35 / javadoc / org / apache / kafka / streams / StreamsMetrics.html
blob: 17b2cbb2023753df93dd9bee9c249df941d24d2d [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>StreamsMetrics (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.streams, interface: StreamsMetrics">
<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.streams</a></div>
<h1 title="Interface StreamsMetrics" class="title">Interface StreamsMetrics</h1>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">StreamsMetrics</span></div>
<div class="block">The Kafka Streams metrics interface for adding metric sensors and collecting metric values.</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></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><a href="../common/metrics/Sensor.html" title="class in org.apache.kafka.common.metrics">Sensor</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#addLatencyRateTotalSensor(java.lang.String,java.lang.String,java.lang.String,org.apache.kafka.common.metrics.Sensor.RecordingLevel,java.lang.String...)" class="member-name-link">addLatencyRateTotalSensor</a><wbr>(<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>&nbsp;scopeName,
<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>&nbsp;entityName,
<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>&nbsp;operationName,
<a href="../common/metrics/Sensor.RecordingLevel.html" title="enum class in org.apache.kafka.common.metrics">Sensor.RecordingLevel</a>&nbsp;recordingLevel,
<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>...&nbsp;tags)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Add a latency, rate and total sensor for a specific operation, which will include the following metrics:
average latency
max latency
invocation rate (num.operations / seconds)
total invocation count
Whenever a user records this sensor via <a href="../common/metrics/Sensor.html#record(double)"><code>Sensor.record(double)</code></a> etc, it will be counted as one invocation
of the operation, and hence the rate / count metrics will be updated accordingly; and the recorded latency value
will be used to update the average / max latency as well.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../common/metrics/Sensor.html" title="class in org.apache.kafka.common.metrics">Sensor</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#addRateTotalSensor(java.lang.String,java.lang.String,java.lang.String,org.apache.kafka.common.metrics.Sensor.RecordingLevel,java.lang.String...)" class="member-name-link">addRateTotalSensor</a><wbr>(<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>&nbsp;scopeName,
<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>&nbsp;entityName,
<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>&nbsp;operationName,
<a href="../common/metrics/Sensor.RecordingLevel.html" title="enum class in org.apache.kafka.common.metrics">Sensor.RecordingLevel</a>&nbsp;recordingLevel,
<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>...&nbsp;tags)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Add a rate and a total sensor for a specific operation, which will include the following metrics:
invocation rate (num.operations / time unit)
total invocation count
Whenever a user records this sensor via <a href="../common/metrics/Sensor.html#record(double)"><code>Sensor.record(double)</code></a> etc,
it will be counted as one invocation of the operation, and hence the rate / count metrics will be updated accordingly.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../common/metrics/Sensor.html" title="class in org.apache.kafka.common.metrics">Sensor</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#addSensor(java.lang.String,org.apache.kafka.common.metrics.Sensor.RecordingLevel)" class="member-name-link">addSensor</a><wbr>(<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>&nbsp;name,
<a href="../common/metrics/Sensor.RecordingLevel.html" title="enum class in org.apache.kafka.common.metrics">Sensor.RecordingLevel</a>&nbsp;recordingLevel)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Generic method to create a sensor.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="../common/metrics/Sensor.html" title="class in org.apache.kafka.common.metrics">Sensor</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#addSensor(java.lang.String,org.apache.kafka.common.metrics.Sensor.RecordingLevel,org.apache.kafka.common.metrics.Sensor...)" class="member-name-link">addSensor</a><wbr>(<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>&nbsp;name,
<a href="../common/metrics/Sensor.RecordingLevel.html" title="enum class in org.apache.kafka.common.metrics">Sensor.RecordingLevel</a>&nbsp;recordingLevel,
<a href="../common/metrics/Sensor.html" title="class in org.apache.kafka.common.metrics">Sensor</a>...&nbsp;parents)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Generic method to create a sensor with parent sensors.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><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="../common/MetricName.html" title="class in org.apache.kafka.common">MetricName</a>,<wbr>? extends <a href="../common/Metric.html" title="interface in org.apache.kafka.common">Metric</a>&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#metrics()" class="member-name-link">metrics</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Get read-only handle on global metrics registry.</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="#removeSensor(org.apache.kafka.common.metrics.Sensor)" class="member-name-link">removeSensor</a><wbr>(<a href="../common/metrics/Sensor.html" title="class in org.apache.kafka.common.metrics">Sensor</a>&nbsp;sensor)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Remove a sensor.</div>
</div>
</div>
</div>
</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="metrics()">
<h3>metrics</h3>
<div class="member-signature"><span class="return-type"><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="../common/MetricName.html" title="class in org.apache.kafka.common">MetricName</a>,<wbr>? extends <a href="../common/Metric.html" title="interface in org.apache.kafka.common">Metric</a>&gt;</span>&nbsp;<span class="element-name">metrics</span>()</div>
<div class="block">Get read-only handle on global metrics registry.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>Map of all metrics.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="addLatencyRateTotalSensor(java.lang.String,java.lang.String,java.lang.String,org.apache.kafka.common.metrics.Sensor.RecordingLevel,java.lang.String...)">
<h3>addLatencyRateTotalSensor</h3>
<div class="member-signature"><span class="return-type"><a href="../common/metrics/Sensor.html" title="class in org.apache.kafka.common.metrics">Sensor</a></span>&nbsp;<span class="element-name">addLatencyRateTotalSensor</span><wbr><span class="parameters">(<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>&nbsp;scopeName,
<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>&nbsp;entityName,
<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>&nbsp;operationName,
<a href="../common/metrics/Sensor.RecordingLevel.html" title="enum class in org.apache.kafka.common.metrics">Sensor.RecordingLevel</a>&nbsp;recordingLevel,
<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>...&nbsp;tags)</span></div>
<div class="block">Add a latency, rate and total sensor for a specific operation, which will include the following metrics:
<ol>
<li>average latency</li>
<li>max latency</li>
<li>invocation rate (num.operations / seconds)</li>
<li>total invocation count</li>
</ol>
Whenever a user records this sensor via <a href="../common/metrics/Sensor.html#record(double)"><code>Sensor.record(double)</code></a> etc, it will be counted as one invocation
of the operation, and hence the rate / count metrics will be updated accordingly; and the recorded latency value
will be used to update the average / max latency as well.
Note that you can add more metrics to this sensor after you created it, which can then be updated upon
<a href="../common/metrics/Sensor.html#record(double)"><code>Sensor.record(double)</code></a> calls.
The added sensor and its metrics can be removed with <a href="#removeSensor(org.apache.kafka.common.metrics.Sensor)"><code>removeSensor()</code></a>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>scopeName</code> - name of the scope, which will be used as part of the metric type, e.g.: "stream-[scope]-metrics".</dd>
<dd><code>entityName</code> - name of the entity, which will be used as part of the metric tags, e.g.: "[scope]-id" = "[entity]".</dd>
<dd><code>operationName</code> - name of the operation, which will be used as the name of the metric, e.g.: "[operation]-latency-avg".</dd>
<dd><code>recordingLevel</code> - the recording level (e.g., INFO or DEBUG) for this sensor.</dd>
<dd><code>tags</code> - additional tags of the sensor</dd>
<dt>Returns:</dt>
<dd>The added sensor.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="#addRateTotalSensor(java.lang.String,java.lang.String,java.lang.String,org.apache.kafka.common.metrics.Sensor.RecordingLevel,java.lang.String...)"><code>addRateTotalSensor(String, String, String, Sensor.RecordingLevel, String...)</code></a></li>
<li><a href="#removeSensor(org.apache.kafka.common.metrics.Sensor)"><code>removeSensor(Sensor)</code></a></li>
<li><a href="#addSensor(java.lang.String,org.apache.kafka.common.metrics.Sensor.RecordingLevel,org.apache.kafka.common.metrics.Sensor...)"><code>addSensor(String, Sensor.RecordingLevel, Sensor...)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="addRateTotalSensor(java.lang.String,java.lang.String,java.lang.String,org.apache.kafka.common.metrics.Sensor.RecordingLevel,java.lang.String...)">
<h3>addRateTotalSensor</h3>
<div class="member-signature"><span class="return-type"><a href="../common/metrics/Sensor.html" title="class in org.apache.kafka.common.metrics">Sensor</a></span>&nbsp;<span class="element-name">addRateTotalSensor</span><wbr><span class="parameters">(<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>&nbsp;scopeName,
<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>&nbsp;entityName,
<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>&nbsp;operationName,
<a href="../common/metrics/Sensor.RecordingLevel.html" title="enum class in org.apache.kafka.common.metrics">Sensor.RecordingLevel</a>&nbsp;recordingLevel,
<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>...&nbsp;tags)</span></div>
<div class="block">Add a rate and a total sensor for a specific operation, which will include the following metrics:
<ol>
<li>invocation rate (num.operations / time unit)</li>
<li>total invocation count</li>
</ol>
Whenever a user records this sensor via <a href="../common/metrics/Sensor.html#record(double)"><code>Sensor.record(double)</code></a> etc,
it will be counted as one invocation of the operation, and hence the rate / count metrics will be updated accordingly.
Note that you can add more metrics to this sensor after you created it, which can then be updated upon
<a href="../common/metrics/Sensor.html#record(double)"><code>Sensor.record(double)</code></a> calls.
The added sensor and its metrics can be removed with <a href="#removeSensor(org.apache.kafka.common.metrics.Sensor)"><code>removeSensor()</code></a>.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>scopeName</code> - name of the scope, which will be used as part of the metrics type, e.g.: "stream-[scope]-metrics".</dd>
<dd><code>entityName</code> - name of the entity, which will be used as part of the metric tags, e.g.: "[scope]-id" = "[entity]".</dd>
<dd><code>operationName</code> - name of the operation, which will be used as the name of the metric, e.g.: "[operation]-total".</dd>
<dd><code>recordingLevel</code> - the recording level (e.g., INFO or DEBUG) for this sensor.</dd>
<dd><code>tags</code> - additional tags of the sensor</dd>
<dt>Returns:</dt>
<dd>The added sensor.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="#addLatencyRateTotalSensor(java.lang.String,java.lang.String,java.lang.String,org.apache.kafka.common.metrics.Sensor.RecordingLevel,java.lang.String...)"><code>addLatencyRateTotalSensor(String, String, String, Sensor.RecordingLevel, String...)</code></a></li>
<li><a href="#removeSensor(org.apache.kafka.common.metrics.Sensor)"><code>removeSensor(Sensor)</code></a></li>
<li><a href="#addSensor(java.lang.String,org.apache.kafka.common.metrics.Sensor.RecordingLevel,org.apache.kafka.common.metrics.Sensor...)"><code>addSensor(String, Sensor.RecordingLevel, Sensor...)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="addSensor(java.lang.String,org.apache.kafka.common.metrics.Sensor.RecordingLevel)">
<h3>addSensor</h3>
<div class="member-signature"><span class="return-type"><a href="../common/metrics/Sensor.html" title="class in org.apache.kafka.common.metrics">Sensor</a></span>&nbsp;<span class="element-name">addSensor</span><wbr><span class="parameters">(<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>&nbsp;name,
<a href="../common/metrics/Sensor.RecordingLevel.html" title="enum class in org.apache.kafka.common.metrics">Sensor.RecordingLevel</a>&nbsp;recordingLevel)</span></div>
<div class="block">Generic method to create a sensor.
Note that for most cases it is advisable to use
<a href="#addRateTotalSensor(java.lang.String,java.lang.String,java.lang.String,org.apache.kafka.common.metrics.Sensor.RecordingLevel,java.lang.String...)"><code>addRateTotalSensor()</code></a>
or <a href="#addLatencyRateTotalSensor(java.lang.String,java.lang.String,java.lang.String,org.apache.kafka.common.metrics.Sensor.RecordingLevel,java.lang.String...)"><code>addLatencyRateTotalSensor()</code></a>
to ensure metric name well-formedness and conformity with the rest of the Kafka Streams code base.
However, if the above two methods are not sufficient, this method can also be used.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - name of the sensor.</dd>
<dd><code>recordingLevel</code> - the recording level (e.g., INFO or DEBUG) for this sensor</dd>
<dt>Returns:</dt>
<dd>The added sensor.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="#addRateTotalSensor(java.lang.String,java.lang.String,java.lang.String,org.apache.kafka.common.metrics.Sensor.RecordingLevel,java.lang.String...)"><code>addRateTotalSensor(String, String, String, Sensor.RecordingLevel, String...)</code></a></li>
<li><a href="#addLatencyRateTotalSensor(java.lang.String,java.lang.String,java.lang.String,org.apache.kafka.common.metrics.Sensor.RecordingLevel,java.lang.String...)"><code>addLatencyRateTotalSensor(String, String, String, Sensor.RecordingLevel, String...)</code></a></li>
<li><a href="#removeSensor(org.apache.kafka.common.metrics.Sensor)"><code>removeSensor(Sensor)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="addSensor(java.lang.String,org.apache.kafka.common.metrics.Sensor.RecordingLevel,org.apache.kafka.common.metrics.Sensor...)">
<h3>addSensor</h3>
<div class="member-signature"><span class="return-type"><a href="../common/metrics/Sensor.html" title="class in org.apache.kafka.common.metrics">Sensor</a></span>&nbsp;<span class="element-name">addSensor</span><wbr><span class="parameters">(<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>&nbsp;name,
<a href="../common/metrics/Sensor.RecordingLevel.html" title="enum class in org.apache.kafka.common.metrics">Sensor.RecordingLevel</a>&nbsp;recordingLevel,
<a href="../common/metrics/Sensor.html" title="class in org.apache.kafka.common.metrics">Sensor</a>...&nbsp;parents)</span></div>
<div class="block">Generic method to create a sensor with parent sensors.
Note that for most cases it is advisable to use
<a href="#addRateTotalSensor(java.lang.String,java.lang.String,java.lang.String,org.apache.kafka.common.metrics.Sensor.RecordingLevel,java.lang.String...)"><code>addRateTotalSensor()</code></a>
or <a href="#addLatencyRateTotalSensor(java.lang.String,java.lang.String,java.lang.String,org.apache.kafka.common.metrics.Sensor.RecordingLevel,java.lang.String...)"><code>addLatencyRateTotalSensor()</code></a>
to ensure metric name well-formedness and conformity with the rest of the Kafka Streams code base.
However, if the above two methods are not sufficient, this method can also be used.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - name of the sensor</dd>
<dd><code>recordingLevel</code> - the recording level (e.g., INFO or DEBUG) for this sensor</dd>
<dt>Returns:</dt>
<dd>The added sensor.</dd>
<dt>See Also:</dt>
<dd>
<ul class="see-list-long">
<li><a href="#addRateTotalSensor(java.lang.String,java.lang.String,java.lang.String,org.apache.kafka.common.metrics.Sensor.RecordingLevel,java.lang.String...)"><code>addRateTotalSensor(String, String, String, Sensor.RecordingLevel, String...)</code></a></li>
<li><a href="#addLatencyRateTotalSensor(java.lang.String,java.lang.String,java.lang.String,org.apache.kafka.common.metrics.Sensor.RecordingLevel,java.lang.String...)"><code>addLatencyRateTotalSensor(String, String, String, Sensor.RecordingLevel, String...)</code></a></li>
<li><a href="#removeSensor(org.apache.kafka.common.metrics.Sensor)"><code>removeSensor(Sensor)</code></a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="removeSensor(org.apache.kafka.common.metrics.Sensor)">
<h3>removeSensor</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">removeSensor</span><wbr><span class="parameters">(<a href="../common/metrics/Sensor.html" title="class in org.apache.kafka.common.metrics">Sensor</a>&nbsp;sensor)</span></div>
<div class="block">Remove a sensor.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>sensor</code> - sensor to be removed</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>