| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>StreamsMetrics (kafka 3.0.2 API)</title> |
| <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 data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "alt-color"; |
| var rowColor = "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">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" 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> <a href="package-summary.html">org.apache.kafka.streams</a></div> |
| <h1 title="Interface StreamsMetrics" class="title">Interface StreamsMetrics</h1> |
| </div> |
| <section class="description"> |
| <hr> |
| <pre>public interface <span class="type-name-label">StreamsMetrics</span></pre> |
| <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 class="member-summary" id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" id="t0" class="active-table-tab">All Methods</button><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t2" class="table-tab" onclick="show(2);">Instance Methods</button><button role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" id="t3" class="table-tab" onclick="show(4);">Abstract Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <table class="summary-table" aria-labelledby="t0"> |
| <thead> |
| <tr> |
| <th class="col-first" scope="col">Modifier and Type</th> |
| <th class="col-second" scope="col">Method</th> |
| <th class="col-last" scope="col">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr class="alt-color" id="i0"> |
| <td class="col-first"><code><a href="../common/metrics/Sensor.html" title="class in org.apache.kafka.common.metrics">Sensor</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#addLatencyRateTotalSensor(java.lang.String,java.lang.String,java.lang.String,org.apache.kafka.common.metrics.Sensor.RecordingLevel,java.lang.String...)">addLatencyRateTotalSensor</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> scopeName, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> entityName, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> operationName, |
| <a href="../common/metrics/Sensor.RecordingLevel.html" title="enum in org.apache.kafka.common.metrics">Sensor.RecordingLevel</a> recordingLevel, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>... tags)</code></th> |
| <td class="col-last"> |
| <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> |
| </td> |
| </tr> |
| <tr class="row-color" id="i1"> |
| <td class="col-first"><code><a href="../common/metrics/Sensor.html" title="class in org.apache.kafka.common.metrics">Sensor</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#addRateTotalSensor(java.lang.String,java.lang.String,java.lang.String,org.apache.kafka.common.metrics.Sensor.RecordingLevel,java.lang.String...)">addRateTotalSensor</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> scopeName, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> entityName, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> operationName, |
| <a href="../common/metrics/Sensor.RecordingLevel.html" title="enum in org.apache.kafka.common.metrics">Sensor.RecordingLevel</a> recordingLevel, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>... tags)</code></th> |
| <td class="col-last"> |
| <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> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i2"> |
| <td class="col-first"><code><a href="../common/metrics/Sensor.html" title="class in org.apache.kafka.common.metrics">Sensor</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#addSensor(java.lang.String,org.apache.kafka.common.metrics.Sensor.RecordingLevel)">addSensor</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="../common/metrics/Sensor.RecordingLevel.html" title="enum in org.apache.kafka.common.metrics">Sensor.RecordingLevel</a> recordingLevel)</code></th> |
| <td class="col-last"> |
| <div class="block">Generic method to create a sensor.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i3"> |
| <td class="col-first"><code><a href="../common/metrics/Sensor.html" title="class in org.apache.kafka.common.metrics">Sensor</a></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#addSensor(java.lang.String,org.apache.kafka.common.metrics.Sensor.RecordingLevel,org.apache.kafka.common.metrics.Sensor...)">addSensor</a></span>​(<a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="../common/metrics/Sensor.RecordingLevel.html" title="enum in org.apache.kafka.common.metrics">Sensor.RecordingLevel</a> recordingLevel, |
| <a href="../common/metrics/Sensor.html" title="class in org.apache.kafka.common.metrics">Sensor</a>... parents)</code></th> |
| <td class="col-last"> |
| <div class="block">Generic method to create a sensor with parent sensors.</div> |
| </td> |
| </tr> |
| <tr class="alt-color" id="i4"> |
| <td class="col-first"><code><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../common/MetricName.html" title="class in org.apache.kafka.common">MetricName</a>,​? extends <a href="../common/Metric.html" title="interface in org.apache.kafka.common">Metric</a>></code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#metrics()">metrics</a></span>()</code></th> |
| <td class="col-last"> |
| <div class="block">Get read-only handle on global metrics registry.</div> |
| </td> |
| </tr> |
| <tr class="row-color" id="i5"> |
| <td class="col-first"><code>void</code></td> |
| <th class="col-second" scope="row"><code><span class="member-name-link"><a href="#removeSensor(org.apache.kafka.common.metrics.Sensor)">removeSensor</a></span>​(<a href="../common/metrics/Sensor.html" title="class in org.apache.kafka.common.metrics">Sensor</a> sensor)</code></th> |
| <td class="col-last"> |
| <div class="block">Remove a sensor.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </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/15/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="../common/MetricName.html" title="class in org.apache.kafka.common">MetricName</a>,​? extends <a href="../common/Metric.html" title="interface in org.apache.kafka.common">Metric</a>></span> <span class="member-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> <span class="member-name">addLatencyRateTotalSensor</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> scopeName, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> entityName, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> operationName, |
| <a href="../common/metrics/Sensor.RecordingLevel.html" title="enum in org.apache.kafka.common.metrics">Sensor.RecordingLevel</a> recordingLevel, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>... 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><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>, |
| <a href="#removeSensor(org.apache.kafka.common.metrics.Sensor)"><code>removeSensor(Sensor)</code></a>, |
| <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></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> <span class="member-name">addRateTotalSensor</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> scopeName, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> entityName, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> operationName, |
| <a href="../common/metrics/Sensor.RecordingLevel.html" title="enum in org.apache.kafka.common.metrics">Sensor.RecordingLevel</a> recordingLevel, |
| <a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>... 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><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>, |
| <a href="#removeSensor(org.apache.kafka.common.metrics.Sensor)"><code>removeSensor(Sensor)</code></a>, |
| <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></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> <span class="member-name">addSensor</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="../common/metrics/Sensor.RecordingLevel.html" title="enum in org.apache.kafka.common.metrics">Sensor.RecordingLevel</a> 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><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>, |
| <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>, |
| <a href="#removeSensor(org.apache.kafka.common.metrics.Sensor)"><code>removeSensor(Sensor)</code></a></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> <span class="member-name">addSensor</span>​(<span class="parameters"><a href="https://docs.oracle.com/en/java/javase/15/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> name, |
| <a href="../common/metrics/Sensor.RecordingLevel.html" title="enum in org.apache.kafka.common.metrics">Sensor.RecordingLevel</a> recordingLevel, |
| <a href="../common/metrics/Sensor.html" title="class in org.apache.kafka.common.metrics">Sensor</a>... 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><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>, |
| <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>, |
| <a href="#removeSensor(org.apache.kafka.common.metrics.Sensor)"><code>removeSensor(Sensor)</code></a></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> <span class="member-name">removeSensor</span>​(<span class="parameters"><a href="../common/metrics/Sensor.html" title="class in org.apache.kafka.common.metrics">Sensor</a> 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> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottom-nav" id="navbar.bottom"> |
| <div class="skip-nav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar.bottom.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">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| </div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <span class="skip-nav" id="skip.navbar.bottom"> |
| <!-- --> |
| </span></nav> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
