org.apache.hudi.util

Class ClientIds

java.lang.Object

org.apache.hudi.util.ClientIds

All Implemented Interfaces:

Serializable, AutoCloseable

public class ClientIds
extends Object
implements AutoCloseable, Serializable

This class creates a client id heartbeat for a new driver. The heartbeat is used to ascertain whether a driver is still alive or not. Currently, it is mainly used for two cases:

1. Legacy service cleaning, when a new driver starts up, it also checks whether there are some zombie clients whose heartbeat file can be removed;
2. Auto generates a new client id, tries to reuse the existing ids from the zombie clients first or generates an inc id based on the largest alive client id.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientIds.Builder Builder for ClientIds.

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_HEARTBEAT_INTERVAL_IN_MS
static int	DEFAULT_NUM_TOLERABLE_HEARTBEAT_MISSES
static String	INIT_CLIENT_ID

Method Summary

Modifier and Type	Method and Description
static ClientIds.Builder	builder() Returns the builder.
void	close()
static boolean	isHeartbeatExpired(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path path, long timeoutThreshold)
String	nextId(org.apache.flink.configuration.Configuration conf)
void	start()

Methods inherited from class java.lang.Object

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

Field Detail

INIT_CLIENT_ID

public static final String INIT_CLIENT_ID

See Also:

Constant Field Values

DEFAULT_HEARTBEAT_INTERVAL_IN_MS

public static final long DEFAULT_HEARTBEAT_INTERVAL_IN_MS

See Also:

Constant Field Values

DEFAULT_NUM_TOLERABLE_HEARTBEAT_MISSES

public static final int DEFAULT_NUM_TOLERABLE_HEARTBEAT_MISSES

See Also:

Constant Field Values

Method Detail

start

public void start()

builder

public static ClientIds.Builder builder()

Returns the builder.

close

public void close()

Specified by:

close in interface AutoCloseable

isHeartbeatExpired

public static boolean isHeartbeatExpired(org.apache.hadoop.fs.FileSystem fs,
                                         org.apache.hadoop.fs.Path path,
                                         long timeoutThreshold)

nextId

public String nextId(org.apache.flink.configuration.Configuration conf)