[docs] Update k6 Studio usage collection docs #2044
Conversation
| | Event name | Description | Additional event properties | Version introduced | | ||
| | -------------------- | ----------------------------------------------------- |---------------------------------- | ------------------ | | ||
| | `app_installed` | k6 Studio is installed and opened for the first time | | 1.6.0 | | ||
| | `user_logged_in` | The user logs in to Grafana Cloud | | 1.6.0 | | ||
| | `recording_created` | A new recording is created | | 1.6.0 | | ||
| | `recording_imported` | A recording is imported | | 1.6.0 | | ||
| | `generator_created` | A new generator is created | | 1.6.0 | | ||
| | `generator_updated` | An existing generator is updated | `rules` - object containing the total number of test rules per rule type and the total number of disabled rules | 1.6.0 | | ||
| | `script_copied` | A script is copied into the clipboard | | 1.7.0 | | ||
| | `script_exported` | A script is exported | | 1.6.0 | | ||
| | `script_validated` | A script is validated | | 1.6.0 | | ||
| | `script_run_in_cloud`| A script is run in the cloud | | 1.6.0 | |
There was a problem hiding this comment.
@heitortsergent - do you have any suggestions on how we can present this in a better way?
I believe listing every event in the list above will eventually becomes unsustainable (especially if we were to include the event properties), so I moved the detailed event info into a table. I'm not quite sure about the Additional event properties column:
- Does this format work or is there a better alternative?
- in the case of
generator_updated– is this level of detail enough or should I be more explicit by describing the internal structure of therulesobject`?
There was a problem hiding this comment.
I think the table works well @going-confetti.
One suggestion here is, since only the generator_updated has information in the "Additional event properties" column, I think you could also remove the column and just update the description for generator_updated to something like:
"An existing generator is updated. It also includes a rules object that contains the total number of test rules per rule type and the total number of disabled rules".
Another alternative would be adding an extra row to the table for generator_updated.rules to have a dedicated row for the rules object.
What do you think?
There was a problem hiding this comment.
since only the generator_updated has information in the "Additional event properties" column
This will likely change soon - one of the changes we're considering is tracking whether the script is a browser- or a protocol-level script in all script-related events.
After some thought, I decided to:
-
Remove the
Version introducedcolumn as it's not very useful IMO (plus, the docs are only for the latest version of k6 Studio) -
Describe the additional "event properties" in plain text without mentioning of property names:
Replace this:
rules- object containing the total number of test rules per rule type and the total number of disabled ruleswith this:
The total number of test rules per rule type and the total number of disabled rules
Would these changes make sense?
There was a problem hiding this comment.
Yeah, that makes sense. 👍
Co-authored-by: Heitor Tashiro Sergent <[email protected]>
Co-authored-by: Heitor Tashiro Sergent <[email protected]>
What?
script_copiedevent and the newisLoggedInevent propertyChecklist
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)