run-fargate - run an Artillery test on AWS Fargate

artillery run-fargate [options] <script>

Options

The only required flag is --region which sets the region in which the test will run. The --count flag controls the horizontal scaling of the load test, i.e. setting --count 10 can be thought of as multiplying the load that will be generated by a factor of 10. All other flags are optional.

Fargate-specific flags

Configuring vCPU and memory with --cpu and --memory

You can configure the amount of CPU and memory available to each Artillery worker task running on Fargate with the --cpu and --memory flags. The default values are 4 vCPUs and 8 GB of memory.

When customizing the amount of CPU and memory a valid combination of values must be specified. You can learn more about valid combinations in the AWS documentation on https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-tasks-services.html#fargate-tasks-size (opens in a new tab).

Using --launch-config

You can customize the runtime environment of Artillery tasks running on ECS via the --launch-config flag. The following customizations are supported:

• cpu - The number of CPU units reserved (opens in a new tab) for each Artillery container. The default value is 1024.
• memory - The amount of memory (opens in a new tab) presented to the Artillery container. The default value is 2048 on Fargate and 1024 on classic ECS.
• environment - The environment variables to set in the Artillery worker container.
• ulimits - Customize ulimits (opens in a new tab) such as the number of available file descriptors (nofile).

Examples

Increase the amount of memory available to 8 GB and use 4 vCPUs for each task:

artillery run-fargate \
  --region us-east-1 \
  --count 10
  --launch-config '{"cpu": 4096, "memory": 8192}' \
  my-script.yaml

Increase the number of file descriptors for each worker:

artillery run-test \
  --region us-east-1 \
  --count 10 \
  --launch-config '{"ulimits":[{"name":"nofile","softLimit":"16384","hardLimit":"16384"}]}' \
  my-script.yaml

Run a test script setting two environment variables named VAR1 and VAR2 for Artillery workers running on ECS/Fargate.

Those environment variables will be available inside the Artillery test script via $env.VAR1 and $env.VAR2.

artillery run-test \
  --region us-east-1 \
  --count 10 \
  --launch-config '{"environment": [{"name":"VAR1", "value":"hello"},{"name":"VAR2","value":"world"}]}' \
  my-script.yaml

Using --spot

The --spot flag allows you to run using AWS Fargate spot (opens in a new tab), which has a much lower cost to run.

However, spot instances can randomly be terminated by AWS. This is ideal to use for running short tests (as it's unlikely the instance will be terminated), or for running tests that can tolerate interruptions.

Making additional files available in workers

Please use the includeFiles option to make any additional files available to workers.

Shared flags

The run-fargate command shares many options with the run command: