Skip to content

Commit e5c082a

Browse files
[docs] Update k6 Studio usage collection docs (#2044)
1 parent 7c19fc6 commit e5c082a

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

docs/sources/k6-studio/set-up/usage-collection.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,26 @@ By default, k6 Studio sends anonymous usage reports, as well as crash reports an
1010

1111
A usage report includes the following information:
1212

13-
- The event name:
14-
- `app_installed`: when k6 Studio is installed and opened for the first time.
15-
- `user_logged_in`: when a user logs in to Grafana Cloud.
16-
- `recording_created`: when a new recording is created.
17-
- `recording_imported`: when a recording is imported.
18-
- `generator_created`: when a new generator is created.
19-
- `generator_updated`: when a generator is updated.
20-
- `script_exported`: when a script is exported.
21-
- `script_validated`: when a script is validated.
22-
- `script_run_in_cloud`: when a script is run in the cloud.
13+
- The event name. Refer to the table below for a list of event names and details.
14+
- The event payload - additional information about the event. Every event includes the boolean property `isLoggedIn`.
2315
- The running program's operating system (`win`, `mac`, or `linux`).
2416
- The running program's architecture (`arm64` or `x86_64`).
25-
- The k6 Studio version (for example, `1.5.0`).
17+
- The k6 Studio version (for example, `1.7.0`).
2618
- The timestamp of when the data was collected (for example, `2024-10-22T16:02:56.261Z`).
2719

20+
| Event name | Description | Event payload |
21+
| --------------------- | ---------------------------------------------------- | ----------------------------------------------------------------------------------- |
22+
| `app_installed` | k6 Studio is installed and opened for the first time | |
23+
| `user_logged_in` | The user logs in to Grafana Cloud | |
24+
| `recording_created` | A new recording is created | |
25+
| `recording_imported` | A recording is imported | |
26+
| `generator_created` | A new generator is created | |
27+
| `generator_updated` | An existing generator is updated | The total number of test rules per rule type and the total number of disabled rules |
28+
| `script_copied` | A script is copied into the clipboard | |
29+
| `script_exported` | A script is exported | |
30+
| `script_validated` | A script is validated | |
31+
| `script_run_in_cloud` | A script is run in the cloud | |
32+
2833
We use [Sentry](https://sentry.io/) to collect crash reports and error data. That includes:
2934

3035
- The running program's operating system name, version, kernel version, and build (for example, macOS or Windows).

0 commit comments

Comments
 (0)