Added few more details in readme. Made result analyzer more flexible

Author: Mazhar Islam

walkthroughs/howto-k8s-appmesh-load-test/README.md

@@ -35,12 +35,27 @@ export VPC_ID=<VPC ID of the cluster, can be found using:  aws eks describe-clus
 ## Step 3: Configuring the Load Test
 All parameters of the mesh, load tests, metrics can be specified in `config.json`
 
-`backends_map` -: The mapping from each Virtual Node to its backend Virtual Services. For each unique node name in `backends_map`, 
-a VirtualNode, Deployment, Service and VirtualService (with its VirtualNode as its target) are created at runtime.
-
-`load_tests` -: Array of different test configurations that need to be run on the mesh. `url` is the service endpoint that Fortio (load generator) should hit.
-
-`metrics` -: Map of metric_name to the corresponding metric PromQL logic
+* `backends_map` -: The mapping from each Virtual Node to its backend Virtual Services. For each unique node name in `backends_map`, 
+a VirtualNode, Deployment, Service and VirtualService (with its VirtualNode as its target) are created at runtime. An example `backends_map` is following:
+   ```
+   "backends_map": {
+                       "0": ["1", "2"],
+                       "1": ["3"],
+                       "2": ["4"]
+                   },
+   ```
+   where the node names are `"0"`, `"1"`, `"2"`, `"3"` and `"4"`.
+
+* `load_tests` -: Array of different test configurations that need to be run on the mesh. 
+  * `url`: is the service endpoint that Fortio (load generator) should hit. The `url` format is: `http://service-<virtual-node-name>.tls-e2e.svc.cluster.local:9080/`. 
+   For example, based on the above `backends_map`, if we want to send the load traffic to the first virtual node `"0"`, then the `ulr` will look like:
+   `http://service-0.tls-e2e.svc.cluster.local:9080/`.
+  * `qps`: Total Queries Per Seconds fortio sends to the endpoints. 
+  * `t`: How long the test will run.
+  * `c`: Number of parallel simultaneous connections to the endpoints fortio hits.
+  * Optionally, you can add more load generation parameter by following the [Forito documentation](https://github.com/fortio/fortio).  
+
+* `metrics` -: Map of metric_name to the corresponding metric [PromQL logic](https://prometheus.io/docs/prometheus/latest/querying/operators/).
 
 ## Step 4: Running the Load Test
 Run the driver script using the below command -:

walkthroughs/howto-k8s-appmesh-load-test/scripts/analyze_load_test_data.py

@@ -14,6 +14,8 @@
 DIR_PATH = os.path.dirname(os.path.realpath(__file__))
 DATA_PATH = os.path.join(DIR_PATH, 'data')
 
+NODE_NAME = "0"
+
 
 def get_s3_data():
     res = subprocess.run(["aws sts get-caller-identity"], shell=True, stdout=subprocess.PIPE,
@@ -29,14 +31,14 @@ def get_s3_data():
 
 
 def plot_graph(actual_QPS_list, node_0_mem_list):
-    Y = [x for _, x in sorted(zip(actual_QPS_list, node_0_mem_list))]
-    X = sorted(actual_QPS_list)
+    x_y_tuple = [(x, y) for x, y in sorted(zip(actual_QPS_list, node_0_mem_list))]
+    X, Y = zip(*x_y_tuple)
     xpoints = np.array(X)
     ypoints = np.array(Y)
 
     plt.figure(figsize=(10, 5))
     plt.bar(xpoints, ypoints, width=20)
-    plt.ylabel('Node-0 (MiB)')
+    plt.ylabel('Node-{} (MiB)'.format(NODE_NAME))
     plt.xlabel('Actual QPS')
     print("Plotting graph...")
     plt.show()
@@ -67,9 +69,13 @@ def read_load_test_data():
                 with open(f) as csv_f:
                     c = csv.reader(csv_f, delimiter=',', skipinitialspace=True)
                     node_0_mem = []
+                    node_found = False
                     for line in c:
-                        if "node-0" in line[0]:
+                        if "node-" + NODE_NAME in line[0]:
                             node_0_mem.append(float(line[2]))
+                            node_found = True
+                    if not node_found:
+                        raise Exception("Node not found: {} in experiment file: {}".format(NODE_NAME, f))
                     max_mem = max(node_0_mem)
                     node_0_mem_list.append(max_mem)
                     attrb["max_mem"] = max_mem
@@ -80,7 +86,7 @@ def read_load_test_data():
     sorted_experiment_results = OrderedDict()
     for k, v in sorted(experiment_results.items(), key=lambda item: item[1]['max_mem']):
         sorted_experiment_results[k] = v
-    print("Experiment results sorted:\n")
+    print("Experiment results sorted:")
     pprint(sorted_experiment_results)
 
     return actual_qps_list, node_0_mem_list
@@ -93,5 +99,8 @@ def plot_qps_vs_container_mem():
 
 
 if __name__ == '__main__':
+    node_name = input('Enter the node name (or press enter for default node "0"): ')
+    if node_name != "":
+        NODE_NAME = node_name
     get_s3_data()
     plot_qps_vs_container_mem()

walkthroughs/howto-k8s-appmesh-load-test/scripts/constants.py

@@ -7,4 +7,4 @@
 PROMETHEUS_QUERY_ENDPOINT = 'http://localhost:9090/api/v1/query_range'
 
 # give your s3 bucket a unique name
-S3_BUCKET = "<username-appmeshloadtester"
+S3_BUCKET = "<username>-appmeshloadtester"