Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Introducing options.cloud #1525

Merged
merged 1 commit into from Mar 20, 2024
Merged

Introducing options.cloud #1525

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/sources/next/using-k6/k6-options/reference.md
View file
Open in desktop
Expand Up @@ -30,7 +30,7 @@ Each option has its own detailed reference in a separate section.
| [Duration](#duration) | A string specifying the total duration of the test run; together with the [vus option](#vus), it's a shortcut for a single [scenario](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/scenarios) with a [constant VUs executor](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/scenarios/executors/constant-vus) |
| [Execution segment](#execution-segment) | Limit execution to a segment of the total test |
| [Exit on running](#exit-on-running) | Exits when test reaches the running status |
| [Extension options](#extension-options) | An object used to set configuration options for cloud parameters and third-party collectors |
| [Cloud options](#cloud-options) | An object used to set configuration options for cloud parameters. |
| [Hosts](#hosts) | An object with overrides to DNS resolution |
| [HTTP debug](#http-debug) | Log all HTTP requests and responses |
| [Include system Env vars](#include-system-env-vars) | Pass the real system environment variables to the runtime |
Expand Down Expand Up @@ -352,13 +352,13 @@ export const options = {

{{< /code >}}

## Extension options
## Cloud options

An object used to set configuration options for cloud parameters and third-party collectors, like plugins. For more information about available parameters, refer to [Cloud options](https://grafana.com/docs/grafana-cloud/k6/author-run/cloud-scripting-extras/cloud-options/).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@olegbespalov, I saw you removed "third-party collectors" from the table above. Do we want to remove it from here as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, it makes sense to remove this from here, good catch 👍 I'll open a PR


| Env | CLI | Code / Config file | Default |
| --- | --- | ------------------ | ------- |
| N/A | N/A | `ext` | `null` |
| N/A | N/A | `cloud` | `null` |

This is an example of how to specify the test name (test runs/executions with the same name will be
logically grouped for trending and comparison) when streaming results to
Expand All @@ -368,14 +368,14 @@ logically grouped for trending and comparison) when streaming results to

```javascript
export const options = {
ext: {
loadimpact: {
name: 'My test name',
},
cloud: {
name: 'My test name',
},
};
```

Previously, the `cloud` object was known as `ext.loadimpact`.

{{< /code >}}

## Execution segment
Expand Down