LoadMetricInformation
Represents data structure that contains load information for a certain metric in a cluster.
Properties
| Name | Type | Required |
|---|---|---|
Name |
string | No |
IsBalancedBefore |
boolean | No |
IsBalancedAfter |
boolean | No |
DeviationBefore |
string (double) | No |
DeviationAfter |
string (double) | No |
BalancingThreshold |
string (double) | No |
Action |
string | No |
ActivityThreshold |
string (double) | No |
ClusterCapacity |
string | No |
ClusterLoad |
string | No |
CurrentClusterLoad |
string (double) | No |
ClusterRemainingCapacity |
string | No |
ClusterCapacityRemaining |
string | No |
IsClusterCapacityViolation |
boolean | No |
NodeBufferPercentage |
string (double) | No |
ClusterBufferedCapacity |
string | No |
BufferedClusterCapacityRemaining |
string (double) | No |
ClusterRemainingBufferedCapacity |
string | No |
MinNodeLoadValue |
string | No |
MinimumNodeLoad |
string (double) | No |
MinNodeLoadNodeId |
NodeId | No |
MaxNodeLoadValue |
string | No |
MaximumNodeLoad |
string (double) | No |
MaxNodeLoadNodeId |
NodeId | No |
PlannedLoadRemoval |
string (double) | No |
Name
Type: string
Required: No
Name of the metric for which this load information is provided.
IsBalancedBefore
Type: boolean
Required: No
Value that indicates whether the metrics is balanced or not before resource balancer run
IsBalancedAfter
Type: boolean
Required: No
Value that indicates whether the metrics is balanced or not after resource balancer run.
DeviationBefore
Type: string (double)
Required: No
The standard average deviation of the metrics before resource balancer run.
DeviationAfter
Type: string (double)
Required: No
The standard average deviation of the metrics after resource balancer run.
BalancingThreshold
Type: string (double)
Required: No
The balancing threshold for a certain metric.
Action
Type: string
Required: No
The current action being taken with regard to this metric
ActivityThreshold
Type: string (double)
Required: No
The Activity Threshold specified for this metric in the system Cluster Manifest.
ClusterCapacity
Type: string
Required: No
The total cluster capacity for a given metric
ClusterLoad
Type: string
Required: No
The total cluster load. In future releases of Service Fabric this parameter will be deprecated in favor of CurrentClusterLoad.
CurrentClusterLoad
Type: string (double)
Required: No
The total cluster load.
ClusterRemainingCapacity
Type: string
Required: No
The remaining capacity for the metric in the cluster. In future releases of Service Fabric this parameter will be deprecated in favor of ClusterCapacityRemaining.
ClusterCapacityRemaining
Type: string
Required: No
The remaining capacity for the metric in the cluster.
IsClusterCapacityViolation
Type: boolean
Required: No
Indicates that the metric is currently over capacity in the cluster.
NodeBufferPercentage
Type: string (double)
Required: No
The reserved percentage of total node capacity for this metric.
ClusterBufferedCapacity
Type: string
Required: No
Remaining capacity in the cluster excluding the reserved space. In future releases of Service Fabric this parameter will be deprecated in favor of BufferedClusterCapacityRemaining.
BufferedClusterCapacityRemaining
Type: string (double)
Required: No
Remaining capacity in the cluster excluding the reserved space.
ClusterRemainingBufferedCapacity
Type: string
Required: No
The remaining percentage of cluster total capacity for this metric.
MinNodeLoadValue
Type: string
Required: No
The minimum load on any node for this metric. In future releases of Service Fabric this parameter will be deprecated in favor of MinimumNodeLoad.
MinimumNodeLoad
Type: string (double)
Required: No
The minimum load on any node for this metric.
MinNodeLoadNodeId
Type: NodeId
Required: No
The node id of the node with the minimum load for this metric.
MaxNodeLoadValue
Type: string
Required: No
The maximum load on any node for this metric. In future releases of Service Fabric this parameter will be deprecated in favor of MaximumNodeLoad.
MaximumNodeLoad
Type: string (double)
Required: No
The maximum load on any node for this metric.
MaxNodeLoadNodeId
Type: NodeId
Required: No
The node id of the node with the maximum load for this metric.
PlannedLoadRemoval
Type: string (double)
Required: No
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.