Class DiskBasedShardAllocationSettings

Inheritance

object

DiskBasedShardAllocationSettings

Implements

IDiskBasedShardAllocationSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Client

Assembly: OpenSearch.Client.dll

Syntax

public class DiskBasedShardAllocationSettings : IDiskBasedShardAllocationSettings

Properties

HighWatermark

Controls the high watermark. It defaults to 90%, meaning OpenSearch will attempt to relocate shards to another node if the node disk usage rises above 90%. It can also be set to an absolute byte value (similar to the low watermark) to relocate shards once less than the configured amount of space is available on the node.

Declaration

public string HighWatermark { get; set; }

Property Value

Type	Description
string

IncludeRelocations

Defaults to true, which means that OpenSearch will take into account shards that are currently being relocated to the target node when computing a node’s disk usage. Taking relocating shards' sizes into account may, however, mean that the disk usage for a node is incorrectly estimated on the high side, since the relocation could be 90% complete and a recently retrieved disk usage would include the total size of the relocating shard as well as the space already used by the running relocation.

Declaration

public bool? IncludeRelocations { get; set; }

Property Value

Type	Description
bool?

LowWatermark

Controls the low watermark for disk usage. It defaults to 85%, meaning OpenSearch will not allocate new shards to nodes once they have more than 85% disk used. It can also be set to an absolute byte value (like 500mb) to prevent OpenSearch from allocating shards if less than the configured amount of space is available.

Declaration

public string LowWatermark { get; set; }

Property Value

Type	Description
string

ThresholdEnabled

Defaults to true. Set to false to disable the disk allocation decider.

Declaration

public bool? ThresholdEnabled { get; set; }

Property Value

Type	Description
bool?

UpdateInterval

How often OpenSearch should check on disk usage for each node in the cluster. Defaults to 30s.

Declaration

public Time UpdateInterval { get; set; }

Property Value

Type	Description
Time

Implements

IDiskBasedShardAllocationSettings

Extension Methods

SuffixExtensions.Suffix(object, string)