-
Notifications
You must be signed in to change notification settings - Fork 216
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.
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
Add K6_BROWSER_TRACES_METADATA docs #1455
Conversation
Adds documentation for the traces metadata env variable, which allows setting extra metadata attributes for the spans generated from the browser module.
| 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see some other changes were applied automatically when committing, but this is the main change.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I made a small suggestion to the description, but LGTM! 🙇
docs/sources/next/javascript-api/k6-experimental/browser/_index.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Heitor Tashiro Sergent <heitortsergent@gmail.com>
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 docs
command locally and verified that the changes look good.If updating the documentation for the next release of k6:
docs/sources/next
folder of the documentation.Related PR(s)/Issue(s)
grafana/xk6-browser#1104