Plan

Struct Plan 

Source
pub struct Plan {
Show 15 fields pub base: f64, pub with_merge: f64, pub with_headroom: f64, pub buffer_total: f64, pub total_cluster: f64, pub per_node: f64, pub disk_per_node: f64, pub target_utilization: f64, pub nodes: u32, pub primaries: u32, pub replicas: u32, pub shard_size_gb: f64, pub overhead_merge: f64, pub headroom: f64, pub buffer_per_node_gb: Option<f64>,
}
Expand description

Represents the computed capacity plan for an Elasticsearch cluster.

All values are expressed in gigabytes (GB, base-10). This struct is returned by the capacity calculation function and provides both cluster-level and per-node estimates.

Fields§

§base: f64

Total data size for all primary and replica shards combined.

Formula: primaries * shard_size_gb * (1 + replicas)

§with_merge: f64

Base size plus Lucene merge overhead.

Formula: base * (1 + overhead_merge)

§with_headroom: f64

Size after applying headroom for watermarks and ingestion bursts.

Formula: with_merge * (1 + headroom)

§buffer_total: f64

Total relocation/rebalancing buffer for all nodes combined.

Formula: buffer_per_node_gb * nodes

§total_cluster: f64

Total cluster disk requirement, including overhead, headroom, and buffer.

Formula: with_headroom + buffer_total

§per_node: f64

Recommended data size per node, averaged across the cluster.

Formula: total_cluster / nodes

§disk_per_node: f64

Recommended physical disk size per node to stay below the target utilization.

Formula: per_node / target_utilization

§target_utilization: f64

Target maximum disk utilization ratio (e.g. 0.75 = 75%).

§nodes: u32

Number of data nodes in the cluster.

§primaries: u32

Total number of primary shards.

§replicas: u32

Number of replica shards per primary.

§shard_size_gb: f64

Average shard size in GB (base-10).

§overhead_merge: f64

Merge overhead fraction (e.g. 0.2 = 20%).

§headroom: f64

Headroom fraction (e.g. 0.3 = 30%).

§buffer_per_node_gb: Option<f64>

Optional relocation buffer per node in GB (defaults to shard size if None).

Trait Implementations§

Source§

impl Clone for Plan

Source§

fn clone(&self) -> Plan

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Plan

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Display for Plan

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult

Formats the value using the given formatter. Read more
Source§

impl Copy for Plan

Auto Trait Implementations§

§

impl Freeze for Plan

§

impl RefUnwindSafe for Plan

§

impl Send for Plan

§

impl Sync for Plan

§

impl Unpin for Plan

§

impl UnwindSafe for Plan

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.