Add k6 studio autocorrelation docs #2169
Conversation
e-fisher
requested review from
allansson and
going-confetti
and removed request for
a team
|
|
|
|
going-confetti
left a comment
going-confetti
left a comment
There was a problem hiding this comment.
Looks good. I left a few non-blocking questions
|
|
||
| {{< admonition type="note" >}} | ||
|
|
||
| Your API key is encrypted using your operating system's secure storage and is not transmitted to Grafana Labs. Data from your recording is sent to OpenAI for processing. Usage is subject to your OpenAI agreement and associated billing. |
There was a problem hiding this comment.
Suggestion: it's already implied, but I would mention that it's stored locally. Maybe something like "Your API key is encrypted and stored locally in your operating system's secure storage".
|
|
||
| ### Considerations | ||
|
|
||
| - **Feature preview.** Autocorrelation is in public preview. Functionality may change in future releases. |
There was a problem hiding this comment.
Might be worth linking to https://grafana.com/docs/release-life-cycle/#public-preview so it's clearer what "public preview" means.
|
|
||
| For performance testing, it's common to not include static assets, or remove hosts from 3rd-party services from your tests, but you can include them depending on your use case. | ||
|
|
||
| ## Autocorrelation |
There was a problem hiding this comment.
I noticed that correlation rules are mentioned a few times here, before the user even learns what a test rule is. Is this intentional?
There was a problem hiding this comment.
Yes, I was debating the right place for this and went with the idea to introduce the automatic process first and continue into manual rule management if the user needs more customization.
3 participants
What?
This PR adds documentation for the new Autocorrelation feature in k6 Studio, an AI-powered capability that automatically creates correlation rules for test scripts.
Autocorrelationsection inComponents -> GeneratorAIsection.Checklist
npm startcommand locally and verified that the changes look good.docs/sources/k6/nextfolder of the documentation.docs/sources/k6/v{most_recent_release}folder of the documentation.docs/sources/k6/nextfolder of the documentation.Related PR(s)/Issue(s)