Package org.elasticsearch.transport

Class RemoteClusterService

java.lang.Object

org.elasticsearch.transport.RemoteClusterAware

org.elasticsearch.transport.RemoteClusterService

All Implemented Interfaces:

Closeable, AutoCloseable

public final class RemoteClusterService
extends RemoteClusterAware
implements Closeable

Basic service for accessing remote clusters via gateway nodes

Field Summary

Fields

Modifier and Type	Field	Description
static Setting<Boolean>	ENABLE_REMOTE_CLUSTERS	If true connecting to remote clusters is supported on this node.
static Setting.AffixSetting<Boolean>	REMOTE_CLUSTER_COMPRESS
static Setting.AffixSetting<TimeValue>	REMOTE_CLUSTER_PING_SCHEDULE
static Setting.AffixSetting<Boolean>	REMOTE_CLUSTER_SKIP_UNAVAILABLE
static Setting<Integer>	REMOTE_CONNECTIONS_PER_CLUSTER	The maximum number of connections that will be established to a remote cluster.
static Setting<TimeValue>	REMOTE_INITIAL_CONNECTION_TIMEOUT_SETTING	The initial connect timeout for remote cluster connections
static Setting<String>	REMOTE_NODE_ATTRIBUTE	The name of a node attribute to select nodes that should be connected to in the remote cluster.
static Setting<Boolean>	SEARCH_ENABLE_REMOTE_CLUSTERS
static Setting.AffixSetting<Boolean>	SEARCH_REMOTE_CLUSTER_SKIP_UNAVAILABLE
static SettingUpgrader<Boolean>	SEARCH_REMOTE_CLUSTER_SKIP_UNAVAILABLE_UPGRADER
static Setting<Integer>	SEARCH_REMOTE_CONNECTIONS_PER_CLUSTER
static Setting<TimeValue>	SEARCH_REMOTE_INITIAL_CONNECTION_TIMEOUT_SETTING
static Setting<String>	SEARCH_REMOTE_NODE_ATTRIBUTE

Fields inherited from class org.elasticsearch.transport.RemoteClusterAware

LOCAL_CLUSTER_GROUP_KEY, REMOTE_CLUSTER_INDEX_SEPARATOR, REMOTE_CLUSTERS_PROXY, REMOTE_CLUSTERS_SEEDS, SEARCH_REMOTE_CLUSTER_SEEDS_UPGRADER, SEARCH_REMOTE_CLUSTERS_PROXY, SEARCH_REMOTE_CLUSTERS_PROXY_UPGRADER, SEARCH_REMOTE_CLUSTERS_SEEDS, settings

Method Summary

Modifier and Type	Method	Description
void	close()
void	collectNodes(Set<String> clusters, ActionListener<BiFunction<String,String,DiscoveryNode>> listener)	Collects all nodes of the given clusters and returns / passes a (clusterAlias, nodeId) to DiscoveryNode function on success.
Transport.Connection	getConnection(String cluster)
Transport.Connection	getConnection(DiscoveryNode node, String cluster)	Returns a connection to the given node on the given remote cluster
Set<String>	getRegisteredRemoteClusterNames()	Returns the registered remote cluster names.
Client	getRemoteClusterClient(ThreadPool threadPool, String clusterAlias)	Returns a client to the remote cluster if the given cluster alias exists.
Stream<RemoteConnectionInfo>	getRemoteConnectionInfos()
Map<String,OriginalIndices>	groupIndices(IndicesOptions indicesOptions, String[] indices, Predicate<String> indexExists)
boolean	isCrossClusterSearchEnabled()	Returns true if at least one remote cluster is configured
boolean	isSkipUnavailable(String clusterAlias)	Returns whether the cluster identified by the provided alias is configured to be skipped when unavailable
void	listenForUpdates(ClusterSettings clusterSettings)	Registers this instance to listen to updates on the cluster settings.
protected void	updateRemoteCluster(String clusterAlias, List<String> addresses, String proxyAddress, boolean compressionEnabled, TimeValue pingSchedule)	Subclasses must implement this to receive information about updated cluster aliases.

Methods inherited from class org.elasticsearch.transport.RemoteClusterAware

buildRemoteClustersDynamicConfig, buildRemoteIndexName, groupClusterIndices, parseHostPort

Methods inherited from class java.lang.Object

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

Field Detail

SEARCH_REMOTE_CONNECTIONS_PER_CLUSTER

public static final Setting<Integer> SEARCH_REMOTE_CONNECTIONS_PER_CLUSTER

REMOTE_CONNECTIONS_PER_CLUSTER

public static final Setting<Integer> REMOTE_CONNECTIONS_PER_CLUSTER

The maximum number of connections that will be established to a remote cluster. For instance if there is only a single seed node, other nodes will be discovered up to the given number of nodes in this setting. The default is 3.

SEARCH_REMOTE_INITIAL_CONNECTION_TIMEOUT_SETTING

public static final Setting<TimeValue> SEARCH_REMOTE_INITIAL_CONNECTION_TIMEOUT_SETTING

REMOTE_INITIAL_CONNECTION_TIMEOUT_SETTING

public static final Setting<TimeValue> REMOTE_INITIAL_CONNECTION_TIMEOUT_SETTING

The initial connect timeout for remote cluster connections

SEARCH_REMOTE_NODE_ATTRIBUTE

public static final Setting<String> SEARCH_REMOTE_NODE_ATTRIBUTE

REMOTE_NODE_ATTRIBUTE

public static final Setting<String> REMOTE_NODE_ATTRIBUTE

The name of a node attribute to select nodes that should be connected to in the remote cluster. For instance a node can be configured with node.attr.gateway: true in order to be eligible as a gateway node between clusters. In that case search.remote.node.attr: gateway can be used to filter out other nodes in the remote cluster. The value of the setting is expected to be a boolean, true for nodes that can become gateways, false otherwise.

SEARCH_ENABLE_REMOTE_CLUSTERS

public static final Setting<Boolean> SEARCH_ENABLE_REMOTE_CLUSTERS

ENABLE_REMOTE_CLUSTERS

public static final Setting<Boolean> ENABLE_REMOTE_CLUSTERS

If true connecting to remote clusters is supported on this node. If false this node will not establish connections to any remote clusters configured. Search requests executed against this node (where this node is the coordinating node) will fail if remote cluster syntax is used as an index pattern. The default is true

SEARCH_REMOTE_CLUSTER_SKIP_UNAVAILABLE

public static final Setting.AffixSetting<Boolean> SEARCH_REMOTE_CLUSTER_SKIP_UNAVAILABLE

SEARCH_REMOTE_CLUSTER_SKIP_UNAVAILABLE_UPGRADER

public static final SettingUpgrader<Boolean> SEARCH_REMOTE_CLUSTER_SKIP_UNAVAILABLE_UPGRADER

REMOTE_CLUSTER_SKIP_UNAVAILABLE

public static final Setting.AffixSetting<Boolean> REMOTE_CLUSTER_SKIP_UNAVAILABLE

REMOTE_CLUSTER_PING_SCHEDULE

public static final Setting.AffixSetting<TimeValue> REMOTE_CLUSTER_PING_SCHEDULE

REMOTE_CLUSTER_COMPRESS

public static final Setting.AffixSetting<Boolean> REMOTE_CLUSTER_COMPRESS

Method Detail

isCrossClusterSearchEnabled

public boolean isCrossClusterSearchEnabled()

Returns true if at least one remote cluster is configured

groupIndices

public Map<String,OriginalIndices> groupIndices(IndicesOptions indicesOptions,
                                                      String[] indices,
                                                      Predicate<String> indexExists)

getRegisteredRemoteClusterNames

public Set<String> getRegisteredRemoteClusterNames()

Returns the registered remote cluster names.

getConnection

public Transport.Connection getConnection(DiscoveryNode node,
                                          String cluster)

Returns a connection to the given node on the given remote cluster

Throws:

IllegalArgumentException - if the remote cluster is unknown

isSkipUnavailable

public boolean isSkipUnavailable(String clusterAlias)

Returns whether the cluster identified by the provided alias is configured to be skipped when unavailable

getConnection

public Transport.Connection getConnection(String cluster)

listenForUpdates

public void listenForUpdates(ClusterSettings clusterSettings)

Description copied from class: RemoteClusterAware

Registers this instance to listen to updates on the cluster settings.

Overrides:

listenForUpdates in class RemoteClusterAware

updateRemoteCluster

protected void updateRemoteCluster(String clusterAlias,
                                   List<String> addresses,
                                   String proxyAddress,
                                   boolean compressionEnabled,
                                   TimeValue pingSchedule)

Description copied from class: RemoteClusterAware

Subclasses must implement this to receive information about updated cluster aliases. If the given address list is empty the cluster alias is unregistered and should be removed.

Specified by:

updateRemoteCluster in class RemoteClusterAware

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

getRemoteConnectionInfos

public Stream<RemoteConnectionInfo> getRemoteConnectionInfos()

collectNodes

public void collectNodes(Set<String> clusters,
                         ActionListener<BiFunction<String,String,DiscoveryNode>> listener)

Collects all nodes of the given clusters and returns / passes a (clusterAlias, nodeId) to DiscoveryNode function on success.

getRemoteClusterClient

public Client getRemoteClusterClient(ThreadPool threadPool,
                                     String clusterAlias)

Returns a client to the remote cluster if the given cluster alias exists.

Parameters:

threadPool - the ThreadPool for the client

clusterAlias - the cluster alias the remote cluster is registered under

Throws:

IllegalArgumentException - if the given clusterAlias doesn't exist