Share via

Start-ServiceFabricChaos

Module:
ServiceFabric Module

Starts a Chaos run in the cluster.

Syntax

Default (Default) 

Start-ServiceFabricChaos
    [-TimeToRunMinute <UInt32>]
    [-MaxConcurrentFaults <UInt32>]
    [-MaxClusterStabilizationTimeoutSec <UInt32>]
    [-WaitTimeBetweenIterationsSec <UInt32>]
    [-WaitTimeBetweenFaultsSec <UInt32>]
    [-EnableMoveReplicaFaults]
    [-Context <Hashtable>]
    [-ClusterHealthPolicy <ClusterHealthPolicy>]
    [-ChaosTargetFilter <ChaosTargetFilter>]
    [-TimeoutSec <Int32>]
    [<CommonParameters>]

Description

The Start-ServiceFabricChaos cmdlet starts a Chaos run in the cluster. Chaos induces faults in the cluster based on the received input parameters. A report of the faults induced as well as other events encountered during execution can be viewed by using the Get-ServiceFabricChaosReport cmdlet.

Chaos runs in multiple iterations. Each iteration consists of faults and cluster validation. You can control how long Chaos runs, how long it waits between iterations, how many faults it can induce during an iteration, and how long it waits between faults. Chaos validates cluster health between iterations.

Examples

Example 1: Start Chaos in the cluster

PS C:\> $clusterHealthPolicy = New-Object -TypeName System.Fabric.Health.ClusterHealthPolicy
PS C:\> $clusterHealthPolicy.MaxPercentUnhealthyNodes = 10
PS C:\> $clusterHealthPolicy.MaxPercentUnhealthyApplications = 20
PS C:\> $clusterHealthPolicy.ConsiderWarningAsError = $False
PS C:\> $clusterHealthPolicy.ApplicationTypeHealthPolicyMap.Add("CriticalAppType", 33)
PS C:\> $context = @{"k1" = "v1";"k2" = "v2"}
PS C:\> Start-ServiceFabricChaos -TimeToRunMinute 60 -MaxConcurrentFaults 3 -MaxClusterStabilizationTimeoutSec 60 -WaitTimeBetweenIterationsSec 30 -WaitTimeBetweenFaultsSec 5 -EnableMoveReplicaFaults -Context $context -ClusterHealthPolicy $clusterHealthPolicy

This command starts a Chaos run in the cluster. In this run, iterations are spaced at 30-second boundary. Within each iteration, chaos induces maximum of three faults. These faults are started at a gap of five seconds. This run, unless stopped by another method, will stop in 60 minutes.

If Chaos was already running, issuing this cmdlet has no effect.

Parameters

-ChaosTargetFilter

{{Fill ChaosTargetFilter Description}}

Parameter properties

Type:ChaosTargetFilter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ClusterHealthPolicy

Specifies how Chaos should behave under cluster health conditions.

Parameter properties

Type:ClusterHealthPolicy
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Context

A dictionary to hold details about why Chaos is being started.

Parameter properties

Type:Hashtable
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EnableMoveReplicaFaults

Indicates that Chaos can induce faults that can cause primary or secondary replicas to move.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MaxClusterStabilizationTimeoutSec

Specifies the maximum number of seconds that Chaos waits for the cluster to get to healthy state. If cluster is not healthy, a ValidationFailedEvent (/dotnet/api/system.fabric.chaos.datastructures.validationfailedevent) is logged in Chaos report. This value cannot exceed the total seconds in [TimeSpan.MaxValue](https://msdn.microsoft.com/library/system.timespan.maxvalue(v=vs.110.aspx) (https://msdn.microsoft.com/library/system.timespan.maxvalue(v=vs.110.aspx).

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MaxConcurrentFaults

Specifies the maximum number of faults that Chaos induces in parallel. Chaos runs in iterations. Two consecutive iterations are separated by a validation period. In a single iteration, Chaos induces at most the number of faults that you specify. Recommended value is 2 or 3.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TimeoutSec

Specifies the time-out period, in seconds, for the operation.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TimeToRunMinute

Specifies how long Chaos runs, in minutes; cannot exceed (1/60)uint.MaxValue. Alternatively, you can stop Chaos by using the Stop-ServiceFabricChaos cmdlet or the StopChaosAsync method (/dotnet/api/system.fabric.fabricclient.testmanagementclient#System_Fabric_FabricClient_TestManagementClient_StopChaosAsync_System_TimeSpan_System_Threading_CancellationToken_).

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WaitTimeBetweenFaultsSec

Specifies how long Chaos waits, in seconds, between two consecutive faults in one iteration. If you specify a larger value, the number of concurrent faults is lower. The maximum allowed value is UInt32.MaxValue.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WaitTimeBetweenIterationsSec

Specifies how long Chaos waits, in seconds, between iterations. The maximum allowed value is UInt32.MaxValue.

Parameter properties

Type:UInt32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

System.Object