com.opendxl.databus.consumer.metric

Class ConsumerMetricsBuilder

java.lang.Object

com.opendxl.databus.consumer.metric.ConsumerMetricsBuilder

public class ConsumerMetricsBuilder
extends java.lang.Object

ConsumerMetricsBuilder. This class is responsible to build a ConsumerMetric instance.
ConsumerMetricsBuilder can build three consumer metrics:

1. ClientIdMetric: a ConsumerMetricPerClientId which gives a result value related to metric associated to the clientId.
2. ClientIdTopicMetric: a ConsumerMetricPerClientIdAndTopics which gives a result value related to metric associated to the clientId and a specific topic.
3. ClientIdTopicPartitionMetric: a ConsumerMetricPerClientIdAndTopicPartitions which gives a result value related to metric associated to the clientId and a specific topic and partition.

Method Summary

Modifier and Type	Method and Description
static ConsumerMetricPerClientId	buildClientMetric(java.util.Map<MetricName,? extends org.apache.kafka.common.Metric> metrics, java.lang.String metricAttributeName, java.lang.String clientId) This method builds an instance of a ConsumerMetricPerClientId which gives a result value related to metric associated to the clientId.
static ConsumerMetricPerClientIdAndTopics	buildClientTopicMetric(java.util.Map<MetricName,? extends org.apache.kafka.common.Metric> metrics, java.lang.String metricAttributeName, java.lang.String clientId, java.util.List<TopicPartition> topics) This method builds an instance of a ConsumerMetricPerClientIdAndTopics which gives a resultvalue related to metric associated to an specific topic provided as a parameter associated to the clientId.
static ConsumerMetricPerClientIdAndTopicPartitions	buildClientTopicPartitionMetric(java.util.Map<MetricName,? extends org.apache.kafka.common.Metric> metrics, java.lang.String metricAttributeName, java.lang.String clientId, java.util.List<TopicPartition> topicPartitions) This method builds an instance of a ConsumerMetricPerClientIdAndTopicPartitions which gives a result value related to metric associated to an specific topic-partition provided as a parameter associated to the clientId.

Methods inherited from class java.lang.Object

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

Method Detail

buildClientMetric

public static ConsumerMetricPerClientId buildClientMetric(java.util.Map<MetricName,? extends org.apache.kafka.common.Metric> metrics,
                                                          java.lang.String metricAttributeName,
                                                          java.lang.String clientId)

This method builds an instance of a ConsumerMetricPerClientId which gives a result value related to metric associated to the clientId.

Parameters:

metrics - The Kafka list metrics.

metricAttributeName - The name of the Kafka metric that will be measured.

clientId - The clientId associated to the consumer.

Returns:

A ConsumerMetricPerClientId instance.

buildClientTopicMetric

public static ConsumerMetricPerClientIdAndTopics buildClientTopicMetric(java.util.Map<MetricName,? extends org.apache.kafka.common.Metric> metrics,
                                                                        java.lang.String metricAttributeName,
                                                                        java.lang.String clientId,
                                                                        java.util.List<TopicPartition> topics)

This method builds an instance of a ConsumerMetricPerClientIdAndTopics which gives a resultvalue related to metric associated to an specific topic provided as a parameter associated to the clientId.

Parameters:

metrics - The Kafka list metrics.

metricAttributeName - The name of the Kafka metric that will be measured.

clientId - The clientId associated to the consumer.

topics - The topicPartition which contains the topic name.

Returns:

A ConsumerMetricPerClientIdAndTopics instance.

buildClientTopicPartitionMetric

public static ConsumerMetricPerClientIdAndTopicPartitions buildClientTopicPartitionMetric(java.util.Map<MetricName,? extends org.apache.kafka.common.Metric> metrics,
                                                                                          java.lang.String metricAttributeName,
                                                                                          java.lang.String clientId,
                                                                                          java.util.List<TopicPartition> topicPartitions)

This method builds an instance of a ConsumerMetricPerClientIdAndTopicPartitions which gives a result value related to metric associated to an specific topic-partition provided as a parameter associated to the clientId.

Parameters:

metrics - The Kafka list metrics.

metricAttributeName - The name of the Kafka metric that will be measured.

clientId - The clientId associated to the consumer.

topicPartitions - The topicPartitions which contains the topic-partition asociated.

Returns:

A ConsumerMetricPerClientIdAndTopics instance.