KafkaSourceReaderMetrics (Flink : Connectors : Kafka 1.17.1 API)

java.lang.Object
- org.apache.flink.connector.kafka.source.metrics.KafkaSourceReaderMetrics

```
@PublicEvolving
public class KafkaSourceReaderMetrics
extends Object
```
A collection class for handling metrics in KafkaSourceReader.
All metrics of Kafka source reader are registered under group "KafkaSourceReader", which is a child group of OperatorMetricGroup. Metrics related to a specific topic partition will be registered in the group "KafkaSourceReader.topic.{topic_name}.partition.{partition_id}".
For example, current consuming offset of topic "my-topic" and partition 1 will be reported in metric: "{some_parent_groups}.operator.KafkaSourceReader.topic.my-topic.partition.1.currentOffset"
and number of successful commits will be reported in metric: "{some_parent_groups}.operator.KafkaSourceReader.commitsSucceeded"
All metrics of Kafka consumer are also registered under group "KafkaSourceReader.KafkaConsumer". For example, Kafka consumer metric "records-consumed-total" can be found at: {some_parent_groups}.operator.KafkaSourceReader.KafkaConsumer.records-consumed-total"

字段概要

字段
限定符和类型	字段和说明
`static String`	`BYTES_CONSUMED_TOTAL`
`static String`	`COMMITS_FAILED_METRIC_COUNTER`
`static String`	`COMMITS_SUCCEEDED_METRIC_COUNTER`
`static String`	`COMMITTED_OFFSET_METRIC_GAUGE`
`static String`	`CONSUMER_FETCH_MANAGER_GROUP`
`static String`	`CURRENT_OFFSET_METRIC_GAUGE`
`static long`	`INITIAL_OFFSET`
`static String`	`KAFKA_CONSUMER_METRIC_GROUP`
`static String`	`KAFKA_SOURCE_READER_METRIC_GROUP`
`static String`	`PARTITION_GROUP`
`static String`	`RECORDS_LAG`
`static String`	`TOPIC_GROUP`

构造器概要

构造器
构造器和说明

KafkaSourceReaderMetrics(org.apache.flink.metrics.groups.SourceReaderMetricGroup sourceReaderMetricGroup)

构造器
构造器和说明
`KafkaSourceReaderMetrics(org.apache.flink.metrics.groups.SourceReaderMetricGroup sourceReaderMetricGroup)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`maybeAddRecordsLagMetric(org.apache.kafka.clients.consumer.KafkaConsumer<?,?> consumer, org.apache.kafka.common.TopicPartition tp)` Add a partition's records-lag metric to tracking list if this partition never appears before.
`void`	`recordCommittedOffset(org.apache.kafka.common.TopicPartition tp, long offset)` Update the latest committed offset of the given `TopicPartition`.
`void`	`recordCurrentOffset(org.apache.kafka.common.TopicPartition tp, long offset)` Update current consuming offset of the given `TopicPartition`.
`void`	`recordFailedCommit()` Mark a failure commit.
`void`	`recordSucceededCommit()` Mark a successful commit.
`void`	`registerKafkaConsumerMetrics(org.apache.kafka.clients.consumer.KafkaConsumer<?,?> kafkaConsumer)` Register metrics of KafkaConsumer in Kafka metric group.
`void`	`registerNumBytesIn(org.apache.kafka.clients.consumer.KafkaConsumer<?,?> consumer)` Register `MetricNames.IO_NUM_BYTES_IN`.
`void`	`registerTopicPartition(org.apache.kafka.common.TopicPartition tp)` Register metric groups for the given `TopicPartition`.
`void`	`removeRecordsLagMetric(org.apache.kafka.common.TopicPartition tp)` Remove a partition's records-lag metric from tracking list.
`void`	`updateNumBytesInCounter()` Update `MetricNames.IO_NUM_BYTES_IN`.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - KAFKA_SOURCE_READER_METRIC_GROUP
```
public static final String KAFKA_SOURCE_READER_METRIC_GROUP
```
    另请参阅:
    
    常量字段值
  - TOPIC_GROUP
```
public static final String TOPIC_GROUP
```
    另请参阅:
    
    常量字段值
  - PARTITION_GROUP
```
public static final String PARTITION_GROUP
```
    另请参阅:
    
    常量字段值
  - CURRENT_OFFSET_METRIC_GAUGE
```
public static final String CURRENT_OFFSET_METRIC_GAUGE
```
    另请参阅:
    
    常量字段值
  - COMMITTED_OFFSET_METRIC_GAUGE
```
public static final String COMMITTED_OFFSET_METRIC_GAUGE
```
    另请参阅:
    
    常量字段值
  - COMMITS_SUCCEEDED_METRIC_COUNTER
```
public static final String COMMITS_SUCCEEDED_METRIC_COUNTER
```
    另请参阅:
    
    常量字段值
  - COMMITS_FAILED_METRIC_COUNTER
```
public static final String COMMITS_FAILED_METRIC_COUNTER
```
    另请参阅:
    
    常量字段值
  - KAFKA_CONSUMER_METRIC_GROUP
```
public static final String KAFKA_CONSUMER_METRIC_GROUP
```
    另请参阅:
    
    常量字段值
  - CONSUMER_FETCH_MANAGER_GROUP
```
public static final String CONSUMER_FETCH_MANAGER_GROUP
```
    另请参阅:
    
    常量字段值
  - BYTES_CONSUMED_TOTAL
```
public static final String BYTES_CONSUMED_TOTAL
```
    另请参阅:
    
    常量字段值
  - RECORDS_LAG
```
public static final String RECORDS_LAG
```
    另请参阅:
    
    常量字段值
  - INITIAL_OFFSET
```
public static final long INITIAL_OFFSET
```
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - KafkaSourceReaderMetrics
```
public KafkaSourceReaderMetrics(org.apache.flink.metrics.groups.SourceReaderMetricGroup sourceReaderMetricGroup)
```
- 方法详细资料
  - registerKafkaConsumerMetrics
```
public void registerKafkaConsumerMetrics(org.apache.kafka.clients.consumer.KafkaConsumer<?,?> kafkaConsumer)
```
    Register metrics of KafkaConsumer in Kafka metric group.
    
    参数:
    
    kafkaConsumer - Kafka consumer used by partition split reader.
  - registerTopicPartition
```
public void registerTopicPartition(org.apache.kafka.common.TopicPartition tp)
```
    Register metric groups for the given TopicPartition.
    
    参数:
    
    tp - Registering topic partition
  - recordCurrentOffset
```
public void recordCurrentOffset(org.apache.kafka.common.TopicPartition tp,
                                long offset)
```
    Update current consuming offset of the given TopicPartition.
    
    参数:
    
    tp - Updating topic partition
    
    offset - Current consuming offset
  - recordCommittedOffset
```
public void recordCommittedOffset(org.apache.kafka.common.TopicPartition tp,
                                  long offset)
```
    Update the latest committed offset of the given TopicPartition.
    
    参数:
    
    tp - Updating topic partition
    
    offset - Committing offset
  - recordSucceededCommit
```
public void recordSucceededCommit()
```
    Mark a successful commit.
  - recordFailedCommit
```
public void recordFailedCommit()
```
    Mark a failure commit.
  - registerNumBytesIn
```
public void registerNumBytesIn(org.apache.kafka.clients.consumer.KafkaConsumer<?,?> consumer)
```
    Register MetricNames.IO_NUM_BYTES_IN.
    
    参数:
    
    consumer - Kafka consumer
  - maybeAddRecordsLagMetric
```
public void maybeAddRecordsLagMetric(org.apache.kafka.clients.consumer.KafkaConsumer<?,?> consumer,
                                     org.apache.kafka.common.TopicPartition tp)
```
    Add a partition's records-lag metric to tracking list if this partition never appears before.
    This method also lazily register MetricNames.PENDING_RECORDS in SourceReaderMetricGroup
    
    参数:
    
    consumer - Kafka consumer
    
    tp - Topic partition
  - removeRecordsLagMetric
```
public void removeRecordsLagMetric(org.apache.kafka.common.TopicPartition tp)
```
    Remove a partition's records-lag metric from tracking list.
    
    参数:
    
    tp - Unassigned topic partition
  - updateNumBytesInCounter
```
public void updateNumBytesInCounter()
```
    Update MetricNames.IO_NUM_BYTES_IN.
    Instead of simply setting OperatorIOMetricGroup.getNumBytesInCounter() to the same value as bytes-consumed-total from Kafka consumer, which will screw TaskIOMetricGroup.getNumBytesInCounter() if chained sources exist, we track the increment of bytes-consumed-total and count it towards the counter.

类 KafkaSourceReaderMetrics

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

KAFKA_SOURCE_READER_METRIC_GROUP

TOPIC_GROUP

PARTITION_GROUP

CURRENT_OFFSET_METRIC_GAUGE

COMMITTED_OFFSET_METRIC_GAUGE

COMMITS_SUCCEEDED_METRIC_COUNTER

COMMITS_FAILED_METRIC_COUNTER

KAFKA_CONSUMER_METRIC_GROUP

CONSUMER_FETCH_MANAGER_GROUP

BYTES_CONSUMED_TOTAL

RECORDS_LAG

INITIAL_OFFSET

构造器详细资料

KafkaSourceReaderMetrics

方法详细资料

registerKafkaConsumerMetrics

registerTopicPartition

recordCurrentOffset

recordCommittedOffset

recordSucceededCommit

recordFailedCommit

registerNumBytesIn

maybeAddRecordsLagMetric

removeRecordsLagMetric

updateNumBytesInCounter