Package com.linkedin.davinci.notifier

Interface VeniceNotifier

All Superinterfaces:
AutoCloseable, Closeable
All Known Implementing Classes:
ExceptionCaptorNotifier, IsolatedIngestionNotifier, LeaderFollowerIngestionProgressNotifier, LogNotifier, PushStatusNotifier, RelayNotifier, StateModelIngestionProgressNotifier
public interface VeniceNotifier extends Closeable
Interface for listening to Notifications for Store consumption.

  • Method Details

    • started

      default void started(String kafkaTopic, int partitionId)
      Consumption is started for a store and partition

    • started

      default void started(String kafkaTopic, int partitionId, String message)

    • restarted

      default void restarted(String kafkaTopic, int partitionId, PubSubPosition position)
      Consumption is restarted from given position for a store and partition

    • restarted

      default void restarted(String kafkaTopic, int partitionId, PubSubPosition position, String message)

    • progress

      default void progress(String kafkaTopic, int partitionId, PubSubPosition position)
      Periodic progress report of consumption for a store and partition.

    • progress

      default void progress(String kafkaTopic, int partitionId, PubSubPosition position, String message)

    • endOfPushReceived

      default void endOfPushReceived(String kafkaTopic, int partitionId, PubSubPosition position)
      The ControlMessageType.END_OF_PUSH control message was consumed.

      This is only emitted for Hybrid Stores, since Batch-Only Stores report completed(String, int, PubSubPosition) right away when getting the EOP.

    • endOfPushReceived

      default void endOfPushReceived(String kafkaTopic, int partitionId, PubSubPosition position, String message)

    • topicSwitchReceived

      default void topicSwitchReceived(String kafkaTopic, int partitionId, PubSubPosition position)
      The ControlMessageType.TOPIC_SWITCH control message was consumed.

      This is only emitted for Hybrid Stores using Leader/Follower model, after the report of endOfPushReceived(String, int, PubSubPosition) and before completed(String, int, PubSubPosition).

    • topicSwitchReceived

      default void topicSwitchReceived(String kafkaTopic, int partitionId, PubSubPosition position, String message)

    • dataRecoveryCompleted

      default void dataRecoveryCompleted(String kafkaTopic, int partitionId, PubSubPosition position, String message)

    • startOfIncrementalPushReceived

      default void startOfIncrementalPushReceived(String kafkaTopic, int partitionId, PubSubPosition position)
      Consumption is started for an incremental push

    • startOfIncrementalPushReceived

      default void startOfIncrementalPushReceived(String kafkaTopic, int partitionId, PubSubPosition position, String message)

    • endOfIncrementalPushReceived

      default void endOfIncrementalPushReceived(String kafkaTopic, int partitionId, PubSubPosition position)
      Consumption is completed for an incremental push

    • endOfIncrementalPushReceived

      default void endOfIncrementalPushReceived(String kafkaTopic, int partitionId, PubSubPosition position, String message)

    • batchEndOfIncrementalPushReceived

      default void batchEndOfIncrementalPushReceived(String kafkaTopic, int partitionId, PubSubPosition position, List<String> historicalIncPushes)

    • catchUpVersionTopicOffsetLag

      default void catchUpVersionTopicOffsetLag(String kafkaTopic, int partitionId)

    • completed

      default void completed(String kafkaTopic, int partitionId, PubSubPosition position)
      Consumption is completed for a store and partition.

    • completed

      default void completed(String kafkaTopic, int partitionId, PubSubPosition position, String message)

    • quotaViolated

      default void quotaViolated(String kafkaTopic, int partitionId, PubSubPosition position)
      Quota is violated for a store.

    • quotaViolated

      default void quotaViolated(String kafkaTopic, int partitionId, PubSubPosition position, String message)

    • quotaNotViolated

      default void quotaNotViolated(String kafkaTopic, int partitionId, PubSubPosition position)
      Quota is not violated for a store.

    • quotaNotViolated

      default void quotaNotViolated(String kafkaTopic, int partitionId, PubSubPosition position, String message)

    • close

      default void close()
      The Process is shutting down and clean up the resources associated with the Notifier. N.B. When implementing the method, make it idempotent.
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable

    • error

      default void error(String kafkaTopic, int partitionId, String message, Exception e)
      Report an error, during the consumption for a Partitions and store. The error may or may not be fatal.

    • stopped

      default void stopped(String kafkaTopic, int partitionId, PubSubPosition position)