Package org.apache.kafka.streams

Class LagInfo

java.lang.Object
org.apache.kafka.streams.LagInfo
public class LagInfo
extends Object
Encapsulates information about lag, at a store partition replica (active or standby). This information is constantly changing as the tasks process records and thus, they should be treated as simply instantaenous measure of lag.

  • Method Summary

    Modifier and Type Method Description
    long currentOffsetPosition()
    Get the current maximum offset on the store partition's changelog topic, that has been successfully written into the store partition's state store.
    long endOffsetPosition()
    Get the end offset position for this store partition's changelog topic on the Kafka brokers.
    boolean equals​(Object obj)  
    int hashCode()  
    long offsetLag()
    Get the measured lag between current and end offset positions, for this store partition replica
    String toString()  

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Method Details

    • currentOffsetPosition

      public long currentOffsetPosition()
      Get the current maximum offset on the store partition's changelog topic, that has been successfully written into the store partition's state store.
      Returns:
      current consume offset for standby/restoring store partitions & simply endoffset for active store partition replicas

    • endOffsetPosition

      public long endOffsetPosition()
      Get the end offset position for this store partition's changelog topic on the Kafka brokers.
      Returns:
      last offset written to the changelog topic partition

    • offsetLag

      public long offsetLag()
      Get the measured lag between current and end offset positions, for this store partition replica
      Returns:
      lag as measured by message offsets

    • equals

      public boolean equals​(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object