org.apache.spark.sql.connector.read.streaming

Interface ReportsSourceMetrics

All Superinterfaces:

SparkDataStream

@Evolving
public interface ReportsSourceMetrics
extends SparkDataStream

A mix-in interface for SparkDataStream streaming sources to signal that they can report metrics.

Since:

3.2.0

Method Summary

Modifier and Type	Method and Description
java.util.Map<String,String>	metrics(java.util.Optional<Offset> latestConsumedOffset) Returns the metrics reported by the streaming source with respect to the latest consumed offset.

Methods inherited from interface org.apache.spark.sql.connector.read.streaming.SparkDataStream

commit, deserializeOffset, initialOffset, stop

Method Detail

metrics

java.util.Map<String,String> metrics(java.util.Optional<Offset> latestConsumedOffset)

Returns the metrics reported by the streaming source with respect to the latest consumed offset.

Parameters:

latestConsumedOffset - the end offset (exclusive) of the latest triggered batch.