Skip to content

[docs] Update k6 Studio usage collection section #1967

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

going-confetti
Copy link
Contributor

@going-confetti going-confetti commented Jun 25, 2025

What?

Update the k6 studio usage stats doc to describe the (upcoming) changes to usage collection:

  • We'll start tracking more events (currently, only the initial start/installation is tracked)

Checklist

  • I have used a meaningful title for the PR.
  • I have described the changes I've made in the "What?" section above.
  • I have performed a self-review of my changes.
  • I have run the npm start command locally and verified that the changes look good.
  • I have made my changes in the docs/sources/k6/next folder of the documentation.
  • I have reflected my changes in the docs/sources/k6/v{most_recent_release} folder of the documentation.
  • I have reflected my changes in the relevant folders of the two previous k6 versions of the documentation (if still applicable to previous versions).
  • I have made my changes in the docs/sources/k6/next folder of the documentation.

Related PR(s)/Issue(s)

grafana/k6-studio#771

@CLAassistant
Copy link

CLAassistant commented Jun 30, 2025

CLA assistant check
All committers have signed the CLA.


- The running program's operating system (`mac` or `win`).
- The event name (for example, `app_installed` or `recording_created`).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Should I list all events somewhere in this doc?

On the one hand, it's nice to have some transparency, on the other it may make it harder to maintain.

In the next iteration, we want to start including some additional information related to an event (e.g. number of rules of each type in a saved generator), so this would also need to be listed.

Copy link
Contributor

Choose a reason for hiding this comment

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

yap we want full transparency on this so we should list the events we send and keep it updated when we make changes to them 🤔

Copy link
Collaborator

Choose a reason for hiding this comment

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

How many events are there? Could we keep it as a sub-list here? 🤔

@going-confetti going-confetti marked this pull request as ready for review July 23, 2025 08:52
@going-confetti going-confetti requested review from heitortsergent and a team as code owners July 23, 2025 08:52
@going-confetti going-confetti requested review from allansson and Llandy3d and removed request for a team July 23, 2025 08:52
@heitortsergent heitortsergent added the Area:k6-studio k6 Studio label Jul 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants