Add K6_BROWSER_TRACES_METADATA docs #1455
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds documentation for the traces metadata env variable, which allows setting extra metadata attributes for the spans generated from the browser module.
ka3de
commented
Dec 18, 2023
| | K6_BROWSER_HEADLESS | Show browser GUI or not. `true` by default. | | ||
| | K6_BROWSER_IGNORE_DEFAULT_ARGS | Ignore any of the [default arguments](#default-arguments) included when launching a browser process. | | ||
| | K6_BROWSER_TIMEOUT | Default timeout to use for various actions and navigation. `'30s'` if not set. | | ||
| | K6_BROWSER_TRACES_METADATA | Sets additional _key-value_ metadata that will be included as attributes in every span generated from browser module traces. Example: `K6_BROWSER_TRACES_METADATA=attr1=val1,attr2=val2`. This will only apply if traces generation is enabled by k6 options, see `--traces-output` option [docs](https://grafana.com/docs/k6/<K6_VERSION>/using-k6/k6-options/reference#traces-output). | |
There was a problem hiding this comment.
I see some other changes were applied automatically when committing, but this is the main change.
heitortsergent
approved these changes
Dec 18, 2023
docs/sources/next/javascript-api/k6-experimental/browser/_index.md
Outdated
Show resolved
Hide resolved
inancgumus
approved these changes
Dec 19, 2023
Co-authored-by: Heitor Tashiro Sergent <heitortsergent@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
Adds documentation for the traces metadata env variable, which allows setting extra metadata attributes for the spans generated from the browser module.
Checklist
Please fill in this template:
make docscommand locally and verified that the changes look good.If updating the documentation for the next release of k6:
docs/sources/nextfolder of the documentation.Related PR(s)/Issue(s)
grafana/xk6-browser#1104