Package com.linkedin.venice.pushmonitor

Class PushMonitorDelegator

java.lang.Object

com.linkedin.venice.pushmonitor.PushMonitorDelegator

All Implemented Interfaces:

PushMonitor

public class PushMonitorDelegator
extends java.lang.Object
implements PushMonitor

This class maintains the mapping of Kafka topic to each PushMonitor instance and delegates calls to the correct instance.

Constructor Summary

Constructors

Constructor

Description

PushMonitorDelegator(java.lang.String clusterName, RoutingDataRepository routingDataRepository, OfflinePushAccessor offlinePushAccessor, StoreCleaner storeCleaner, ReadWriteStoreRepository metadataRepository, AggPushHealthStats aggPushHealthStats, RealTimeTopicSwitcher leaderFollowerTopicReplicator, ClusterLockManager clusterLockManager, java.lang.String aggregateRealTimeSourceKafkaUrl, java.util.List<java.lang.String> activeActiveRealTimeSourceKafkaURLs, HelixAdminClient helixAdminClient, VeniceControllerConfig controllerConfig, PushStatusStoreReader pushStatusStoreReader, DisabledPartitionStats disabledPartitionStats)

Method Summary

Modifier and Type	Method	Description
void	cleanupStoreStatus(java.lang.String storeName)	Clean up all push statuses related to a store including all error pushes.
ExecutionStatusWithDetails	getIncrementalPushStatusAndDetails(java.lang.String kafkaTopic, java.lang.String incrementalPushVersion, HelixCustomizedViewOfflinePushRepository customizedViewRepo)	Returns incremental push's status read from (ZooKeeper backed) OfflinePushStatus
ExecutionStatusWithDetails	getIncrementalPushStatusFromPushStatusStore(java.lang.String kafkaTopic, java.lang.String incrementalPushVersion, HelixCustomizedViewOfflinePushRepository customizedViewRepo, PushStatusStoreReader pushStatusStoreReader)	Returns incremental push's status read from push status store
OfflinePushStatus	getOfflinePushOrThrow(java.lang.String topic)	Return a push's status (push status contains the history statuses and current status) and throw exception if it doesn't exist
java.util.List<OfflinePushStatus>	getOfflinePushStatusForStore(java.lang.String storeName)
java.util.Set<java.lang.String>	getOngoingIncrementalPushVersions(java.lang.String kafkaTopic)	Check if there are any ongoing incremental push for the given version topic.
java.util.Set<java.lang.String>	getOngoingIncrementalPushVersions(java.lang.String kafkaTopic, PushStatusStoreReader pushStatusStoreReader)
ExecutionStatusWithDetails	getPushStatusAndDetails(java.lang.String topic)
java.util.List<Instance>	getReadyToServeInstances(PartitionAssignment partitionAssignment, int partitionId)
java.util.List<java.lang.String>	getTopicsOfOngoingOfflinePushes()	Find all ongoing pushes then return the topics associated to those pushes.
java.util.List<UncompletedPartition>	getUncompletedPartitions(java.lang.String topic)
boolean	isOfflinePushMonitorDaVinciPushStatusEnabled()
void	loadAllPushes()	load previous push statuses when push monitor restarts
void	markOfflinePushAsError(java.lang.String topic, java.lang.String statusDetails)	Mark a push to be as error.
void	recordPushPreparationDuration(java.lang.String topic, long offlinePushWaitTimeInSecond)	stats related operation.
OfflinePushStatus	refreshAndUpdatePushStatus(java.lang.String kafkaTopic, ExecutionStatus newStatus, java.util.Optional<java.lang.String> newStatusDetails)	Here, we refresh the push status, in order to avoid a race condition where a small job could already be completed.
void	startMonitorOfflinePush(java.lang.String kafkaTopic, int numberOfPartition, int replicaFactor, OfflinePushStrategy strategy)
void	stopAllMonitoring()	Stop monitoring all offline pushes.
void	stopMonitorOfflinePush(java.lang.String kafkaTopic, boolean deletePushStatus, boolean isForcedDelete)	Stop monitoring a push.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PushMonitorDelegator

public PushMonitorDelegator(java.lang.String clusterName,
                            RoutingDataRepository routingDataRepository,
                            OfflinePushAccessor offlinePushAccessor,
                            StoreCleaner storeCleaner,
                            ReadWriteStoreRepository metadataRepository,
                            AggPushHealthStats aggPushHealthStats,
                            RealTimeTopicSwitcher leaderFollowerTopicReplicator,
                            ClusterLockManager clusterLockManager,
                            java.lang.String aggregateRealTimeSourceKafkaUrl,
                            java.util.List<java.lang.String> activeActiveRealTimeSourceKafkaURLs,
                            HelixAdminClient helixAdminClient,
                            VeniceControllerConfig controllerConfig,
                            PushStatusStoreReader pushStatusStoreReader,
                            DisabledPartitionStats disabledPartitionStats)

Method Detail

loadAllPushes

public void loadAllPushes()

Description copied from interface: PushMonitor

load previous push statuses when push monitor restarts

Specified by:

loadAllPushes in interface PushMonitor

startMonitorOfflinePush

public void startMonitorOfflinePush(java.lang.String kafkaTopic,
                                    int numberOfPartition,
                                    int replicaFactor,
                                    OfflinePushStrategy strategy)

Specified by:

startMonitorOfflinePush in interface PushMonitor

strategy - on which criteria a push is considered to be completed. check PushStatusDecider for more details Start monitoring a new push

stopMonitorOfflinePush

public void stopMonitorOfflinePush(java.lang.String kafkaTopic,
                                   boolean deletePushStatus,
                                   boolean isForcedDelete)

Description copied from interface: PushMonitor

Stop monitoring a push. This function should be called when: 1. Retire a version; 2. Leader controller transits to standby; in this case, controller shouldn't delete any push status.

Specified by:

stopMonitorOfflinePush in interface PushMonitor

stopAllMonitoring

public void stopAllMonitoring()

Description copied from interface: PushMonitor

Stop monitoring all offline pushes.

Specified by:

stopAllMonitoring in interface PushMonitor

cleanupStoreStatus

public void cleanupStoreStatus(java.lang.String storeName)

Description copied from interface: PushMonitor

Clean up all push statuses related to a store including all error pushes. This is called when a store gets deleted.

Specified by:

cleanupStoreStatus in interface PushMonitor

getOfflinePushOrThrow

public OfflinePushStatus getOfflinePushOrThrow(java.lang.String topic)

Description copied from interface: PushMonitor

Return a push's status (push status contains the history statuses and current status) and throw exception if it doesn't exist

Specified by:

getOfflinePushOrThrow in interface PushMonitor

getPushStatusAndDetails

public ExecutionStatusWithDetails getPushStatusAndDetails(java.lang.String topic)

Specified by:

getPushStatusAndDetails in interface PushMonitor

Returns:

return the current status. If it's in error, some debugging info is also presented.

getUncompletedPartitions

public java.util.List<UncompletedPartition> getUncompletedPartitions(java.lang.String topic)

Specified by:

getUncompletedPartitions in interface PushMonitor

getIncrementalPushStatusAndDetails

public ExecutionStatusWithDetails getIncrementalPushStatusAndDetails(java.lang.String kafkaTopic,
                                                                     java.lang.String incrementalPushVersion,
                                                                     HelixCustomizedViewOfflinePushRepository customizedViewRepo)

Description copied from interface: PushMonitor

Returns incremental push's status read from (ZooKeeper backed) OfflinePushStatus

Specified by:

getIncrementalPushStatusAndDetails in interface PushMonitor

getIncrementalPushStatusFromPushStatusStore

public ExecutionStatusWithDetails getIncrementalPushStatusFromPushStatusStore(java.lang.String kafkaTopic,
                                                                              java.lang.String incrementalPushVersion,
                                                                              HelixCustomizedViewOfflinePushRepository customizedViewRepo,
                                                                              PushStatusStoreReader pushStatusStoreReader)

Description copied from interface: PushMonitor

Returns incremental push's status read from push status store

Specified by:

getIncrementalPushStatusFromPushStatusStore in interface PushMonitor

getOngoingIncrementalPushVersions

public java.util.Set<java.lang.String> getOngoingIncrementalPushVersions(java.lang.String kafkaTopic)

Description copied from interface: PushMonitor

Check if there are any ongoing incremental push for the given version topic.

Specified by:

getOngoingIncrementalPushVersions in interface PushMonitor

Parameters:

kafkaTopic - to check for ongoing incremental push

Returns:

ongoing incremental push versions if there are any, otherwise an empty set is returned.

getOngoingIncrementalPushVersions

public java.util.Set<java.lang.String> getOngoingIncrementalPushVersions(java.lang.String kafkaTopic,
                                                                         PushStatusStoreReader pushStatusStoreReader)

Specified by:

getOngoingIncrementalPushVersions in interface PushMonitor

getTopicsOfOngoingOfflinePushes

public java.util.List<java.lang.String> getTopicsOfOngoingOfflinePushes()

Description copied from interface: PushMonitor

Find all ongoing pushes then return the topics associated to those pushes.

Specified by:

getTopicsOfOngoingOfflinePushes in interface PushMonitor

getOfflinePushStatusForStore

public java.util.List<OfflinePushStatus> getOfflinePushStatusForStore(java.lang.String storeName)

Specified by:

getOfflinePushStatusForStore in interface PushMonitor

markOfflinePushAsError

public void markOfflinePushAsError(java.lang.String topic,
                                   java.lang.String statusDetails)

Description copied from interface: PushMonitor

Mark a push to be as error. This is usually called when push is killed.

Specified by:

markOfflinePushAsError in interface PushMonitor

refreshAndUpdatePushStatus

public OfflinePushStatus refreshAndUpdatePushStatus(java.lang.String kafkaTopic,
                                                    ExecutionStatus newStatus,
                                                    java.util.Optional<java.lang.String> newStatusDetails)

Description copied from interface: PushMonitor

Here, we refresh the push status, in order to avoid a race condition where a small job could already be completed. Previously, we would clobber the COMPLETED status with STARTED, which would stall the job forever. Now, since we get the refreshed status, we can validate whether a transition to {@param newStatus} is valid, before making the change. If if wouldn't be valid (because the job already completed or already failed, for example), then we leave the status as is, rather than adding in the new details.

Specified by:

refreshAndUpdatePushStatus in interface PushMonitor

Returns:

the new OfflinePushStatus if it was updated, or null if the update was skipped.

recordPushPreparationDuration

public void recordPushPreparationDuration(java.lang.String topic,
                                          long offlinePushWaitTimeInSecond)

Description copied from interface: PushMonitor

stats related operation. TODO: we may want to move it out of the interface

Specified by:

recordPushPreparationDuration in interface PushMonitor

getReadyToServeInstances

public java.util.List<Instance> getReadyToServeInstances(PartitionAssignment partitionAssignment,
                                                         int partitionId)

Specified by:

getReadyToServeInstances in interface PushMonitor

isOfflinePushMonitorDaVinciPushStatusEnabled

public boolean isOfflinePushMonitorDaVinciPushStatusEnabled()

Specified by:

isOfflinePushMonitorDaVinciPushStatusEnabled in interface PushMonitor