com.opendxl.databus.producer.metric

Class ProducerMetric

java.lang.Object

com.opendxl.databus.producer.metric.ProducerMetric

public class ProducerMetric
extends java.lang.Object

ProducerMetric. This class is responsible for handling a Kafka producer metric.
ProducerMetric provides and abstraction to get a Kafka metric related to the producer.
ProducerMetric contains 3 attributes:

1. metricName: an specific metric that maps with a Kafka metric.
2. clientId: is a String which contains the clientId associated to the producer.
3. value: the value associated to the metric.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClientId() Get the metric clientId.
java.lang.String	getMetricDescription() Get the metric description.
java.lang.String	getMetricGroup() Get the metric group.
java.lang.String	getMetricName() Get the metric name.
java.util.Map<java.lang.String,java.lang.String>	getMetricTags() Get the metric tags.
double	getValue() Get the value of the metric.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getValue

public double getValue()

Get the value of the metric.

Returns:

The metric's value.

getMetricName

public java.lang.String getMetricName()

Get the metric name.

Returns:

The metric's name.

getMetricDescription

public java.lang.String getMetricDescription()

Get the metric description.

Returns:

The metric's description.

getMetricGroup

public java.lang.String getMetricGroup()

Get the metric group.

Returns:

The metric's group.

getMetricTags

public java.util.Map<java.lang.String,java.lang.String> getMetricTags()

Get the metric tags.

Returns:

The metric's tags.

getClientId

public java.lang.String getClientId()

Get the metric clientId.

Returns:

The metric's clientId.