During Public Preview you can use the Team plan for free, and get an early-adopter discount at GA. Sign in
locally chaos
This page is part of the CLI Reference and is generated from the CLI's own help output, so it matches what locally chaos --help prints.
For more information see Chaos Engineering.
locally chaos
Simulate transient failures in Locally.
Simulate transient failures in Locally's control plane (ARM), directory (Microsoft Graph), identity (sign-in and tokens) or a data-plane service. Each fault has a rate, plus optional rules that override it for one location, plugin or resource name. Requests that match no rule use the fault's rate, so "everywhere except one place" is a rate of 100 plus a rule at 0. Most faults act on single requests. Scheduled faults, such as incident, freeze or restart, take --interval and act on the services in scope that often; on drop-connection and latency, --interval also cuts or delays connections that are already open, on the services that keep them. 'locally chaos enable' switches the control plane and data-plane services on or off; 'locally chaos directory enable' does the same for the directory and identity. Setting a fault switches its surface on. Examples: # Inject 500s on 10% of ARM requests locally chaos control-plane 500 --percentage 10 # An outage in one location, for one plugin only locally chaos control-plane outage --percentage 100 --location london --plugin Microsoft.Storage # Throttle everywhere EXCEPT one location locally chaos storage 429 --percentage 100 locally chaos storage 429 --percentage 0 --location london # Slow one storage account by up to 800 milliseconds locally chaos storage latency --percentage 100 --millis 800 --name acct1 # Throttle Microsoft Graph, asking clients to retry after 5 seconds locally chaos directory 429 --percentage 50 --retry-after 5s # Take Event Hubs down in one location, leaving the others running locally chaos eventhub outage --percentage 100 --location london # Every 30 seconds, maybe freeze a container group for 5 to 20 seconds locally chaos containerinstances freeze --percentage 50 --seconds 5-20 --interval 30s # Stop every sign-in from getting a token locally chaos identity outage --percentage 100 # Put one rule back, then everything back locally chaos storage 429 reset --location london locally chaos storage reset # See what is configured locally chaos show locally chaos control-plane show
Usage
locally chaos [flags] locally chaos [command]
Flags
-h, --help[=true|false] help for chaos
Subcommands
- locally chaos apimanagement - Simulate API Management (data plane) failure modes.
- locally chaos appconfiguration - Simulate App Configuration (data plane) failure modes.
- locally chaos containerapps - Simulate Container Apps (data plane) failure modes.
- locally chaos containerinstances - Simulate Container Instances (data plane) failure modes.
- locally chaos containerregistry - Simulate Container Registry (data plane) failure modes.
- locally chaos control-plane - Simulate ARM (control plane) failure modes.
- locally chaos cosmos - Simulate Cosmos DB (data plane) failure modes.
- locally chaos directory - Simulate Microsoft Graph (directory) failure modes.
- locally chaos disable - Turn chaos OFF for the control plane and data-plane services.
- locally chaos durabletask - Simulate Durable Task Scheduler (data plane) failure modes.
- locally chaos enable - Turn chaos ON for the control plane and data-plane services.
- locally chaos eventgrid - Simulate Event Grid (data plane) failure modes.
- locally chaos eventhub - Simulate Event Hubs (data plane) failure modes.
- locally chaos functions - Simulate Functions (data plane) failure modes.
- locally chaos horizondb - Simulate HorizonDB (data plane) failure modes.
- locally chaos identity - Simulate Entra ID tokens (identity) failure modes.
- locally chaos iothub - Simulate IoT Hub (data plane) failure modes.
- locally chaos keyvault - Simulate Key Vault (data plane) failure modes.
- locally chaos managedhsm - Simulate Managed HSM (data plane) failure modes.
- locally chaos monitor - Simulate Monitor (data plane) failure modes.
- locally chaos monitoringestion - Simulate Monitor ingestion (data plane) failure modes.
- locally chaos mysql - Simulate MySQL (data plane) failure modes.
- locally chaos postgresql - Simulate PostgreSQL (data plane) failure modes.
- locally chaos redis - Simulate Redis (data plane) failure modes.
- locally chaos servicebus - Simulate Service Bus (data plane) failure modes.
- locally chaos show - Print the chaos configuration for every subscription-scoped surface.
- locally chaos sql - Simulate SQL Database (data plane) failure modes.
- locally chaos storage - Simulate Storage (data plane) failure modes.
- locally chaos virtualmachines - Simulate Virtual Machines (data plane) failure modes.
- locally chaos webapps - Simulate Web Apps (data plane) failure modes.
locally chaos disable
Turn chaos OFF for the control plane and data-plane services.
Turn chaos OFF for the control plane and data-plane services. Disabling keeps every fault's configuration, so a later enable restores it.
Usage
locally chaos disable [flags]
Flags
-h, --help[=true|false] help for disable
--subscription string Subscription UUID (defaults to the configured default)
locally chaos enable
Turn chaos ON for the control plane and data-plane services.
Turn chaos ON for the control plane and data-plane services. Disabling keeps every fault's configuration, so a later enable restores it.
Usage
locally chaos enable [flags]
Flags
-h, --help[=true|false] help for enable
--subscription string Subscription UUID (defaults to the configured default)
locally chaos show
Print the chaos configuration for every subscription-scoped surface.
Print the chaos configuration for every subscription-scoped surface. Examples: locally chaos show
Usage
locally chaos show [flags]
Flags
-h, --help[=true|false] help for show
--subscription string Subscription UUID (defaults to the configured default)
During Public Preview you can use the Team plan for free, and get an early-adopter discount at GA. Sign in