Package com.linkedin.davinci.notifier

Interface VeniceNotifier

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

ExceptionCaptorNotifier, IsolatedIngestionNotifier, LeaderFollowerIngestionProgressNotifier, LogNotifier, PushStatusNotifier, RelayNotifier, StateModelIngestionProgressNotifier

public interface VeniceNotifier
extends java.io.Closeable

Interface for listening to Notifications for Store consumption.

Method Summary

Modifier and Type	Method	Description
default void	catchUpVersionTopicOffsetLag(java.lang.String kafkaTopic, int partitionId)
default void	close()	The Process is shutting down and clean up the resources associated with the Notifier.
default void	completed(java.lang.String kafkaTopic, int partitionId, long offset)	Consumption is completed for a store and partition.
default void	completed(java.lang.String kafkaTopic, int partitionId, long offset, java.lang.String message)
default void	completed(java.lang.String kafkaTopic, int partitionId, long offset, java.lang.String message, java.util.Optional<LeaderFollowerStateType> leaderState)
default void	dataRecoveryCompleted(java.lang.String kafkaTopic, int partitionId, long offset, java.lang.String message)
default void	endOfIncrementalPushReceived(java.lang.String kafkaTopic, int partitionId, long offset)	Consumption is completed for an incremental push
default void	endOfIncrementalPushReceived(java.lang.String kafkaTopic, int partitionId, long offset, java.lang.String message)
default void	endOfPushReceived(java.lang.String kafkaTopic, int partitionId, long offset)	The ControlMessageType.END_OF_PUSH control message was consumed.
default void	endOfPushReceived(java.lang.String kafkaTopic, int partitionId, long offset, java.lang.String message)
default void	error(java.lang.String kafkaTopic, int partitionId, java.lang.String message, java.lang.Exception e)	Report an error, during the consumption for a Partitions and store.
default void	progress(java.lang.String kafkaTopic, int partitionId, long offset)	Periodic progress report of consumption for a store and partition.
default void	progress(java.lang.String kafkaTopic, int partitionId, long offset, java.lang.String message)
default void	quotaNotViolated(java.lang.String kafkaTopic, int partitionId, long offset)	Quota is not violated for a store.
default void	quotaNotViolated(java.lang.String kafkaTopic, int partitionId, long offset, java.lang.String message)
default void	quotaViolated(java.lang.String kafkaTopic, int partitionId, long offset)	Quota is violated for a store.
default void	quotaViolated(java.lang.String kafkaTopic, int partitionId, long offset, java.lang.String message)
default void	restarted(java.lang.String kafkaTopic, int partitionId, long offset)	Consumption is restarted from given offset for a store and partition
default void	restarted(java.lang.String kafkaTopic, int partitionId, long offset, java.lang.String message)
default void	started(java.lang.String kafkaTopic, int partitionId)	Consumption is started for a store and partition
default void	started(java.lang.String kafkaTopic, int partitionId, java.lang.String message)
default void	startOfIncrementalPushReceived(java.lang.String kafkaTopic, int partitionId, long offset)	Consumption is started for an incremental push
default void	startOfIncrementalPushReceived(java.lang.String kafkaTopic, int partitionId, long offset, java.lang.String message)
default void	stopped(java.lang.String kafkaTopic, int partitionId, long offset)
default void	topicSwitchReceived(java.lang.String kafkaTopic, int partitionId, long offset)	The ControlMessageType.TOPIC_SWITCH control message was consumed.
default void	topicSwitchReceived(java.lang.String kafkaTopic, int partitionId, long offset, java.lang.String message)

Method Detail

started

default void started(java.lang.String kafkaTopic,
                     int partitionId)

Consumption is started for a store and partition

started

default void started(java.lang.String kafkaTopic,
                     int partitionId,
                     java.lang.String message)

restarted

default void restarted(java.lang.String kafkaTopic,
                       int partitionId,
                       long offset)

Consumption is restarted from given offset for a store and partition

restarted

default void restarted(java.lang.String kafkaTopic,
                       int partitionId,
                       long offset,
                       java.lang.String message)

progress

default void progress(java.lang.String kafkaTopic,
                      int partitionId,
                      long offset)

Periodic progress report of consumption for a store and partition.

progress

default void progress(java.lang.String kafkaTopic,
                      int partitionId,
                      long offset,
                      java.lang.String message)

endOfPushReceived

default void endOfPushReceived(java.lang.String kafkaTopic,
                               int partitionId,
                               long offset)

The ControlMessageType.END_OF_PUSH control message was consumed.

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

endOfPushReceived

default void endOfPushReceived(java.lang.String kafkaTopic,
                               int partitionId,
                               long offset,
                               java.lang.String message)

topicSwitchReceived

default void topicSwitchReceived(java.lang.String kafkaTopic,
                                 int partitionId,
                                 long offset)

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, long) and before completed(String, int, long).

topicSwitchReceived

default void topicSwitchReceived(java.lang.String kafkaTopic,
                                 int partitionId,
                                 long offset,
                                 java.lang.String message)

dataRecoveryCompleted

default void dataRecoveryCompleted(java.lang.String kafkaTopic,
                                   int partitionId,
                                   long offset,
                                   java.lang.String message)

startOfIncrementalPushReceived

default void startOfIncrementalPushReceived(java.lang.String kafkaTopic,
                                            int partitionId,
                                            long offset)

Consumption is started for an incremental push

startOfIncrementalPushReceived

default void startOfIncrementalPushReceived(java.lang.String kafkaTopic,
                                            int partitionId,
                                            long offset,
                                            java.lang.String message)

endOfIncrementalPushReceived

default void endOfIncrementalPushReceived(java.lang.String kafkaTopic,
                                          int partitionId,
                                          long offset)

Consumption is completed for an incremental push

endOfIncrementalPushReceived

default void endOfIncrementalPushReceived(java.lang.String kafkaTopic,
                                          int partitionId,
                                          long offset,
                                          java.lang.String message)

catchUpVersionTopicOffsetLag

default void catchUpVersionTopicOffsetLag(java.lang.String kafkaTopic,
                                          int partitionId)

completed

default void completed(java.lang.String kafkaTopic,
                       int partitionId,
                       long offset)

Consumption is completed for a store and partition.

completed

default void completed(java.lang.String kafkaTopic,
                       int partitionId,
                       long offset,
                       java.lang.String message)

completed

default void completed(java.lang.String kafkaTopic,
                       int partitionId,
                       long offset,
                       java.lang.String message,
                       java.util.Optional<LeaderFollowerStateType> leaderState)

quotaViolated

default void quotaViolated(java.lang.String kafkaTopic,
                           int partitionId,
                           long offset)

Quota is violated for a store.

quotaViolated

default void quotaViolated(java.lang.String kafkaTopic,
                           int partitionId,
                           long offset,
                           java.lang.String message)

quotaNotViolated

default void quotaNotViolated(java.lang.String kafkaTopic,
                              int partitionId,
                              long offset)

Quota is not violated for a store.

quotaNotViolated

default void quotaNotViolated(java.lang.String kafkaTopic,
                              int partitionId,
                              long offset,
                              java.lang.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 java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

error

default void error(java.lang.String kafkaTopic,
                   int partitionId,
                   java.lang.String message,
                   java.lang.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(java.lang.String kafkaTopic,
                     int partitionId,
                     long offset)