Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 96 additions & 0 deletions docs/Configuring-K6-Test-in-Carrier.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
---
title: Configuring K6 Test in Carrier
author: User
date: 2025-01-20 12:00:00 +0800
categories: [Performance, Tutorial]
tags: [performance, carrier, backend-test, configuration]
render_with_liquid: false
---

## Overview

This guide provides step-by-step instructions for configuring a K6 test in Carrier. K6 is a modern load testing tool that provides a simple and powerful scripting environment for performance testing.

### Prerequisites

Before you begin configuring a K6 test in Carrier, ensure that you have completed the following:

- Installed and set up Carrier successfully.
- Created a project in Carrier.
- Configured Backend test.

### Steps

Follow the steps below to configure a K6 test in Carrier:

### Step 1: Access the Carrier Web Interface

1. Open a web browser and enter the URL of your Carrier installation.
2. Log in to the Carrier web interface using your credentials.

> Note: Make sure you have logged in using the appropriate user account that has all required accesses.
{: .prompt-info }

### Step 2: Select the Project

1. From the project dropdown menu, select the desired project where you want to configure the K6 test.
![Select Project](/assets/posts_img/select_prj.png)
2. Click "Go!" to navigate to the project's configuration page.

### Step 3: Navigate to the Backend Tab

1. In the project configuration page, click on the "Performance" tab located in the left menu.
![Performance Dropdown](/assets/posts_img/performance_dropdown.png)
2. Click on the "Backend" tab.
![Backend Page](/assets/posts_img/backend_page.png)

### Step 4: Configure K6 Test

1. Click on the "Add Test" button to create a new test.
![Add Test Button](/assets/posts_img/add_test_button.png)
2. Select "K6" from the list of available test types.
![Select K6 Test](/assets/posts_img/select_k6_test.png)
3. Fill in the following fields:
- **Test Name**: Enter a name for your K6 test.
- **Test Description**: Provide a brief description of the test.
- **Script**: Upload your K6 script file or paste the script code directly.
- **Load Configuration**: Set the number of virtual users (VUs), duration, and other load parameters.
![Configure K6 Test](/assets/posts_img/configure_k6_test.png)
4. Click the **Save** button to save the test configuration.

### Step 5: Execute K6 Test

1. To execute your K6 test, click on the triangle button next to the test name.
![Execute K6 Test](/assets/posts_img/execute_k6_test.png)
2. You can also change your test configuration before the test run. If all parameters are correct, just click the **Run** button.
![Test Configuration Before Run](/assets/posts_img/test_configuration_before_run.png)

### Step 6: View Test Results

1. The test execution status will appear in the Reports section.
![Test Status](/assets/posts_img/test_status.png)
2. To open test results, click on the result name.
![Test Results Name](/assets/posts_img/test_results_name.png)
3. In the opened page, you can view detailed test results, including metrics such as average throughput, error rate, response time, and more.
![Test Results Details](/assets/posts_img/test_results_details.png)

### Conclusion

By following these steps, you can successfully configure and execute a K6 test in Carrier. This will help you to perform load testing and analyze the performance of your backend services effectively.

> Note: For more detailed information on K6 scripting and advanced configurations, refer to the [K6 documentation](https://k6.io/docs/).
{: .prompt-info }

---

### References

- [Carrier Documentation](https://getcarrier.io/docs/)
- [K6 Documentation](https://k6.io/docs/)

---

### Review and Revise

- Proofread the entire document to correct grammatical and typographical errors.
- Revise the content for clarity and completeness, ensuring it fulfills its intended purpose effectively.