org.elasticsearch.env

Class NodeEnvironment

java.lang.Object

org.elasticsearch.env.NodeEnvironment

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public final class NodeEnvironment
extends java.lang.Object
implements java.io.Closeable

A component that holds all data paths for a single node.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NodeEnvironment.NodePath
static interface	NodeEnvironment.ShardLocker A functional interface that people can use to reference shardLock(ShardId, long)

Field Summary

Fields

Modifier and Type	Field and Description
static Setting<java.lang.Boolean>	ADD_NODE_LOCK_ID_TO_CUSTOM_PATH If true automatically append node lock id to custom data paths.
static Setting<java.lang.Boolean>	ENABLE_LUCENE_SEGMENT_INFOS_TRACE_SETTING If true the [verbose] SegmentInfos.infoStream logging is sent to System.out.
static java.lang.String	INDICES_FOLDER
static Setting<java.lang.Integer>	MAX_LOCAL_STORAGE_NODES_SETTING Maximum number of data nodes that should run in an environment.
static Setting<java.lang.Long>	NODE_ID_SEED_SETTING Seed for determining a persisted unique uuid of this node.
static java.lang.String	NODE_LOCK_FILENAME
static java.lang.String	NODES_FOLDER

Constructor Summary

Constructors

Constructor and Description
NodeEnvironment(Settings settings, Environment environment)

Method Summary

Modifier and Type	Method and Description
static void	acquireFSLockForPaths(IndexSettings indexSettings, java.nio.file.Path... shardPaths) Acquires, then releases, all write.lock files in the given shard paths.
java.util.Set<java.lang.String>	availableIndexFolders() Returns all folder names in ${data.paths}/nodes/{node.id}/indices folder
java.util.Set<java.lang.String>	availableIndexFoldersForPath(NodeEnvironment.NodePath nodePath) Return all directory names in the nodes/{node.id}/indices directory for the given node path.
java.nio.file.Path[]	availableShardPaths(ShardId shardId) Returns all shard paths excluding custom shard path.
void	close()
void	deleteIndexDirectorySafe(Index index, long lockTimeoutMS, IndexSettings indexSettings) Deletes an indexes data directory recursively iff all of the indexes shards locks were successfully acquired.
void	deleteIndexDirectoryUnderLock(Index index, IndexSettings indexSettings) Deletes an indexes data directory recursively.
void	deleteShardDirectorySafe(ShardId shardId, IndexSettings indexSettings) Deletes a shard data directory iff the shards locks were successfully acquired.
void	deleteShardDirectoryUnderLock(ShardLock lock, IndexSettings indexSettings) Deletes a shard data directory.
void	ensureAtomicMoveSupported() This method tries to write an empty file and moves it using an atomic move operation.
java.util.Set<ShardId>	findAllShardIds(Index index) Tries to find all allocated shards for the given index on the current node.
static java.lang.String	generateNodeId(Settings settings)
int	getNodeLockId()
boolean	hasNodeFile()
java.nio.file.Path[]	indexPaths(Index index) Returns all index paths.
java.util.List<ShardLock>	lockAllForIndex(Index index, IndexSettings settings, long lockTimeoutMS) Tries to lock all local shards for the given index.
java.util.Set<ShardId>	lockedShards() Returns all currently lock shards.
java.nio.file.Path[]	nodeDataPaths() Returns an array of all of the nodes data locations.
java.lang.String	nodeId() returns the unique uuid describing this node.
NodeEnvironment.NodePath[]	nodePaths() Returns an array of all of the NodeEnvironment.NodePaths.
java.nio.file.Path	resolveBaseCustomLocation(IndexSettings indexSettings) Resolve the custom path for a index's shard.
java.nio.file.Path	resolveCustomLocation(IndexSettings indexSettings, ShardId shardId) Resolve the custom path for a index's shard.
java.nio.file.Path[]	resolveIndexFolder(java.lang.String indexFolderName) Resolves all existing paths to indexFolderName in ${data.paths}/nodes/{node.id}/indices
static java.nio.file.Path	resolveNodePath(java.nio.file.Path path, int nodeLockId) Resolve a specific nodes/{node.id} path for the specified path and node lock id.
ShardLock	shardLock(ShardId id) Tries to lock the given shards ID.
ShardLock	shardLock(ShardId shardId, long lockTimeoutMS) Tries to lock the given shards ID.
static java.nio.file.Path	shardStatePathToDataPath(java.nio.file.Path shardPath) Returns the NodePath.path for this shard.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_LOCAL_STORAGE_NODES_SETTING

public static final Setting<java.lang.Integer> MAX_LOCAL_STORAGE_NODES_SETTING

Maximum number of data nodes that should run in an environment.

ADD_NODE_LOCK_ID_TO_CUSTOM_PATH

public static final Setting<java.lang.Boolean> ADD_NODE_LOCK_ID_TO_CUSTOM_PATH

If true automatically append node lock id to custom data paths.

NODE_ID_SEED_SETTING

public static final Setting<java.lang.Long> NODE_ID_SEED_SETTING

Seed for determining a persisted unique uuid of this node. If the node has already a persisted uuid on disk, this seed will be ignored and the uuid from disk will be reused.

ENABLE_LUCENE_SEGMENT_INFOS_TRACE_SETTING

public static final Setting<java.lang.Boolean> ENABLE_LUCENE_SEGMENT_INFOS_TRACE_SETTING

If true the [verbose] SegmentInfos.infoStream logging is sent to System.out.

NODES_FOLDER

public static final java.lang.String NODES_FOLDER

See Also:

Constant Field Values

INDICES_FOLDER

public static final java.lang.String INDICES_FOLDER

See Also:

Constant Field Values

NODE_LOCK_FILENAME

public static final java.lang.String NODE_LOCK_FILENAME

See Also:

Constant Field Values

Constructor Detail

NodeEnvironment

public NodeEnvironment(Settings settings,
                       Environment environment)
                throws java.io.IOException

Throws:

java.io.IOException

Method Detail

resolveNodePath

public static java.nio.file.Path resolveNodePath(java.nio.file.Path path,
                                                 int nodeLockId)

Resolve a specific nodes/{node.id} path for the specified path and node lock id.

Parameters:

path - the path

nodeLockId - the node lock id

Returns:

the resolved path

generateNodeId

public static java.lang.String generateNodeId(Settings settings)

deleteShardDirectorySafe

public void deleteShardDirectorySafe(ShardId shardId,
                                     IndexSettings indexSettings)
                              throws java.io.IOException,
                                     ShardLockObtainFailedException

Deletes a shard data directory iff the shards locks were successfully acquired.

Parameters:

shardId - the id of the shard to delete to delete

Throws:

java.io.IOException - if an IOException occurs

ShardLockObtainFailedException

acquireFSLockForPaths

public static void acquireFSLockForPaths(IndexSettings indexSettings,
                                         java.nio.file.Path... shardPaths)
                                  throws java.io.IOException

Acquires, then releases, all write.lock files in the given shard paths. The "write.lock" file is assumed to be under the shard path's "index" directory as used by Elasticsearch.

Throws:

org.apache.lucene.store.LockObtainFailedException - if any of the locks could not be acquired

java.io.IOException

deleteShardDirectoryUnderLock

public void deleteShardDirectoryUnderLock(ShardLock lock,
                                          IndexSettings indexSettings)
                                   throws java.io.IOException

Deletes a shard data directory. Note: this method assumes that the shard lock is acquired. This method will also attempt to acquire the write locks for the shard's paths before deleting the data, but this is best effort, as the lock is released before the deletion happens in order to allow the folder to be deleted

Parameters:

lock - the shards lock

Throws:

java.io.IOException - if an IOException occurs

ElasticsearchException - if the write.lock is not acquirable

deleteIndexDirectorySafe

public void deleteIndexDirectorySafe(Index index,
                                     long lockTimeoutMS,
                                     IndexSettings indexSettings)
                              throws java.io.IOException,
                                     ShardLockObtainFailedException

Deletes an indexes data directory recursively iff all of the indexes shards locks were successfully acquired. If any of the indexes shard directories can't be locked non of the shards will be deleted

Parameters:

index - the index to delete

lockTimeoutMS - how long to wait for acquiring the indices shard locks

indexSettings - settings for the index being deleted

Throws:

java.io.IOException - if any of the shards data directories can't be locked or deleted

ShardLockObtainFailedException

deleteIndexDirectoryUnderLock

public void deleteIndexDirectoryUnderLock(Index index,
                                          IndexSettings indexSettings)
                                   throws java.io.IOException

Deletes an indexes data directory recursively. Note: this method assumes that the shard lock is acquired

Parameters:

index - the index to delete

indexSettings - settings for the index being deleted

Throws:

java.io.IOException

lockAllForIndex

public java.util.List<ShardLock> lockAllForIndex(Index index,
                                                 IndexSettings settings,
                                                 long lockTimeoutMS)
                                          throws java.io.IOException,
                                                 ShardLockObtainFailedException

Tries to lock all local shards for the given index. If any of the shard locks can't be acquired a ShardLockObtainFailedException is thrown and all previously acquired locks are released.

Parameters:

index - the index to lock shards for

lockTimeoutMS - how long to wait for acquiring the indices shard locks

Returns:

the ShardLock instances for this index.

Throws:

java.io.IOException - if an IOException occurs.

ShardLockObtainFailedException

shardLock

public ShardLock shardLock(ShardId id)
                    throws ShardLockObtainFailedException

Tries to lock the given shards ID. A shard lock is required to perform any kind of write operation on a shards data directory like deleting files, creating a new index writer or recover from a different shard instance into it. If the shard lock can not be acquired a ShardLockObtainFailedException is thrown. Note: this method will return immediately if the lock can't be acquired.

Parameters:

id - the shard ID to lock

Returns:

the shard lock. Call ShardLock.close() to release the lock

Throws:

ShardLockObtainFailedException

shardLock

public ShardLock shardLock(ShardId shardId,
                           long lockTimeoutMS)
                    throws ShardLockObtainFailedException

Tries to lock the given shards ID. A shard lock is required to perform any kind of write operation on a shards data directory like deleting files, creating a new index writer or recover from a different shard instance into it. If the shard lock can not be acquired a ShardLockObtainFailedException is thrown

Parameters:

shardId - the shard ID to lock

lockTimeoutMS - the lock timeout in milliseconds

Returns:

the shard lock. Call ShardLock.close() to release the lock

Throws:

ShardLockObtainFailedException

lockedShards

public java.util.Set<ShardId> lockedShards()

Returns all currently lock shards. Note: the shard ids return do not contain a valid Index UUID

hasNodeFile

public boolean hasNodeFile()

nodeDataPaths

public java.nio.file.Path[] nodeDataPaths()

Returns an array of all of the nodes data locations.

Throws:

java.lang.IllegalStateException - if the node is not configured to store local locations

nodeId

public java.lang.String nodeId()

returns the unique uuid describing this node. The uuid is persistent in the data folder of this node and remains across restarts.

nodePaths

public NodeEnvironment.NodePath[] nodePaths()

Returns an array of all of the NodeEnvironment.NodePaths.

getNodeLockId

public int getNodeLockId()

indexPaths

public java.nio.file.Path[] indexPaths(Index index)

Returns all index paths.

availableShardPaths

public java.nio.file.Path[] availableShardPaths(ShardId shardId)

Returns all shard paths excluding custom shard path. Note: Shards are only allocated on one of the returned paths. The returned array may contain paths to non-existing directories.

See Also:

IndexSettings.hasCustomDataPath(), resolveCustomLocation(IndexSettings, ShardId)

availableIndexFolders

public java.util.Set<java.lang.String> availableIndexFolders()
                                                      throws java.io.IOException

Returns all folder names in ${data.paths}/nodes/{node.id}/indices folder

Throws:

java.io.IOException

availableIndexFoldersForPath

public java.util.Set<java.lang.String> availableIndexFoldersForPath(NodeEnvironment.NodePath nodePath)
                                                             throws java.io.IOException

Return all directory names in the nodes/{node.id}/indices directory for the given node path.

Parameters:

nodePath - the path

Returns:

all directories that could be indices for the given node path.

Throws:

java.io.IOException - if an I/O exception occurs traversing the filesystem

resolveIndexFolder

public java.nio.file.Path[] resolveIndexFolder(java.lang.String indexFolderName)
                                        throws java.io.IOException

Resolves all existing paths to indexFolderName in ${data.paths}/nodes/{node.id}/indices

Throws:

java.io.IOException

findAllShardIds

public java.util.Set<ShardId> findAllShardIds(Index index)
                                       throws java.io.IOException

Tries to find all allocated shards for the given index on the current node. NOTE: This methods is prone to race-conditions on the filesystem layer since it might not see directories created concurrently or while it's traversing.

Parameters:

index - the index to filter shards

Returns:

a set of shard IDs

Throws:

java.io.IOException - if an IOException occurs

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

ensureAtomicMoveSupported

public void ensureAtomicMoveSupported()
                               throws java.io.IOException

This method tries to write an empty file and moves it using an atomic move operation. This method throws an IllegalStateException if this operation is not supported by the filesystem. This test is executed on each of the data directories. This method cleans up all files even in the case of an error.

Throws:

java.io.IOException

resolveBaseCustomLocation

public java.nio.file.Path resolveBaseCustomLocation(IndexSettings indexSettings)

Resolve the custom path for a index's shard. Uses the IndexMetaData.SETTING_DATA_PATH setting to determine the root path for the index.

Parameters:

indexSettings - settings for the index

resolveCustomLocation

public java.nio.file.Path resolveCustomLocation(IndexSettings indexSettings,
                                                ShardId shardId)

Resolve the custom path for a index's shard. Uses the IndexMetaData.SETTING_DATA_PATH setting to determine the root path for the index.

Parameters:

indexSettings - settings for the index

shardId - shard to resolve the path to

shardStatePathToDataPath

public static java.nio.file.Path shardStatePathToDataPath(java.nio.file.Path shardPath)

Returns the NodePath.path for this shard.