Package com.linkedin.venice.router.api

Class RouterHeartbeat

java.lang.Object

com.linkedin.venice.service.AbstractVeniceService

com.linkedin.venice.router.api.RouterHeartbeat

All Implemented Interfaces:

Closeable, AutoCloseable

public class RouterHeartbeat
extends AbstractVeniceService

RouterHeartbeat is a service that monitors and reports the health of current live instances in the Venice cluster.

Nested Class Summary

Nested classes/interfaces inherited from class com.linkedin.venice.service.AbstractVeniceService

AbstractVeniceService.ServiceState

Field Summary

Fields inherited from class com.linkedin.venice.service.AbstractVeniceService

logger, serviceState

Constructor Summary

Constructors

Constructor	Description
RouterHeartbeat(LiveInstanceMonitor monitor, VeniceHostHealth health, VeniceRouterConfig routerConfig, Optional<SSLFactory> sslFactory, StorageNodeClient storageNodeClient)

Method Summary

Modifier and Type	Method	Description
boolean	startInner()
void	stopInner()

Methods inherited from class com.linkedin.venice.service.AbstractVeniceService

close, getName, isRunning, start, stop

Methods inherited from class java.lang.Object

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

Constructor Details

RouterHeartbeat

public RouterHeartbeat(LiveInstanceMonitor monitor,
 VeniceHostHealth health,
 VeniceRouterConfig routerConfig,
 Optional<SSLFactory> sslFactory,
 StorageNodeClient storageNodeClient)

Parameters:

monitor - LiveInstanceMonitor used to identify which storage nodes need to be queried

health - VeniceHostHealth used to mark unreachable nodes as unhealthy

routerConfig - Venice router config

sslFactory - if provided, the heartbeat will attempt to use ssl when checking the status of the storage nodes

Method Details

startInner

public boolean startInner()
                   throws Exception

Specified by:

startInner in class AbstractVeniceService

Returns:

true if the service is completely started, false if it is still starting asynchronously (in this case, it is the implementer's responsibility to set AbstractVeniceService.serviceState to AbstractVeniceService.ServiceState.STARTED upon completion of the async work).

Throws:

Exception

stopInner

public void stopInner()
               throws Exception

Specified by:

stopInner in class AbstractVeniceService

Throws:

Exception