You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/sources/next/_index.md
+56-74Lines changed: 56 additions & 74 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,103 +3,85 @@ aliases:
3
3
- /docs/k6/
4
4
description: 'The k6 documentation covers everything you need to know about k6 OSS, load testing, and performance testing.'
5
5
menuTitle: Grafana k6
6
-
title: Grafana k6 documentation
6
+
title: Grafana k6
7
7
weight: -10
8
+
hero:
9
+
title: Grafana k6
10
+
level: 1
11
+
image: /media/docs/k6/GrafanaLogo_k6_icon.svg
12
+
width: 100
13
+
height: 100
14
+
description: Grafana k6 is an open-source, developer-friendly, and extensible load testing tool. k6 allows you to prevent performance issues and proactively improve reliability.
15
+
cards:
16
+
title_class: pt-0 lh-1
17
+
items:
18
+
- title: Run your first k6 test
19
+
href: ./get-started/
20
+
description: Learn how to install the k6 CLI, run your first k6 test, and view metric results in the terminal.
21
+
height: 24
22
+
- title: Using k6
23
+
href: ./using-k6/
24
+
description: Learn about k6 options and concepts such as thresholds, metrics, lifecycle hooks, and more.
25
+
height: 24
26
+
- title: Testing guides
27
+
href: ./testing-guides/
28
+
description: Discover how to plan and define your performance testing strategy with these guides.
29
+
height: 24
30
+
- title: k6 JavaScript API
31
+
href: ./javascript-api/
32
+
description: Explore the k6 APIs through their documentation and examples.
33
+
height: 24
34
+
- title: Explore k6 extensions
35
+
href: ./extensions/
36
+
description: Have a particular testing need? Find k6 extensions that extend the native k6 functionality.
37
+
height: 24
38
+
- title: k6 script examples
39
+
href: ./extensions/
40
+
description: Learn how to script your tests with this list of common k6 examples.
41
+
height: 24
8
42
---
9
43
10
-
# Grafana k6 documentation
44
+
{{< docs/hero-simple key="hero" >}}
11
45
12
-
This documentation will help you go from a total beginner to a seasoned k6 expert!
<p>Learn how to leverage the results output to gain actionable insight about your application's performance.</p>
28
-
</a>
29
-
</div>
30
-
31
-
## What is k6?
32
-
33
-
Grafana k6 is an open-source load testing tool that makes performance testing easy and productive for engineering teams.
34
-
k6 is free, developer-centric, and extensible.
35
-
36
-
Using k6, you can test the reliability and performance of your systems and catch performance regressions and problems earlier.
37
-
k6 will help you to build resilient and performant applications that scale.
46
+
---
38
47
39
-
k6 is developed by [Grafana Labs](https://grafana.com/) and the community.
48
+
## Overview
40
49
41
-
Watch the video below to learn more about k6 and why it could be the missing puzzle in your Grafana stack.
50
+
Using k6, you can test the reliability and performance of your application and infrastructure.
42
51
43
-
{{< youtube id="1mtYVDA2_iQ" >}}
52
+
k6 helps engineering teams prevent errors and SLO breaches, enabling them to build resilient and high-performing applications that scale.
44
53
45
-
## Key features
54
+
Engineering teams, including Developers, QA Engineers, SDETs, and SREs, commonly use k6 for:
46
55
47
-
k6 is packed with features, which you can learn all about in the documentation.
48
-
Key features include:
56
+
-**Load and performance testing**
49
57
50
-
-[CLI tool](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/k6-options/how-to) with developer-friendly APIs.
51
-
- Scripting in JavaScript ES2015/ES6 - with support for [local and remote modules](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/modules)
52
-
-[Checks](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/checks) and [Thresholds](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/thresholds) - for goal-oriented, automation-friendly load testing
58
+
k6 is optimized for minimal resource consumption and designed for running high-load performance tests such as
59
+
[spike](https://grafana.com/docs/k6/<K6_VERSION>/testing-guides/test-types/spike-testing), [stress](https://grafana.com/docs/k6/<K6_VERSION>/testing-guides/test-types/stress-testing), or [soak tests](https://grafana.com/docs/k6/<K6_VERSION>/testing-guides/test-types/soak-testing).
53
60
54
-
## Use cases
61
+
-**Browser performance testing**
55
62
56
-
k6 users are typically Developers, QA Engineers, SDETs, and SREs.
57
-
They use k6 for testing the performance and reliability of APIs, microservices, and websites.
58
-
Common k6 use cases are:
63
+
Through the [k6 browser API](https://grafana.com/docs/k6/<K6_VERSION>/using-k6-browser), you can run browser-based performance tests and collect browser metrics to identify performance issues related to browsers. Additionally, you can mix browser tests with other performance tests to get a comprehensive view of your website's performance.
59
64
60
-
-**Load testing**
65
+
-**Performance and synthetic monitoring**
61
66
62
-
k6 is optimized for minimal resource consumption and designed for running high load tests
You can schedule tests to run with minimal load very frequently, continuously validating the performance and availability of your production environment. For this, you can also use [Grafana Cloud Synthetic Monitoring](https://grafana.com/docs/grafana-cloud/testing/synthetic-monitoring/create-checks/checks/k6/), which supports running k6 scripts.
64
68
65
-
-**Browser testing**
69
+
-**Automation of performance tests**
66
70
67
-
Through [k6 browser](https://grafana.com/docs/k6/<K6_VERSION>/using-k6-browser), you can run browser-based performance testing and catch issues related to browsers only which can be skipped entirely from the protocol level.
71
+
k6 integrates seamlessly with CI/CD and automation tools, enabling engineering teams to [automate performance testing](https://grafana.com/docs/k6/<K6_VERSION>/testing-guides/automated-performance-testing/) as part of their development and release cycle.
68
72
69
73
-**Chaos and resilience testing**
70
74
71
75
You can use k6 to simulate traffic as part of your chaos experiments, trigger them from your k6 tests or inject different types of faults in Kubernetes with [xk6-disruptor](https://grafana.com/docs/k6/<K6_VERSION>/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor).
72
76
73
-
-**Performance and synthetic monitoring**
77
+
-**Infrastructure testing**
74
78
75
-
With k6, you can automate and schedule to trigger tests very frequently with a small load to continuously validate the performance and availability of your production environment. You can also use [Grafana Cloud Synthetic Monitoring](https://grafana.com/docs/grafana-cloud/testing/synthetic-monitoring/create-checks/checks/k6/) for a managed solution built specifically for synthetic monitoring that supports k6 test scripts.
79
+
With [k6 extensions](https://grafana.com/docs/k6/<K6_VERSION>/extensions/), you can add support to k6 for new protocols or use a particular client to directly test individual systems within your infrastructure.
76
80
77
-
## Load Testing Manifesto
78
-
79
-
Our load testing manifesto is the result of having spent years hip deep in the trenches, doing performance- and load testing.
80
-
We’ve created it to be used as guidance, helping you in getting your performance testing on the right track!
81
-
82
-
-[Simple testing is better than no testing](https://k6.io/our-beliefs/#simple-testing-is-better-than-no-testing)
83
-
-[Load testing should be goal oriented](https://k6.io/our-beliefs/#load-testing-should-be-goal-oriented)
84
-
-[Load testing by developers](https://k6.io/our-beliefs/#load-testing-by-developers)
85
-
-[Developer experience is super important](https://k6.io/our-beliefs/#developer-experience-is-super-important)
86
-
-[Load test in a pre-production environment](https://k6.io/our-beliefs/#load-test-in-a-pre-production-environment)
87
-
88
-
## What k6 does not
89
-
90
-
k6 is a high-performing load testing tool, scriptable in JavaScript. The architectural design to have these capabilities brings some trade-offs:
91
-
92
-
-**Does not run natively in a browser**
93
-
94
-
By default, k6 does not render web pages the same way a browser does.
95
-
Browsers can consume significant system resources.
96
-
Skipping the browser allows running more load within a single machine.
97
-
98
-
However, with [k6 browser](https://grafana.com/docs/k6/<K6_VERSION>/using-k6-browser), you can interact with real browsers and collect frontend metrics as part of your k6 tests.
81
+
Watch the video below to learn more about k6 and why it could be the missing puzzle in your Grafana stack.
99
82
100
-
-**Does not run in NodeJS**
83
+
{{< youtube id="1mtYVDA2_iQ" >}}
101
84
102
-
JavaScript is not generally well suited for high performance.
103
-
To achieve maximum performance, the tool itself is written in Go, embedding a JavaScript runtime allowing for easy test scripting.
85
+
## Explore
104
86
105
-
If you want to import npm modules or libraries using NodeJS APIs, you can [bundle npm modules with webpack](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/modules#bundling-node-modules) and import them in your tests.
Copy file name to clipboardExpand all lines: docs/sources/v0.52.x/_index.md
+56-74Lines changed: 56 additions & 74 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,103 +3,85 @@ aliases:
3
3
- /docs/k6/
4
4
description: 'The k6 documentation covers everything you need to know about k6 OSS, load testing, and performance testing.'
5
5
menuTitle: Grafana k6
6
-
title: Grafana k6 documentation
6
+
title: Grafana k6
7
7
weight: -10
8
+
hero:
9
+
title: Grafana k6
10
+
level: 1
11
+
image: /media/docs/k6/GrafanaLogo_k6_icon.svg
12
+
width: 100
13
+
height: 100
14
+
description: Grafana k6 is an open-source, developer-friendly, and extensible load testing tool. k6 allows you to prevent performance issues and proactively improve reliability.
15
+
cards:
16
+
title_class: pt-0 lh-1
17
+
items:
18
+
- title: Run your first k6 test
19
+
href: ./get-started/
20
+
description: Learn how to install the k6 CLI, run your first k6 test, and view metric results in the terminal.
21
+
height: 24
22
+
- title: Using k6
23
+
href: ./using-k6/
24
+
description: Learn about k6 options and concepts such as thresholds, metrics, lifecycle hooks, and more.
25
+
height: 24
26
+
- title: Testing guides
27
+
href: ./testing-guides/
28
+
description: Discover how to plan and define your performance testing strategy with these guides.
29
+
height: 24
30
+
- title: k6 JavaScript API
31
+
href: ./javascript-api/
32
+
description: Explore the k6 APIs through their documentation and examples.
33
+
height: 24
34
+
- title: Explore k6 extensions
35
+
href: ./extensions/
36
+
description: Have a particular testing need? Find k6 extensions that extend the native k6 functionality.
37
+
height: 24
38
+
- title: k6 script examples
39
+
href: ./extensions/
40
+
description: Learn how to script your tests with this list of common k6 examples.
41
+
height: 24
8
42
---
9
43
10
-
# Grafana k6 documentation
44
+
{{< docs/hero-simple key="hero" >}}
11
45
12
-
This documentation will help you go from a total beginner to a seasoned k6 expert!
<p>Learn how to leverage the results output to gain actionable insight about your application's performance.</p>
28
-
</a>
29
-
</div>
30
-
31
-
## What is k6?
32
-
33
-
Grafana k6 is an open-source load testing tool that makes performance testing easy and productive for engineering teams.
34
-
k6 is free, developer-centric, and extensible.
35
-
36
-
Using k6, you can test the reliability and performance of your systems and catch performance regressions and problems earlier.
37
-
k6 will help you to build resilient and performant applications that scale.
46
+
---
38
47
39
-
k6 is developed by [Grafana Labs](https://grafana.com/) and the community.
48
+
## Overview
40
49
41
-
Watch the video below to learn more about k6 and why it could be the missing puzzle in your Grafana stack.
50
+
Using k6, you can test the reliability and performance of your application and infrastructure.
42
51
43
-
{{< youtube id="1mtYVDA2_iQ" >}}
52
+
k6 helps engineering teams prevent errors and SLO breaches, enabling them to build resilient and high-performing applications that scale.
44
53
45
-
## Key features
54
+
Engineering teams, including Developers, QA Engineers, SDETs, and SREs, commonly use k6 for:
46
55
47
-
k6 is packed with features, which you can learn all about in the documentation.
48
-
Key features include:
56
+
-**Load and performance testing**
49
57
50
-
-[CLI tool](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/k6-options/how-to) with developer-friendly APIs.
51
-
- Scripting in JavaScript ES2015/ES6 - with support for [local and remote modules](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/modules)
52
-
-[Checks](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/checks) and [Thresholds](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/thresholds) - for goal-oriented, automation-friendly load testing
58
+
k6 is optimized for minimal resource consumption and designed for running high-load performance tests such as
59
+
[spike](https://grafana.com/docs/k6/<K6_VERSION>/testing-guides/test-types/spike-testing), [stress](https://grafana.com/docs/k6/<K6_VERSION>/testing-guides/test-types/stress-testing), or [soak tests](https://grafana.com/docs/k6/<K6_VERSION>/testing-guides/test-types/soak-testing).
53
60
54
-
## Use cases
61
+
-**Browser performance testing**
55
62
56
-
k6 users are typically Developers, QA Engineers, SDETs, and SREs.
57
-
They use k6 for testing the performance and reliability of APIs, microservices, and websites.
58
-
Common k6 use cases are:
63
+
Through the [k6 browser API](https://grafana.com/docs/k6/<K6_VERSION>/using-k6-browser), you can run browser-based performance tests and collect browser metrics to identify performance issues related to browsers. Additionally, you can mix browser tests with other performance tests to get a comprehensive view of your website's performance.
59
64
60
-
-**Load testing**
65
+
-**Performance and synthetic monitoring**
61
66
62
-
k6 is optimized for minimal resource consumption and designed for running high load tests
You can schedule tests to run with minimal load very frequently, continuously validating the performance and availability of your production environment. For this, you can also use [Grafana Cloud Synthetic Monitoring](https://grafana.com/docs/grafana-cloud/testing/synthetic-monitoring/create-checks/checks/k6/), which supports running k6 scripts.
64
68
65
-
-**Browser testing**
69
+
-**Automation of performance tests**
66
70
67
-
Through [k6 browser](https://grafana.com/docs/k6/<K6_VERSION>/using-k6-browser), you can run browser-based performance testing and catch issues related to browsers only which can be skipped entirely from the protocol level.
71
+
k6 integrates seamlessly with CI/CD and automation tools, enabling engineering teams to [automate performance testing](https://grafana.com/docs/k6/<K6_VERSION>/testing-guides/automated-performance-testing/) as part of their development and release cycle.
68
72
69
73
-**Chaos and resilience testing**
70
74
71
75
You can use k6 to simulate traffic as part of your chaos experiments, trigger them from your k6 tests or inject different types of faults in Kubernetes with [xk6-disruptor](https://grafana.com/docs/k6/<K6_VERSION>/testing-guides/injecting-faults-with-xk6-disruptor/xk6-disruptor).
72
76
73
-
-**Performance and synthetic monitoring**
77
+
-**Infrastructure testing**
74
78
75
-
With k6, you can automate and schedule to trigger tests very frequently with a small load to continuously validate the performance and availability of your production environment. You can also use [Grafana Cloud Synthetic Monitoring](https://grafana.com/docs/grafana-cloud/testing/synthetic-monitoring/create-checks/checks/k6/) for a managed solution built specifically for synthetic monitoring that supports k6 test scripts.
79
+
With [k6 extensions](https://grafana.com/docs/k6/<K6_VERSION>/extensions/), you can add support to k6 for new protocols or use a particular client to directly test individual systems within your infrastructure.
76
80
77
-
## Load Testing Manifesto
78
-
79
-
Our load testing manifesto is the result of having spent years hip deep in the trenches, doing performance- and load testing.
80
-
We’ve created it to be used as guidance, helping you in getting your performance testing on the right track!
81
-
82
-
-[Simple testing is better than no testing](https://k6.io/our-beliefs/#simple-testing-is-better-than-no-testing)
83
-
-[Load testing should be goal oriented](https://k6.io/our-beliefs/#load-testing-should-be-goal-oriented)
84
-
-[Load testing by developers](https://k6.io/our-beliefs/#load-testing-by-developers)
85
-
-[Developer experience is super important](https://k6.io/our-beliefs/#developer-experience-is-super-important)
86
-
-[Load test in a pre-production environment](https://k6.io/our-beliefs/#load-test-in-a-pre-production-environment)
87
-
88
-
## What k6 does not
89
-
90
-
k6 is a high-performing load testing tool, scriptable in JavaScript. The architectural design to have these capabilities brings some trade-offs:
91
-
92
-
-**Does not run natively in a browser**
93
-
94
-
By default, k6 does not render web pages the same way a browser does.
95
-
Browsers can consume significant system resources.
96
-
Skipping the browser allows running more load within a single machine.
97
-
98
-
However, with [k6 browser](https://grafana.com/docs/k6/<K6_VERSION>/using-k6-browser), you can interact with real browsers and collect frontend metrics as part of your k6 tests.
81
+
Watch the video below to learn more about k6 and why it could be the missing puzzle in your Grafana stack.
99
82
100
-
-**Does not run in NodeJS**
83
+
{{< youtube id="1mtYVDA2_iQ" >}}
101
84
102
-
JavaScript is not generally well suited for high performance.
103
-
To achieve maximum performance, the tool itself is written in Go, embedding a JavaScript runtime allowing for easy test scripting.
85
+
## Explore
104
86
105
-
If you want to import npm modules or libraries using NodeJS APIs, you can [bundle npm modules with webpack](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/modules#bundling-node-modules) and import them in your tests.
0 commit comments