Feedback Edit

LoadMetricInformation Class

  • Reference

Represents data structure that contains load information for a certain metric in a cluster.

Inheritance
Model
LoadMetricInformation

Constructor

LoadMetricInformation(*, name: Optional[str] = None, is_balanced_before: Optional[bool] = None, is_balanced_after: Optional[bool] = None, deviation_before: Optional[str] = None, deviation_after: Optional[str] = None, balancing_threshold: Optional[str] = None, action: Optional[str] = None, activity_threshold: Optional[str] = None, cluster_capacity: Optional[str] = None, cluster_load: Optional[str] = None, current_cluster_load: Optional[str] = None, cluster_remaining_capacity: Optional[str] = None, cluster_capacity_remaining: Optional[str] = None, is_cluster_capacity_violation: Optional[bool] = None, node_buffer_percentage: Optional[str] = None, cluster_buffered_capacity: Optional[str] = None, buffered_cluster_capacity_remaining: Optional[str] = None, cluster_remaining_buffered_capacity: Optional[str] = None, min_node_load_value: Optional[str] = None, minimum_node_load: Optional[str] = None, min_node_load_node_id=None, max_node_load_value: Optional[str] = None, maximum_node_load: Optional[str] = None, max_node_load_node_id=None, planned_load_removal: Optional[str] = None, **kwargs)

Parameters

name
str
Required

Name of the metric for which this load information is provided.

is_balanced_before
bool
Required

Value that indicates whether the metrics is balanced or not before resource balancer run

is_balanced_after
bool
Required

Value that indicates whether the metrics is balanced or not after resource balancer run.

deviation_before
str
Required

The standard average deviation of the metrics before resource balancer run.

deviation_after
str
Required

The standard average deviation of the metrics after resource balancer run.

balancing_threshold
str
Required

The balancing threshold for a certain metric.

action
str
Required

The current action being taken with regard to this metric

activity_threshold
str
Required

The Activity Threshold specified for this metric in the system Cluster Manifest.

cluster_capacity
str
Required

The total cluster capacity for a given metric

cluster_load
str
Required

The total cluster load. In future releases of Service Fabric this parameter will be deprecated in favor of CurrentClusterLoad.

current_cluster_load
str
Required

The total cluster load.

cluster_remaining_capacity
str
Required

The remaining capacity for the metric in the cluster. In future releases of Service Fabric this parameter will be deprecated in favor of ClusterCapacityRemaining.

cluster_capacity_remaining
str
Required

The remaining capacity for the metric in the cluster.

is_cluster_capacity_violation
bool
Required

Indicates that the metric is currently over capacity in the cluster.

node_buffer_percentage
str
Required

The reserved percentage of total node capacity for this metric.

cluster_buffered_capacity
str
Required

Remaining capacity in the cluster excluding the reserved space. In future releases of Service Fabric this parameter will be deprecated in favor of BufferedClusterCapacityRemaining.

buffered_cluster_capacity_remaining
str
Required

Remaining capacity in the cluster excluding the reserved space.

cluster_remaining_buffered_capacity
str
Required

The remaining percentage of cluster total capacity for this metric.

min_node_load_value
str
Required

The minimum load on any node for this metric. In future releases of Service Fabric this parameter will be deprecated in favor of MinimumNodeLoad.

minimum_node_load
str
Required

The minimum load on any node for this metric.

min_node_load_node_id
NodeId
Required

The node id of the node with the minimum load for this metric.

max_node_load_value
str
Required

The maximum load on any node for this metric. In future releases of Service Fabric this parameter will be deprecated in favor of MaximumNodeLoad.

maximum_node_load
str
Required

The maximum load on any node for this metric.

max_node_load_node_id
NodeId
Required

The node id of the node with the maximum load for this metric.

planned_load_removal
str
Required

This value represents the load of the replicas that are planned to be removed in the future within the cluster. This kind of load is reported for replicas that are currently being moving to other nodes and for replicas that are currently being dropped but still use the load on the source node.