AWS solutions documentation change
Summary
Restructured documentation to organize test types (JMeter, K6, Locust) under 'Test types' section, added HTTP endpoint testing configuration details, clarified Traffic Shape parameter overrides, expanded scheduling options with cron expressions, and updated monitoring descriptions.
Security assessment
The change adds documentation about configuring HTTP endpoints with authorization tokens in request headers, which demonstrates security feature usage. However, there is no evidence of addressing a specific vulnerability or security incident. The AGPL-3.0 license mention for K6 relates to licensing compliance rather than security.
Diff
diff --git a/solutions/latest/distributed-load-testing-on-aws/design-considerations.md b/solutions/latest/distributed-load-testing-on-aws/design-considerations.md index 60dc894c9..97ded1f0d 100644 --- a//solutions/latest/distributed-load-testing-on-aws/design-considerations.md +++ b//solutions/latest/distributed-load-testing-on-aws/design-considerations.md @@ -5 +5 @@ -Supported applicationsJMeter script supportK6 script supportLocust script supportScheduling testsConcurrent testsUser managementRegional deployment +Supported applicationsTest typesScheduling testsConcurrent testsUser managementRegional deployment @@ -8,0 +9,2 @@ Supported applicationsJMeter script supportK6 script supportLocust script suppor +This section describes important design decisions and configuration options for the Distributed Load Testing on AWS solution, including supported applications, test types, scheduling options, and deployment considerations. + @@ -11 +13,9 @@ Supported applicationsJMeter script supportK6 script supportLocust script suppor -This solution supports cloud-based applications, and on-premises applications as long as you have a network connection from your AWS account to your application. The solution supports APIs that use either HTTP or HTTPS. You also have control over the HTTP request headers, so you can add authorization or custom headers to pass tokens or API keys. +This solution supports testing cloud-based applications and on-premises applications as long as you have network connectivity from your AWS account to your application. The solution supports APIs that use HTTP or HTTPS protocols. + +## Test types + +Distributed Load Testing on AWS supports multiple test types: simple HTTP endpoint tests, JMeter, K6, and Locust. + +### Simple HTTP endpoint tests + +The web console provides an HTTP Endpoint Configuration interface that allows you to test any HTTP or HTTPS endpoint without writing custom scripts. You define the endpoint URL, select the HTTP method (GET, POST, PUT, DELETE, etc.) from a dropdown menu, and optionally add custom request headers and body payloads. This configuration enables you to test APIs with custom authorization tokens, content types, or any other HTTP headers and request bodies required by your application. @@ -13 +23 @@ This solution supports cloud-based applications, and on-premises applications as -## JMeter script support +### JMeter tests @@ -15 +25,5 @@ This solution supports cloud-based applications, and on-premises applications as -When creating a test scenario using this solution’s user interface (UI), you can use a JMeter test script. After selecting the JMeter script file, it is uploaded to the _< stack-name>_-scenariosbucket Amazon Simple Storage Service (Amazon S3) bucket. When Amazon Elastic Container Service (Amazon ECS) tasks are running, the JMeter script downloads from the _< stack-name>_-scenariosbucket Amazon S3 bucket and the test runs. +When creating a test scenario using the web console, you can upload a JMeter test script. The solution uploads the script to the scenarios S3 bucket. When Amazon ECS tasks run, they download the JMeter script from S3 and execute the test. + +###### Important + +Although your JMeter script may define concurrency (virtual users), transaction rates (TPS), ramp-up times, and other load parameters, the solution will override these configurations with the values you specify in the Traffic Shape screen during test creation. The Traffic Shape configuration controls the task count, concurrency (virtual users per task), ramp-up duration, and hold duration for the test execution. @@ -29 +43,5 @@ For more information about how to use JMeter scripts, refer to [JMeter User’s -## K6 script support +### K6 tests + +The solution supports K6 framework-based testing. K6 is released under the [AGPL-3.0 license](https://github.com/grafana/k6/blob/master/LICENSE.md). The solution displays a license acknowledgment message when creating a new K6 test. You can upload the K6 test file along with any necessary input files in an archive file. + +###### Important @@ -31 +49 @@ For more information about how to use JMeter scripts, refer to [JMeter User’s -The solution supports K6 framework-based testing. K6 is released with [AGPL-3.0 license](https://github.com/grafana/k6/blob/master/LICENSE.md). The solution displays a license acknowledgment message when creating a new test for K6. The K6 test file along with any necessary input files can be included in an archive file and uploaded for the test scenario using the upload option. +Although your K6 script may define concurrency (virtual users), stages, thresholds, and other load parameters, the solution will override these configurations with the values you specify in the Traffic Shape screen during test creation. The Traffic Shape configuration controls the task count, concurrency (virtual users per task), ramp-up duration, and hold duration for the test execution. @@ -33 +51 @@ The solution supports K6 framework-based testing. K6 is released with [AGPL-3.0 -## Locust script support +### Locust tests @@ -35 +53,5 @@ The solution supports K6 framework-based testing. K6 is released with [AGPL-3.0 -The solution supports Locust framework-based testing. The Locust test file along with any necessary input files can be included in an archive file and uploaded for the test scenario using the upload option. +The solution supports Locust framework-based testing. You can upload the Locust test file along with any necessary input files in an archive file. + +###### Important + +Although your Locust script may define concurrency (user count), spawn rate, and other load parameters, the solution will override these configurations with the values you specify in the Traffic Shape screen during test creation. The Traffic Shape configuration controls the task count, concurrency (virtual users per task), ramp-up duration, and hold duration for the test execution. @@ -39 +61,12 @@ The solution supports Locust framework-based testing. The Locust test file along -You can schedule tests to run at a future date or use the **Run Now** option. You can schedule a test as a one-time run in the future or set up a recurring test in which you specify a first run date, and planned recurrence. The options for recurrence include: daily, weekly, bi-weekly, and monthly. For more information on how scheduling works, refer to the [Test scheduling workflow](https://docs.aws.amazon.com/solutions/latest/distributed-load-testing-on-aws/test-scheduling-workflow.html) section of this guide. +The solution provides three execution timing options for running load tests: + + * **Run Now** \- Execute the load test immediately after creation + + * **Run Once** \- Execute the test on a specific date and time in the future + + * **Run on a Schedule** \- Create recurring tests using cron expressions to define the schedule + + + + +When you select **Run Once** , you specify the run time in 24-hour format and the run date when the load test should start running. @@ -41 +74 @@ You can schedule tests to run at a future date or use the **Run Now** option. Yo -Starting in version 3.3.0, Distributed Load Testing on AWS allows users to schedule load tests using cron expressions. Select **Run on Schedule** and then the **CRON tab** to either manually enter a cron value or use the drop-down fields. The cronExpiryDate must match the scheduled test run date. Review the **Next Run Dates (UTC)** to confirm your schedule. +When you select **Run on a Schedule** , you can either manually enter a cron expression or select from common cron patterns (such as every hour, daily at a specific time, weekdays, or monthly). The cron expression uses a fine-grained schedule format with fields for minutes, hours, day of month, month, day of week, and year. You must also specify an expiry date, which defines when the scheduled test should stop running. For more information on how scheduling works, refer to the [Test scheduling workflow](https://docs.aws.amazon.com/solutions/latest/distributed-load-testing-on-aws/test-scheduling-workflow.html) section of this guide. @@ -56 +89 @@ Starting in version 3.3.0, Distributed Load Testing on AWS allows users to sched -This solution includes an Amazon CloudWatch dashboard for each test and displays the combined output of all tasks running for that test in the Amazon ECS cluster in real-time. The CloudWatch dashboard displays the average response time, the number of concurrent users, the number of successful requests, and the number of failed requests. Each metric is aggregated by the second, and the dashboard is updated every minute. +This solution creates an Amazon CloudWatch dashboard for each test that displays the combined output of all tasks running in the Amazon ECS cluster in real time. The CloudWatch dashboard shows average response time, number of concurrent users, number of successful requests, and number of failed requests. The solution aggregates each metric by the second and updates the dashboard every minute.