KafkaMetric (clients 7.9.5-ce API)

java.lang.Object
- org.apache.kafka.common.metrics.KafkaMetric

All Implemented Interfaces:: Metric

public final class KafkaMetric
extends Object
implements Metric

Constructor Summary

Constructors
Constructor and Description
`KafkaMetric(Object lock, MetricName metricName, MetricValueProvider<?> valueProvider, MetricConfig config, org.apache.kafka.common.utils.Time time)` Create a metric to monitor an object that implements MetricValueProvider.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MetricConfig`	`config()` Get the configuration of this metric.
`void`	`config(MetricConfig config)` Set the metric config.
`boolean`	`isMeasurable()` The method determines if the metric value provider is of type Measurable.
`Measurable`	`measurable()` Get the underlying metric provider, which should be a `Measurable`
`double`	`measurableValue(long timeMs)` Take the metric and return the value, where the underlying metric provider should be a `Measurable`
`MetricName`	`metricName()` Get the metric name
`Object`	`metricValue()` Take the metric and return the value, which could be a `Measurable` or a `Gauge`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - KafkaMetric
```
public KafkaMetric(Object lock,
                   MetricName metricName,
                   MetricValueProvider<?> valueProvider,
                   MetricConfig config,
                   org.apache.kafka.common.utils.Time time)
```
    Create a metric to monitor an object that implements MetricValueProvider.
    Parameters:
    lock - The lock used to prevent race condition
    metricName - The name of the metric
    valueProvider - The metric value provider associated with this metric
    config - The configuration of the metric
    time - The time instance to use with the metrics
- Method Detail
  - config
```
public MetricConfig config()
```
    Get the configuration of this metric. This is supposed to be used by server only.
    Returns:
    Return the config of this metric
  - metricName
```
public MetricName metricName()
```
    Get the metric name
    Specified by:
    metricName in interface Metric
    Returns:
    Return the name of this metric
  - metricValue
```
public Object metricValue()
```
    Take the metric and return the value, which could be a Measurable or a Gauge
    Specified by:
    metricValue in interface Metric
    Returns:
    Return the metric value
    Throws:
    IllegalStateException - if the underlying metric is not a Measurable or a Gauge.
  - isMeasurable
```
public boolean isMeasurable()
```
    The method determines if the metric value provider is of type Measurable.
    Returns:
    true if the metric value provider is of type Measurable, false otherwise.
  - measurable
```
public Measurable measurable()
```
    Get the underlying metric provider, which should be a Measurable
    Returns:
    Return the metric provider
    Throws:
    IllegalStateException - if the underlying metric is not a Measurable.
  - measurableValue
```
public double measurableValue(long timeMs)
```
    Take the metric and return the value, where the underlying metric provider should be a Measurable
    Parameters:
    timeMs - The time that this metric is taken
    Returns:
    Return the metric value if it's measurable, otherwise 0
  - config
```
public void config(MetricConfig config)
```
    Set the metric config. This is supposed to be used by server only.
    Parameters:
    config - configuration for this metrics

Class KafkaMetric

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

KafkaMetric

Method Detail

config

metricName

metricValue

isMeasurable

measurable

measurableValue

config