run-fargate - run an Artillery test on AWS Fargate

artillery run-fargate [options] <script>


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

--region <region>The AWS region to run in (us-east-1, us-west-1, eu-west-1, eu-central-1, ap-south-1, ap-northeast-1)
--count <num>Number of load generator containers to launch
--tags <tags>Comma-separated list of tags in key:value format to tag the test run, for example: --tags team:sre,service:foo
--note <text>Attach a note to a text, for example: --note "This is a spike test for service foo"
--cluster <name>Name of the Fargate cluster to run the test on. Artillery will create an empty cluster to run the test on by default if not specified.
--launch-config <json>
--max-duration <num>Maximum duration of the test run in seconds
--packages <path>Path to a package.json file to explicitly specify dependencies for the test script. If not set, Artillery will autodetect all dependencies.
--security-group-ids <ids>Comma-separated list of AWS VPC security group IDs to launch Fargate tasks in
--subnet-ids <ids>Comma-separated list of AWS VPC subnet IDs to launch Fargate tasks in
--task-role-name <role-name>IAM role name for Fargate containers to assume

Shared flags

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

--output, -oWrite a JSON report to a file
--environment, -eRun the test using the specified environment
--config, -cLoad config section from another file
--overridesOverride values in the test script dynamically
--target, -tSet or override target URL for the test
--variables, -vSet scenario variables dynamically
--dotenv <path>Set environment variables with a .env file
--insecure, -kTurn off TLS verification. Should not be used in production
--record and --keyRecord test run to Artillery Cloud (opens in a new tab). Learn more about recording test runs (opens in a new tab).