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/k6/next/extensions/create/extensions-registry.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
title: About the Extensions Registry
3
3
description: Reasons for the registry and what is required to be included.
4
-
weight: 01
4
+
weight: 600
5
5
---
6
6
7
7
# About the Extensions Registry
@@ -18,7 +18,7 @@ To ensure quality, we need a well-maintained, curated listing of extensions.
18
18
Our pledge to the community is to make our best attempt to ensure the listed projects meet certain standards.
19
19
While we cannot guarantee the quality of community-provided extensions, we _can_ aid the evaluation by requiring certain consistencies.
20
20
21
-
## Registry Requirements
21
+
## Registry requirements
22
22
23
23
At minimum, each source code repository must have the following:
24
24
@@ -55,7 +55,7 @@ At minimum, each source code repository must have the following:
55
55
For example, if latest version of k6 is `v0.100`, the extension must build with at least version `v0.98`.
56
56
Be sure to also match the version of Go as determined by the version of k6.
57
57
58
-
## Naming Conventions
58
+
## Naming conventions
59
59
60
60
Some extensions may be very specific, where others are more general.
61
61
Multiple extensions may even be created for the same product with different levels of support based upon version.
@@ -76,7 +76,7 @@ Our goal is to quickly understand the intent of the extension.
76
76
77
77
{{< /admonition >}}
78
78
79
-
## Potential for De-listing
79
+
## Potential for de-listing
80
80
81
81
Given our desire to provide the best developer experience when using k6, we reserve the right to de-list any extension we deem is no longer maintaining standards.
82
82
Before any action takes place, the extension maintainers will be contacted to be given a chance to rectify the project and thus avoid de-listing.
\**Partial* means that they can be used in the CLI with the `--local-execution` mode. Also, on Private Load Zones if a custom image is build. They don't work on Grafana Cloud k6 Public Load Zones.
21
+
\*_Partial_ means that they can be used in the CLI with the `--local-execution` mode. Also, on Private Load Zones if a custom image is build. They don't work on Grafana Cloud k6 Public Load Zones.
22
22
23
23
### Official extensions
24
24
25
-
| Extension | Description | Versions |
26
-
| --------- | ----------- | -------- |
27
-
|[xk6-client-prometheus-remote](https://github.com/grafana/xk6-client-prometheus-remote)| Test Prometheus Remote Write-compatible endpoints | 0.3.2 |
28
-
|[xk6-faker](https://github.com/grafana/xk6-faker)| Generate fake data in your tests | 0.4.0, 0.4.1, 0.4.2, 0.4.3, 0.4.4 |
Copy file name to clipboardExpand all lines: docs/sources/k6/next/extensions/run/_index.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,13 @@
1
1
---
2
2
title: 'Run a test with extensions'
3
3
menuTitle: 'Run a test with extensions'
4
-
description: 'Run k6 with extensions to cover use cases not supported natively in the core.'
4
+
description: 'Learn how to run a k6 test with extensions.'
5
5
weight: 03
6
6
---
7
7
8
8
# Run a test with extensions
9
9
10
-
As explained in the [Explore extensions](https://grafana.com/docs/k6/<K6_VERSION>/extensions/explore) page, there are extensions that can be used directly in your test script, and others that require building a custom k6 binary.
10
+
As explained in the [Explore extensions](https://grafana.com/docs/k6/<K6_VERSION>/extensions/explore) page, there are extensions that can be used directly in your test script, and others that require building a custom k6 binary.
11
11
12
12
## Using automatic extension resolution
13
13
@@ -31,7 +31,6 @@ k6 run script.js
31
31
32
32
To use community extensions you must have `K6_ENABLE_COMMUNITY_EXTENSIONS` set to `true`.
33
33
34
-
35
34
```sh
36
35
K6_ENABLE_COMMUNITY_EXTENSIONS=true k6 run test.js
37
36
```
@@ -43,19 +42,20 @@ K6_ENABLE_COMMUNITY_EXTENSIONS=true k6 run test.js
43
42
- Only works with Official and Community extensions.
44
43
- Output extensions are not supported.
45
44
- Running scripts from stdin is not supported.
46
-
- Only files with extensions `.js`, `.ts` or `.tar` can be used.
45
+
- Only files with extensions `.js`, `.ts` or `.tar` can be used.
47
46
48
47
### How to disable this feature
49
48
50
49
You can disable this feature by setting the environment variable `K6_AUTO_EXTENSION_RESOLUTION` to `false`. If provided, the previous example
51
-
fails because k6 can't load the extension dynamically.
50
+
fails because k6 can't load the extension dynamically.
51
+
52
52
```bash
53
53
K6_AUTO_EXTENSION_RESOLUTION=false k6 run test.js
54
54
```
55
55
56
56
## Using extensions that require building a custom k6 binary
57
57
58
-
To run other extensions (including ones you create), you need to build a custom k6 binary with [xk6](https://github.com/grafana/xk6/).
58
+
To run other extensions (including ones you create), you need to build a custom k6 binary with [xk6](https://github.com/grafana/xk6/).
59
59
60
60
You can do this locally with [Go](https://grafana.com/docs/k6/<K6_VERSION>/extensions/run/build-k6-binary-using-go/) or use the [xk6 Docker image](https://grafana.com/docs/k6/<K6_VERSION>/extensions/run/build-k6-binary-using-docker/).
0 commit comments