Skip to content

docs: document extension usage collection - #2286

Merged
inancgumus merged 2 commits into
mainfrom
add/extension-usage-report
Aug 4, 2026
Merged

inancgumus merged 2 commits into
mainfrom
add/extension-usage-report

Conversation

@inancgumus

@inancgumus inancgumus commented Jul 30, 2026 •

Copy link
Copy Markdown
Contributor

What?

Updates the docs for extension telemetry collection.

Why?

k6 now reports which public-catalog extensions a run uses (grafana/k6#6126).

Related PR(s)/Issue(s)

@github-actions

github-actions Bot commented Jul 30, 2026 •

Copy link
Copy Markdown
Contributor

πŸ’» Deploy preview deleted (docs: document extension usage collection).

@inancgumus
inancgumus requested a review from ankur22 July 30, 2026 14:42
@inancgumus
inancgumus marked this pull request as ready for review July 30, 2026 14:42
@inancgumus
inancgumus requested review from a team and heitortsergent as code owners July 30, 2026 14:42
@inancgumus
inancgumus requested review from janHildebrandt98 and removed request for a team July 30, 2026 14:42
heitortsergent
heitortsergent previously approved these changes Jul 31, 2026
- Whether `global` was accessed.

> Only k6 built-in JavaScript modules and outputs are considered. Private modules and custom extensions are excluded.
> The module and output lists contain only k6 built-in names. An extension is reported only if it's listed in the public [k6 extension catalog](https://grafana.com/docs/k6/<K6_VERSION>/extensions/explore/). Private and unlisted extensions are never reported.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
> The module and output lists contain only k6 built-in names. An extension is reported only if it's listed in the public [k6 extension catalog](https://grafana.com/docs/k6/<K6_VERSION>/extensions/explore/). Private and unlisted extensions are never reported.
{{< admonition type="note" >}}
The module and output lists contain only k6 built-in names. An extension is reported only if it's listed in the public [k6 extension catalog](https://grafana.com/docs/k6/<K6_VERSION>/extensions/explore/). Private and unlisted extensions are never reported.
{{< /admonition >}}

Just a nit to switch this to an admonition for consistency. :)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Sure :) I need a re-approval please πŸ™

@heitortsergent heitortsergent self-assigned this Jul 31, 2026
@heitortsergent heitortsergent added the Area: OSS Content Improvements or additions to community/oss documentation label Jul 31, 2026
inancgumus and others added 2 commits July 31, 2026 19:47
The usage report now lists used extensions from the public extension
catalog, and extension subcommands send a report of their own. Updates
the usage collection page with the extensions entry, the catalog-only
scope, the k6 x report, and which opt-outs cover it.

Related: grafana/k6#6126
Related: grafana/k6#6229
Co-authored-by: Heitor Tashiro Sergent <heitortsergent@gmail.com>
@inancgumus
inancgumus force-pushed the add/extension-usage-report branch from 5ac2368 to 2acc002 Compare July 31, 2026 23:47
@inancgumus
inancgumus merged commit 559aaf0 into main Aug 4, 2026
19 checks passed
@inancgumus
inancgumus deleted the add/extension-usage-report branch August 4, 2026 13:08
@inancgumus inancgumus mentioned this pull request Aug 6, 2026
1 of 7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: OSS Content Improvements or additions to community/oss documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants