├── Buildfile ├── Procfile ├── policy.json ├── locustfile.py ├── .ebextensions ├── setup.config ├── resources.config └── nginx │ └── nginx.conf ├── README.md └── LICENSE /Buildfile: -------------------------------------------------------------------------------- 1 | # Copyright 2015-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file 4 | # except in compliance with the License. A copy of the License is located at 5 | # 6 | # http://aws.amazon.com/apache2.0/ 7 | # 8 | # or in the "license" file accompanying this file. This file is distributed on an "AS IS" 9 | # BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 10 | # License for the specific language governing permissions and limitations under the License. 11 | 12 | build: ./build.rb 13 | -------------------------------------------------------------------------------- /Procfile: -------------------------------------------------------------------------------- 1 | # Copyright 2015-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file 4 | # except in compliance with the License. A copy of the License is located at 5 | # 6 | # http://aws.amazon.com/apache2.0/ 7 | # 8 | # or in the "license" file accompanying this file. This file is distributed on an "AS IS" 9 | # BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 10 | # License for the specific language governing permissions and limitations under the License. 11 | 12 | locust-master: /bin/bash -c "exec /usr/local/bin/locust -f locustfile.py --port=9876 --master" 13 | locust-follower: /bin/bash -c "exec /usr/local/bin/locust -f locustfile.py --port=9876 --slave --master-host=$(<.masterIP)" -------------------------------------------------------------------------------- /policy.json: -------------------------------------------------------------------------------- 1 | { 2 | "Version": "2012-10-17", 3 | "Statement": [ 4 | { 5 | "Sid": "DynamoDBPermissions", 6 | "Effect": "Allow", 7 | "Action": [ 8 | "dynamodb:GetItem", 9 | "dynamodb:UpdateItem" 10 | ], 11 | "Resource": [ 12 | "arn:aws:dynamodb:*:*:table/*-stack-MasterIPTable*" 13 | ] 14 | }, 15 | { 16 | "Sid": "ElasticBeanstalkPermissions", 17 | "Effect": "Allow", 18 | "Action": [ 19 | "autoscaling:DescribeAutoScalingGroups", 20 | "cloudformation:ListStackResources", 21 | "elasticbeanstalk:DescribeEnvironmentResources" 22 | ], 23 | "Resource": [ 24 | "*" 25 | ] 26 | } 27 | ] 28 | } -------------------------------------------------------------------------------- /locustfile.py: -------------------------------------------------------------------------------- 1 | # Copyright 2015-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file 4 | # except in compliance with the License. A copy of the License is located at 5 | # 6 | # http://aws.amazon.com/apache2.0/ 7 | # 8 | # or in the "license" file accompanying this file. This file is distributed on an "AS IS" 9 | # BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 10 | # License for the specific language governing permissions and limitations under the License. 11 | 12 | import os 13 | import string 14 | import random 15 | from locust import HttpLocust, TaskSet, task 16 | 17 | class MyTaskSet(TaskSet): 18 | @task(1000) 19 | def index(self): 20 | response = self.client.get("/") 21 | 22 | # This task will 15 times for every 1000 runs of the above task 23 | # @task(15) 24 | # def about(self): 25 | # self.client.get("/blog") 26 | 27 | # This task will run once for every 1000 runs of the above task 28 | # @task(1) 29 | # def about(self): 30 | # id = id_generator() 31 | # self.client.post("/signup", {"email": "example@example.com", "name": "Test"}) 32 | 33 | class MyLocust(HttpLocust): 34 | host = os.getenv('TARGET_URL', "http://localhost") 35 | task_set = MyTaskSet 36 | min_wait = 45 37 | max_wait = 50 38 | -------------------------------------------------------------------------------- /.ebextensions/setup.config: -------------------------------------------------------------------------------- 1 | # Copyright 2015-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file 4 | # except in compliance with the License. A copy of the License is located at 5 | # 6 | # http://aws.amazon.com/apache2.0/ 7 | # 8 | # or in the "license" file accompanying this file. This file is distributed on an "AS IS" 9 | # BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 10 | # License for the specific language governing permissions and limitations under the License. 11 | 12 | packages: 13 | yum: 14 | gcc-c++: [] 15 | python: 16 | pyzmq: [ "16.0.3" ] 17 | locustio: [ "0.8.1" ] 18 | 19 | option_settings: 20 | aws:elasticbeanstalk:application:environment: 21 | MASTER_IP_TABLE: '`{ "Ref" : "MasterIPTable"}`' 22 | EB_ENV_NAME: '`{"Ref" : "AWSEBEnvironmentName"}`' 23 | 24 | commands: 25 | create_home_dir: 26 | command: "mkdir /home/webapp | chown webapp:webapp /home/webapp" 27 | copy_deploy_manifest: 28 | command: "cp /opt/elasticbeanstalk/deploy/manifest /tmp/; chmod 777 /tmp/manifest" 29 | 30 | files: 31 | # add configuration to display the locust log files when tailing logs 32 | "/opt/elasticbeanstalk/tasks/taillogs.d/locustio.conf": 33 | owner: root 34 | group: root 35 | mode: "000644" 36 | content: | 37 | /var/log/locust-master*.log 38 | /var/log/locust-follower*.log 39 | -------------------------------------------------------------------------------- /.ebextensions/resources.config: -------------------------------------------------------------------------------- 1 | # Copyright 2015-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file 4 | # except in compliance with the License. A copy of the License is located at 5 | # 6 | # http://aws.amazon.com/apache2.0/ 7 | # 8 | # or in the "license" file accompanying this file. This file is distributed on an "AS IS" 9 | # BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 10 | # License for the specific language governing permissions and limitations under the License. 11 | 12 | Resources: 13 | MasterIPTable: 14 | Type: AWS::DynamoDB::Table 15 | Properties: 16 | KeySchema: 17 | HashKeyElement: {AttributeName: HashKey, AttributeType: S} 18 | ProvisionedThroughput: {ReadCapacityUnits: 1, WriteCapacityUnits: 1} 19 | SidewaysWWWRouting: 20 | Type: "AWS::EC2::SecurityGroupIngress" 21 | Properties: 22 | FromPort: "9876" 23 | ToPort: "9876" 24 | GroupName: { "Ref": "AWSEBSecurityGroup" } 25 | IpProtocol: "tcp" 26 | SourceSecurityGroupId: { "Fn::GetAtt": ["AWSEBSecurityGroup", "GroupId"] } 27 | FollowerToMaster: 28 | Type: "AWS::EC2::SecurityGroupIngress" 29 | Properties: 30 | FromPort: "5557" 31 | ToPort: "5558" 32 | GroupName: { "Ref": "AWSEBSecurityGroup" } 33 | IpProtocol: "tcp" 34 | SourceSecurityGroupId: { "Fn::GetAtt": ["AWSEBSecurityGroup", "GroupId"] } 35 | -------------------------------------------------------------------------------- /.ebextensions/nginx/nginx.conf: -------------------------------------------------------------------------------- 1 | # Copyright 2015-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved. 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file 4 | # except in compliance with the License. A copy of the License is located at 5 | # 6 | # http://aws.amazon.com/apache2.0/ 7 | # 8 | # or in the "license" file accompanying this file. This file is distributed on an "AS IS" 9 | # BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 10 | # License for the specific language governing permissions and limitations under the License. 11 | 12 | user nginx; 13 | error_log /var/log/nginx/error.log warn; 14 | pid /var/run/nginx.pid; 15 | worker_processes auto; 16 | 17 | events { 18 | worker_connections 1024; 19 | } 20 | 21 | http { 22 | include /etc/nginx/mime.types; 23 | default_type application/octet-stream; 24 | 25 | log_format main '$remote_addr - $remote_user [$time_local] "$request" ' 26 | '$status $body_bytes_sent "$http_referer" ' 27 | '"$http_user_agent" "$http_x_forwarded_for"'; 28 | 29 | access_log /var/log/nginx/access.log main; 30 | 31 | log_format healthd '$msec"$uri"' 32 | '$status"$request_time"$upstream_response_time"' 33 | '$http_x_forwarded_for'; 34 | 35 | server { 36 | listen 80; 37 | 38 | client_header_timeout 60; 39 | client_body_timeout 60; 40 | keepalive_timeout 60; 41 | gzip on; 42 | gzip_comp_level 4; 43 | 44 | if ($time_iso8601 ~ "^(\d{4})-(\d{2})-(\d{2})T(\d{2})") { 45 | set $year $1; 46 | set $month $2; 47 | set $day $3; 48 | set $hour $4; 49 | } 50 | 51 | access_log /var/log/nginx/healthd/application.log.$year-$month-$day-$hour healthd; 52 | 53 | location / { 54 | proxy_pass http://127.0.0.1:9876; 55 | proxy_http_version 1.1; 56 | 57 | proxy_set_header Host $host; 58 | proxy_set_header X-Real-IP $remote_addr; 59 | proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; 60 | } 61 | } 62 | } -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # AWS Elastic Beanstalk Load Generator Example 2 | This sample application uses the [Locust](http://locust.io/) open source load testing tool to create a simple load generator for your applications. The sample test definition *[locustfile.py](locustfile.py)* tests the root of an endpoint passed in as an environment variable *(TARGET_URL)*. For more information on the format of the test definition file, see [Writing a locustfile](http://docs.locust.io/en/latest/writing-a-locustfile.html). 3 | 4 | You can get started using the following steps: 5 | 1. [Install the AWS Elastic Beanstalk Command Line Interface (CLI)](http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/eb-cli3-install.html). 6 | 2. Create an IAM Instance Profile named **aws-elasticbeanstalk-locust-role** with the policy in [policy.json](policy.json). For more information on how to create an IAM Instance Profile, see [Create an IAM Instance Profile for Your Amazon EC2 Instances](https://docs.aws.amazon.com/codedeploy/latest/userguide/how-to-create-iam-instance-profile.html). 7 | 3. Run `eb init -r -p "Java 8"` to initialize the folder for use with the CLI. Replace `` with a region identifier such as `us-west-2` (see [Regions and Endpoints](https://docs.amazonaws.cn/en_us/general/latest/gr/rande.html#elasticbeanstalk_region) for a full list of region identifiers). For interactive mode, run `eb init` then, 8 | 1. Pick a region of your choice. 9 | 2. Select the **[ Create New Application ]** option. 10 | 3. Enter the application name of your choice. 11 | 4. Answer **no** to *It appears you are using Python. Is this correct?*. 12 | 5. Select **Java** as the platform. 13 | 6. Select **Java 8** as the platform version. 14 | 7. Choose whether you want SSH access to the Amazon EC2 instances. 15 | *Note: If you choose to enable SSH and do not have an existing SSH key stored on AWS, the EB CLI requires ssh-keygen to be available on the path to generate SSH keys.* 16 | 4. Run `eb create -i c4.large --scale 1 --envvars TARGET_URL= --instance_profile aws-elasticbeanstalk-locust-role` to begin the creation of your load generation environment. Replace `` with the URL of the web app that you want to test. 17 | *Note: If you don't have a default VPC (most AWS accounts created in 2014 or later should have a default VPC in the account) in your account, please substitue the above instance type with c3.large.* 18 | 1. Enter the environment name of your choice. 19 | 2. Enter the CNAME prefix you want to use for this environment. 20 | 5. Once the environment creation process completes, run `eb open` to open the [Locust](http://locust.io/) dashboard and start your tests. 21 | 6. To make changes to the test definition, edit the *[locustfile.py](locustfile.py)*, save and commit the changes, and run `eb deploy`. 22 | 7. If you'd like to scale out the environment to more than 1 EC2 instance, 23 | 1. Run `eb scale `. Replace `` with the number of EC2 instances you would like the environment to scale out to. 24 | 2. If you are reducing the number of running instances in the above step, run `eb deploy` to reselect the master instance removal has been completed. 25 | 3. Run `eb open` to open the [Locust](http://locust.io/) dashboard and start your tests. 26 | 8. When you are done with your tests, run `eb terminate --all` to clean up. 27 | 28 | *Note: Running Locust in distributed mode requires a master/slave architecture. This sample requires that the auto scaling minimum and maximum be set to the same value to ensure that the master isn't terminated by auto scaling. If for some reason the master instance is replaced, an `eb deploy` should be all it takes to fix it.* 29 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | --------------------------------------------------------------------------------