Autoscale Lab: Testing with Node.js and Grafana k6

This guide provides instructions for setting up an environment to test autoscaling capabilities using Node.js and Grafana k6.

Getting Started

Install Node.js

First, you need to install Node.js. Follow the instructions provided at the official Node.js website:

• How to Install Node.js

Install TypeScript

Next, install TypeScript to take advantage of typed JavaScript for more reliable code. Installation instructions can be found here:

• Download TypeScript

Running the Node.js Application

To run the Node.js application, follow these steps:

1. Build the Application

   Compile the TypeScript files to JavaScript:

   npm install
   npm run build
   npm start
   

2. Troubleshooting

   If you encounter issues during the build process, you can clean your build directory and try building the application again:

   npm run clean
   npm install
   npm run build
   npm start
   
   

3. Performance Testing with Grafana k6

   To conduct performance testing on your application, use Grafana k6 by running the following command:

   k6 run hello_test.js

   This command will execute the performance tests defined in hello_test.js, allowing you to analyze the scalability and performance of your Node.js application.

   For AWS LoadBalancer Testing replace http://localhost:80 with AWS LoadBalancer CName Record in hello_test.js

   let res = http.get('http://localhost:80/hello');
   

Using Bash Script to automate the manual steps

Installation and Setup

This section guides you through the setup of Node.js, TypeScript, and Grafana k6 on a Linux system. Follow these steps to prepare your environment for the project.

Using the Setup Script

To install Node.js, TypeScript, and Grafana k6, run the setup script provided in the repository:

cd bash_script
chmod +x init_project.sh
./init_project.sh

This script automates the installation of the latest versions of Node.js, TypeScript, and Grafana k6. Ensure you have the necessary permissions to execute the script.

Running Tests

After setting up your environment, you can run performance tests on your application using Grafana k6.

Using the Test Script

To execute the performance tests, use the test script as follows:

cd bash_script
chmod +x test_project.sh
./test_project.sh

This script builds the application, attempts to troubleshoot if the build fails, and runs performance tests using Grafana k6. It will notify you if the performance testing completes successfully or fails, allowing you to check the test scripts and environment for any issues.

Docker Container Setup

This project includes a Dockerfile for building a Docker image that simplifies the deployment process. Follow these steps to build and run your application within a Docker container.

Building the Docker Image

To build the Docker image, navigate to the root directory of the project where the Dockerfile is located and run the following command:

./docker_build.sh

Replace your-app-name with the name you wish to give your Docker image.

Running the Docker Container

After building the image, you can run your application inside a Docker container using the following command:

docker run -d -p 80:80 --name your-container-name your-app-name

This command runs the Docker container in detached mode, maps port 80 of the container to port 80 on the host, and names the container your-container-name. Replace your-container-name with the name you wish to give your Docker container and your-app-name with the name of your Docker image.

Accessing the Application

With the Docker container running, you can access the application by navigating to http://localhost:80 in your web browser.

Ensure you replace `your-app-name` and `your-container-name` with appropriate names for your Docker image and container. This section provides a basic guide for users to build and run the Dockerized version of your application.