ActivationRebalancerOptions Class

Reference

Definition

Namespace:: Orleans.Configuration

Assembly:: Orleans.Runtime.dll

Package:: Microsoft.Orleans.Runtime v9.0.0

Package:: Microsoft.Orleans.Runtime v9.1.2

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Options for configuring activation rebalancing.

public sealed class ActivationRebalancerOptions

type ActivationRebalancerOptions = class

Public NotInheritable Class ActivationRebalancerOptions

Inheritance: Object
ActivationRebalancerOptions

Constructors

ActivationRebalancerOptions()

Fields

DEFAULT_ACTIVATION_MIGRATION_COUNT_LIMIT	The default value for ActivationMigrationCountLimit. The default is practically no limit.
DEFAULT_ALLOWED_ENTROPY_DEVIATION	The default value of AllowedEntropyDeviation.
DEFAULT_CYCLE_NUMBER_WEIGHT	The default value of CycleNumberWeight.
DEFAULT_ENTROPY_QUANTUM	The default value of EntropyQuantum.
DEFAULT_MAX_STAGNANT_CYCLES	The default value of MaxStagnantCycles.
DEFAULT_REBALANCER_DUE_TIME	The default value of RebalancerDueTime.
DEFAULT_SCALE_ALLOWED_ENTROPY_DEVIATION	The default value of ScaleAllowedEntropyDeviation.
DEFAULT_SCALED_ENTROPY_DEVIATION_ACTIVATION_THRESHOLD	The default value of ScaledEntropyDeviationActivationThreshold.
DEFAULT_SESSION_CYCLE_PERIOD	The default value of SessionCyclePeriod.
DEFAULT_SILO_NUMBER_WEIGHT	The default value of SiloNumberWeight.
MAX_SCALED_ENTROPY_DEVIATION	The maximum value allowed when ScaleAllowedEntropyDeviation is `true`.

Properties

ActivationMigrationCountLimit	The maximum allowed number of activations that can be migrated at any given cycle.
AllowedEntropyDeviation	Represents the allowed entropy deviation between the cluster's current entropy, against the theoretical maximum. Values lower than this are practically considered as "maximum", and the current rebalancing session will stop. This acts as a base rate if ScaleAllowedEntropyDeviation is set to `true`.
CycleNumberWeight	Represents the weight that is given to the number of rebalancing cycles that have passed during a rebalancing session. Changing this value has a far greater impact on the migration rate than SiloNumberWeight, and is suitable for controlling the session duration. Pick higher values if you want a faster migration rate.
EntropyQuantum	The minimum change in the entropy of the cluster that is considered an improvement. When a total of n-consecutive stagnant cycles pass, during which the change in entropy is less than the quantum, then the current rebalancing session will stop. The change is a normalized value being relative to the maximum possible entropy.
MaxStagnantCycles	The maximum, consecutive number of cycles, yielding no significant improvement to the cluster's entropy.
RebalancerDueTime	The due time for the rebalancer to start the very first session.
ScaleAllowedEntropyDeviation	Determines whether AllowedEntropyDeviation should be scaled dynamically based on the total number of activations. When set to `true`, the allowed entropy deviation will increase logarithmically after reaching ScaledEntropyDeviationActivationThreshold, and will cap at MAX_SCALED_ENTROPY_DEVIATION.
ScaledEntropyDeviationActivationThreshold	Determines the number of activations that must be active during any rebalancing cycle, in order for ScaleAllowedEntropyDeviation (if, and only if, its `true`) to begin scaling the AllowedEntropyDeviation.
SessionCyclePeriod	The time between two consecutive rebalancing cycles within a session.
SiloNumberWeight	Represents the weight that is given to the number of silos in the cluster during a rebalancing session. Changing this value has a far lesser impact on the migration rate than CycleNumberWeight, and is suitable for fine-tuning. Pick lower values if you want a faster migration rate.

Applies to

Dela via