Skip to content

Commit 46872cd

Browse files
author
Pepe Cano
authored
Reorganize and Update Cloud FAQ (#171)
* refactor-cloud-faq * Cloud FAQ: update Virtual Users question * Cloud FAQ: Data Retention * Data retention Redirect * Debuggin in the Cloud * Cloud FAQ: IPs and Firewall * Cloud FAQ: Test status codes * Cloud FAQ: I was invited to an org * General Questions Page * Fix redirects * Dedicated IP question and sidebar content * Add separator to Cloud FAQ questions
1 parent 38af352 commit 46872cd

22 files changed

+568
-684
lines changed

gatsby-node.js

+64-1
Original file line numberDiff line numberDiff line change
@@ -554,10 +554,73 @@ const createRedirects = ({ actions, pathPrefix }) => {
554554
});
555555

556556
createRedirect({
557-
fromPath: '/docs/cloud/creating-and-running-a-test/converters',
557+
fromPath: '/cloud/creating-and-running-a-test/converters',
558558
toPath: '/integrations',
559559
isPermanent: true,
560560
});
561+
562+
createRedirect({
563+
fromPath: '/cloud/integrations/ci',
564+
toPath: '/integrations',
565+
isPermanent: true,
566+
});
567+
568+
createRedirect({
569+
fromPath: '/cloud/cloud-faq/calculating-virtual-uses-with-google-analytics',
570+
toPath: 'https://k6.io/blog/monthly-visits-concurrent-users',
571+
isPermanent: true,
572+
});
573+
574+
createRedirect({
575+
fromPath: '/cloud/cloud-faq/what-is-data-retention',
576+
toPath: '/cloud/billing-user-menu/data-retention',
577+
isPermanent: true,
578+
});
579+
580+
createRedirect({
581+
fromPath: '/cloud/cloud-faq/pricing-faq',
582+
toPath: '/cloud/cloud-faq/pricing-questions',
583+
isPermanent: true,
584+
});
585+
586+
createRedirect({
587+
fromPath: '/cloud/cloud-faq/what-ip-addresses-are-used-by-the-k6-cloud',
588+
toPath: '/cloud/cloud-faq/general-questions',
589+
isPermanent: true,
590+
});
591+
createRedirect({
592+
fromPath:
593+
'/cloud/cloud-faq/what-is-the-best-way-to-debug-my-load-test-scripts',
594+
toPath: '/cloud/cloud-faq/general-questions',
595+
isPermanent: true,
596+
});
597+
createRedirect({
598+
fromPath:
599+
'/cloud/cloud-faq/i-was-invited-to-an-organization-and-i-cannot-run-tests',
600+
toPath: '/cloud/cloud-faq/general-questions',
601+
isPermanent: true,
602+
});
603+
createRedirect({
604+
fromPath:
605+
'/cloud/cloud-faq/how-to-open-your-firewall-to-k6-cloud-service-for-cloud-executed-tests',
606+
toPath: '/cloud/cloud-faq/general-questions',
607+
isPermanent: true,
608+
});
609+
createRedirect({
610+
fromPath: '/cloud/cloud-faq/test-status-codes',
611+
toPath: '/cloud/cloud-faq/general-questions',
612+
isPermanent: true,
613+
});
614+
createRedirect({
615+
fromPath: '/cloud/cloud-faq/what-are-vus-virtual-users',
616+
toPath: '/cloud/cloud-faq/general-questions',
617+
isPermanent: true,
618+
});
619+
createRedirect({
620+
fromPath: '/cloud/cloud-faq/data-uploads-with-k6-cloud',
621+
toPath: '/cloud/cloud-faq/general-questions',
622+
isPermanent: true,
623+
});
561624
};
562625

563626
exports.createPages = async (options) => {

src/data/markdown/docs/01 guides/04 Results visualization/02 Cloud.md

+10-3
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ title: 'Cloud'
33
excerpt: ''
44
---
55

6-
Besides [running cloud tests](/cloud/creating-and-running-a-test/cloud-tests-from-the-cli), you can also stream your test results in real-time to the [k6 Cloud](/cloud).
6+
Besides [running cloud tests](/cloud/creating-and-running-a-test/cloud-tests-from-the-cli), you can also run a test locally and stream the results to the [k6 Cloud](/cloud).
77

8-
The k6 Cloud will pre-process your data, and you can visualize and analyze the results on the web app.
8+
When streaming the results to the k6 Cloud, the machine - where you execute the k6 CLI command - runs the test and uploads the results to the k6 Cloud. Then, you will be able to visualize and analyze the results on the web app in real-time.
99

1010
## Instructions
1111

@@ -61,8 +61,15 @@ execution: local
6161

6262
![k6 Cloud Test Results](./images/Cloud/k6-cloud-results.png)
6363

64+
> When you send the results to the k6 Cloud, data will be continuously streamed to the cloud. While this happens the state of the test run will be marked as `Running`. A test run that ran its course will be marked `Finished`. The run state has nothing to do with the test passing any thresholds, only that the test itself is operating correctly.
65+
>
66+
> If you deliberately abort your test (e.g. by pressing _Ctrl-C_), it will still be considered `Finished`. You can still look and analyze the test data you streamed so far. The test will just have run shorter than originally planned.
67+
>
68+
> Another possibility would be if you lose network connection with the k6 Cloud while your test is running. In that case the k6 Cloud will patiently wait for you to reconnect. In the meanwhile your test's run state will continue to appear as `Running` on the web app.
69+
>
70+
> If no reconnection happens, the k6 Cloud will time out after two minutes of no data, setting the run state to `Timed out`. You can still analyze a timed out test but you'll of course only have access to as much data as was streamed before the network issue.
71+
6472
## See also
6573

6674
- [Analyzing results on the k6 Cloud](/cloud/analyzing-results/overview)
6775
- [Running cloud tests](/cloud/creating-and-running-a-test/cloud-tests-from-the-cli)
68-
- [Cloud test run status - Uploading results](/cloud/cloud-faq/test-status-codes#uploading-results)

src/data/markdown/docs/01 guides/07 Misc/06 Glossary.md

+16-2
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,20 @@ A **test script** is the actual code you run as part of your test run, as well a
170170

171171
Virtual Users, although emulated by k6 itself, can be used to mimic the behavior of a real user.
172172

173-
VUs typically perform requests at a much higher rate than regular users. Because of this, there is seldom any need for anywhere near as many virtual users as the actual user target.
173+
**Virtual Users in context of Web Apps/Websites**
174174

175-
For additional details, see [What are virtual users?](/cloud/cloud-faq/what-are-vus-virtual-users).
175+
Virtual Users are designed to act and behave like real users/browsers would. That is, they are capable of making multiple network connections in parallel, just like a real user in a browser would. When using a [http.batch](/using-k6/options#batch) request, HTTP requests are sent in parallel. For further information, refer to the article about [load testing websites](/testing-guides/load-testing-websites).
176+
177+
<CodeGroup labels={["Formula for calculating the number of VUs needed"]}>
178+
179+
```plain
180+
VUs = (hourly sessions * average session duration in seconds)/3600
181+
```
182+
183+
</CodeGroup>
184+
185+
Read more about using this formula in the [tutorial to calculate the number of Virtual Users with Google Analytics](https://k6.io/blog/monthly-visits-concurrent-users).
186+
187+
**Virtual Users in context of APIs**
188+
189+
When testing individual API endpoints, you can take advantage of each VU making multiple requests each to produce requests per second(rps) a factor higher than your VU count. e.g. Your test may be stable with each VU making 10 rps each. If you wanted to reach 1000 RPS, you may only need 100 VUs in that case. For more information on testing APIs, please refer to our article [API Load Testing](/testing-guides/api-load-testing).

src/data/markdown/docs/03 cloud/05 Billing & User Menu/02 Subscription.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,4 @@ To downgrade your subscription, you may select a new plan at any time. We will b
2323

2424
## Cancelation / Data Retention
2525

26-
You may cancel your online subscription at any time through the web app. When canceling you are able to opt into Data Retention to save your result data longer term / between projects. If you do not choose data retention all test result data is deleted 7 days after your subscription expires. When canceling you may use your plan through the end of the current period.
26+
You may cancel your online subscription at any time through the web app. When canceling you are able to opt into [Data Retention](/cloud/billing-user-menu/data-retention) to save your result data longer term / between projects. If you do not choose data retention all test result data is deleted 7 days after your subscription expires. When canceling you may use your plan through the end of the current period.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: 'Data Retention'
3+
excerpt: 'What is k6 data retention and how does it work?'
4+
---
5+
6+
Data retention refers to the policy that specifies how long the k6 Cloud service will keep your test result data.
7+
8+
k6 differentiates between test result data and your user data (projects, profiles, etc.). In terms of data retention, we are referring only to test result data. Your **user data and test configurations are saved indefinitely** on your user profile.
9+
10+
<Blockquote mod="warning">
11+
12+
Data is retained on a rolling basis. **Test result data older than what is specified in your plan is automatically deleted**. If you need to save data, please be sure to export, set the test as baseline, or purchase a period of data retention that meets your requirements.
13+
14+
</Blockquote>
15+
16+
## How long is my data retained
17+
18+
Data is retained on a rolling basis, depending on your subscription. For plans with 1 month of data retention, we will retain data for 30 days from the test run. After that period the data is deleted. This rolling period only applies while you have an active subscription. If you cancel your subscription, data is retained for 7 days past subscription expiration.
19+
20+
21+
## How do I save my baseline test result
22+
23+
**Baseline test results** are exempt from data retention rules and are **saved indefinitely.**
24+
25+
You can select a single test run per test as a baseline test. The purpose of this is to serve as a point of comparison for future tests. To mark a test as baseline, use the three dot menu in the top right corner of your test run and click `Set as Baseline`.
26+
27+
![Set as baseline](images/04-data-retention/set-as-baseline.png)
28+
29+
## Can I export my data
30+
31+
Yes, you can export your test results. Read more [here](/cloud/analyzing-results/result-export).
32+
33+
## When can I purchase Data Retention
34+
35+
Every subscription plan automatically includes a period of data retention that specifies how long the k6 Cloud retains your test results. For more info about each plan's data retention policy, read [How long is my data retained](#how-long-is-my-data-retained) and visit the [pricing page](https://k6.io/pricing/).
36+
37+
If you need a data retention policy longer than specified in our plans, please reach out to support for pricing information.
38+
39+
## Buying a Data Retention plan after cancelation
40+
41+
When canceling your subscription, you are able to buy a Data Retention plan. This plan allows you to retain your result data at a lower rate between testing periods.

0 commit comments

Comments
 (0)