Package org.apache.flink.connector.kafka.dynamic.source.metrics

Class KafkaClusterMetricGroup

java.lang.Object

org.apache.flink.connector.kafka.dynamic.source.metrics.KafkaClusterMetricGroup

All Implemented Interfaces:

org.apache.flink.metrics.groups.OperatorMetricGroup, org.apache.flink.metrics.groups.SourceReaderMetricGroup, org.apache.flink.metrics.MetricGroup

@Internal
public class KafkaClusterMetricGroup
extends Object
implements org.apache.flink.metrics.groups.SourceReaderMetricGroup

A custom proxy metric group in order to group KafkaSourceReaderMetrics by Kafka cluster.

Reports pending records per cluster under DynamicKafkaSource metric group, motivated by standardized connector metrics: https://cwiki.apache.org/confluence/display/FLINK/FLIP-33%3A+Standardize+Connector+Metrics.

Field Summary

Fields

Modifier and Type	Field	Description
static String	DYNAMIC_KAFKA_SOURCE_METRIC_GROUP
static String	KAFKA_CLUSTER_GROUP_NAME

Constructor Summary

Constructors

Constructor	Description
KafkaClusterMetricGroup(org.apache.flink.metrics.MetricGroup dynamicKafkaSourceMetricGroup, org.apache.flink.metrics.groups.SourceReaderMetricGroup delegateSourceReaderMetricGroup, String kafkaClusterId)

Method Summary

Modifier and Type	Method	Description
org.apache.flink.metrics.MetricGroup	addGroup(String name)
org.apache.flink.metrics.MetricGroup	addGroup(String key, String value)
org.apache.flink.metrics.Counter	counter(String name)
<C extends org.apache.flink.metrics.Counter> C	counter(String name, C counter)
<T,G extends org.apache.flink.metrics.Gauge<T>> G	gauge(String name, G gauge)
Map<String,String>	getAllVariables()
org.apache.flink.metrics.groups.OperatorIOMetricGroup	getIOMetricGroup()
String	getMetricIdentifier(String metricName)
String	getMetricIdentifier(String metricName, org.apache.flink.metrics.CharacterFilter filter)
org.apache.flink.metrics.Counter	getNumRecordsInErrorsCounter()
String[]	getScopeComponents()
<H extends org.apache.flink.metrics.Histogram> H	histogram(String name, H histogram)
<M extends org.apache.flink.metrics.Meter> M	meter(String name, M meter)
void	setPendingBytesGauge(org.apache.flink.metrics.Gauge<Long> gauge)
void	setPendingRecordsGauge(org.apache.flink.metrics.Gauge<Long> pendingRecordsGauge)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.metrics.MetricGroup

addGroup, addSpan, counter, counter, gauge, histogram, meter

Field Detail

DYNAMIC_KAFKA_SOURCE_METRIC_GROUP

public static final String DYNAMIC_KAFKA_SOURCE_METRIC_GROUP

See Also:

Constant Field Values

KAFKA_CLUSTER_GROUP_NAME

public static final String KAFKA_CLUSTER_GROUP_NAME

See Also:

Constant Field Values

Constructor Detail

KafkaClusterMetricGroup

public KafkaClusterMetricGroup(org.apache.flink.metrics.MetricGroup dynamicKafkaSourceMetricGroup,
                               org.apache.flink.metrics.groups.SourceReaderMetricGroup delegateSourceReaderMetricGroup,
                               String kafkaClusterId)

Method Detail

getNumRecordsInErrorsCounter

public org.apache.flink.metrics.Counter getNumRecordsInErrorsCounter()

Specified by:

getNumRecordsInErrorsCounter in interface org.apache.flink.metrics.groups.SourceReaderMetricGroup

setPendingBytesGauge

public void setPendingBytesGauge(org.apache.flink.metrics.Gauge<Long> gauge)

Specified by:

setPendingBytesGauge in interface org.apache.flink.metrics.groups.SourceReaderMetricGroup

setPendingRecordsGauge

public void setPendingRecordsGauge(org.apache.flink.metrics.Gauge<Long> pendingRecordsGauge)

Specified by:

setPendingRecordsGauge in interface org.apache.flink.metrics.groups.SourceReaderMetricGroup

getIOMetricGroup

public org.apache.flink.metrics.groups.OperatorIOMetricGroup getIOMetricGroup()

Specified by:

getIOMetricGroup in interface org.apache.flink.metrics.groups.OperatorMetricGroup

counter

public org.apache.flink.metrics.Counter counter(String name)

Specified by:

counter in interface org.apache.flink.metrics.MetricGroup

counter

public <C extends org.apache.flink.metrics.Counter> C counter(String name,
                                                              C counter)

Specified by:

counter in interface org.apache.flink.metrics.MetricGroup

gauge

public <T,G extends org.apache.flink.metrics.Gauge<T>> G gauge(String name,
                                                                     G gauge)

Specified by:

gauge in interface org.apache.flink.metrics.MetricGroup

histogram

public <H extends org.apache.flink.metrics.Histogram> H histogram(String name,
                                                                  H histogram)

Specified by:

histogram in interface org.apache.flink.metrics.MetricGroup

meter

public <M extends org.apache.flink.metrics.Meter> M meter(String name,
                                                          M meter)

Specified by:

meter in interface org.apache.flink.metrics.MetricGroup

addGroup

public org.apache.flink.metrics.MetricGroup addGroup(String name)

Specified by:

addGroup in interface org.apache.flink.metrics.MetricGroup

addGroup

public org.apache.flink.metrics.MetricGroup addGroup(String key,
                                                     String value)

Specified by:

addGroup in interface org.apache.flink.metrics.MetricGroup

getScopeComponents

public String[] getScopeComponents()

Specified by:

getScopeComponents in interface org.apache.flink.metrics.MetricGroup

getAllVariables

public Map<String,String> getAllVariables()

Specified by:

getAllVariables in interface org.apache.flink.metrics.MetricGroup

getMetricIdentifier

public String getMetricIdentifier(String metricName)

Specified by:

getMetricIdentifier in interface org.apache.flink.metrics.MetricGroup

getMetricIdentifier

public String getMetricIdentifier(String metricName,
                                  org.apache.flink.metrics.CharacterFilter filter)

Specified by:

getMetricIdentifier in interface org.apache.flink.metrics.MetricGroup