org.apache.hudi.client.heartbeat

Class HoodieHeartbeatClient

java.lang.Object

org.apache.hudi.client.heartbeat.HoodieHeartbeatClient

All Implemented Interfaces:

Serializable, AutoCloseable

@NotThreadSafe
public class HoodieHeartbeatClient
extends Object
implements AutoCloseable, Serializable

This class creates heartbeat for hudi client. This heartbeat is used to ascertain whether the running job is or not. NOTE: Due to CPU contention on the driver/client node, the heartbeats could be delayed, hence it's important to set the value high enough to avoid that possibility.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HoodieHeartbeatClient(org.apache.hadoop.fs.FileSystem fs, String basePath, Long heartbeatIntervalInMs, Integer numTolerableHeartbeatMisses)

Method Summary

Modifier and Type	Method and Description
void	close()
List<String>	getAllExistingHeartbeatInstants()
org.apache.hudi.client.heartbeat.HoodieHeartbeatClient.Heartbeat	getHeartbeat(String instantTime)
String	getHeartbeatFolderPath()
static Long	getLastHeartbeatTime(org.apache.hadoop.fs.FileSystem fs, String basePath, String instantTime)
static Boolean	heartbeatExists(org.apache.hadoop.fs.FileSystem fs, String basePath, String instantTime)
boolean	isHeartbeatExpired(String instantTime)
void	start(String instantTime) Start a new heartbeat for the specified instant.
void	stop() Stops all heartbeats started via this instance of the client.
void	stop(String instantTime) Stops the heartbeat for the specified instant.

Methods inherited from class java.lang.Object

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

Constructor Detail

HoodieHeartbeatClient

public HoodieHeartbeatClient(org.apache.hadoop.fs.FileSystem fs,
                             String basePath,
                             Long heartbeatIntervalInMs,
                             Integer numTolerableHeartbeatMisses)

Method Detail

start

public void start(String instantTime)

Start a new heartbeat for the specified instant. If there is already one running, this will be a NO_OP

Parameters:

instantTime -

stop

public void stop(String instantTime)
          throws HoodieException

Stops the heartbeat for the specified instant.

Parameters:

instantTime -

Throws:

HoodieException

stop

public void stop()
          throws HoodieException

Stops all heartbeats started via this instance of the client.

Throws:

HoodieException

getLastHeartbeatTime

public static Long getLastHeartbeatTime(org.apache.hadoop.fs.FileSystem fs,
                                        String basePath,
                                        String instantTime)
                                 throws IOException

Throws:

IOException

heartbeatExists

public static Boolean heartbeatExists(org.apache.hadoop.fs.FileSystem fs,
                                      String basePath,
                                      String instantTime)
                               throws IOException

Throws:

IOException

isHeartbeatExpired

public boolean isHeartbeatExpired(String instantTime)
                           throws IOException

Throws:

IOException

getAllExistingHeartbeatInstants

public List<String> getAllExistingHeartbeatInstants()
                                             throws IOException

Throws:

IOException

getHeartbeatFolderPath

public String getHeartbeatFolderPath()

getHeartbeat

public org.apache.hudi.client.heartbeat.HoodieHeartbeatClient.Heartbeat getHeartbeat(String instantTime)

close

public void close()

Specified by:

close in interface AutoCloseable